ARKit · IOS API REFERENCE

ARReferenceImage

class · iOS 11.3+ · SDK 27.1

class ARReferenceImage

Members (8)

static · iOS 11.3+

referenceImages

TypeScript

static referenceImages(name: string, bundle?: (_Foundation_Bundle) | null): (Array<ARReferenceImage>) | null

Swift declaration

class func referenceImages(inGroupNamed name: String, bundle: Bundle?) -> Set<ARReferenceImage>?

init · iOS 11.3+

init

TypeScript

static initOrientationPhysicalWidth(image: _CoreGraphics_CGImage, orientation: _ImageIO_CGImagePropertyOrientation, physicalWidth: number): ARReferenceImage

Swift declaration

init(_ image: CGImage, orientation: CGImagePropertyOrientation, physicalWidth: CGFloat)

init · iOS 11.3+

init

TypeScript

static initOrientationPhysicalWidth40754(pixelBuffer: _CoreVideo_CVBuffer, orientation: _ImageIO_CGImagePropertyOrientation, physicalWidth: number): ARReferenceImage

Swift declaration

init(_ pixelBuffer: CVPixelBuffer, orientation: CGImagePropertyOrientation, physicalWidth: CGFloat)

method · iOS 13.0+

validate

TypeScript

validate(completionHandler: ((arg0: (NativeError) | null) => void)): void

Swift declaration

func validate() async throws

get · iOS 11.3+

name

TypeScript

get name(): (string) | null

Swift declaration

var name: String? { get set }

set · iOS 11.3+

name

TypeScript

set name(value: (string) | null)

Swift declaration

var name: String? { get set }

get · iOS 11.3+

physicalSize

TypeScript

get physicalSize(): { width: number; height: number }

Swift declaration

var physicalSize: CGSize { get }

get · iOS 13.0+

resourceGroupName

TypeScript

get resourceGroupName(): (string) | null

Swift declaration

var resourceGroupName: String? { get }

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

ARReferenceImage.init()

inherited init: cannot prove legal (class declares 4 custom initializers)

All ARKit types →