ARKit · IOS API REFERENCE

ARFrame

class · iOS 11.0+ · SDK 27.1

class ARFrame

Members (23)

method · iOS 11.0+ · Deprecated in iOS 27.0

displayTransform

TypeScript

displayTransformForViewportSize(orientation: _UIKit_UIInterfaceOrientation, viewportSize: { width: number; height: number }): _CoreFoundation_CGAffineTransform

Swift declaration

func displayTransform(for orientation: UIInterfaceOrientation, viewportSize: CGSize) -> CGAffineTransform

method · iOS 27.0+

displayTransform

TypeScript

displayTransformViewRotationAngleViewportSize(viewRotationAngle: number, viewportSize: { width: number; height: number }): _CoreFoundation_CGAffineTransform

Swift declaration

func displayTransform(viewRotationAngle: CGFloat, viewportSize: CGSize) -> CGAffineTransform

method · iOS 11.0+ · Deprecated in iOS 14.0

hitTest

TypeScript

hitTest(point: { x: number; y: number }, types: ARHitTestResult_ResultType): Array<ARHitTestResult>

Swift declaration

func hitTest(_ point: CGPoint, types: ARHitTestResult.ResultType) -> [ARHitTestResult]

method · iOS 13.0+

raycastQuery

TypeScript

raycastQuery(point: { x: number; y: number }, target: ARRaycastQuery_Target, alignment: ARRaycastQuery_TargetAlignment): ARRaycastQuery

Swift declaration

func raycastQuery(from point: CGPoint, allowing target: ARRaycastQuery.Target, alignment: ARRaycastQuery.TargetAlignment) -> ARRaycastQuery

get · iOS 11.0+

anchors

TypeScript

get anchors(): Array<ARAnchor>

Swift declaration

var anchors: [ARAnchor] { get }

get · iOS 11.0+

camera

TypeScript

get camera(): ARCamera

Swift declaration

@NSCopying var camera: ARCamera { get }

get · iOS 13.0+

cameraGrainIntensity

TypeScript

get cameraGrainIntensity(): number

Swift declaration

var cameraGrainIntensity: Float { get }

get · iOS 13.0+

cameraGrainTexture

TypeScript

get cameraGrainTexture(): (SDKHandle) | null

Swift declaration

var cameraGrainTexture: (any MTLTexture)? { get }

get · iOS 11.0+

capturedDepthData

TypeScript

get capturedDepthData(): (_AVFoundation_AVDepthData) | null

Swift declaration

var capturedDepthData: AVDepthData? { get }

get · iOS 11.0+

capturedDepthDataTimestamp

TypeScript

get capturedDepthDataTimestamp(): number

Swift declaration

var capturedDepthDataTimestamp: TimeInterval { get }

get · iOS 11.0+

capturedImage

TypeScript

get capturedImage(): _CoreVideo_CVBuffer

Swift declaration

var capturedImage: CVPixelBuffer { get }

get · iOS 13.0+

detectedBody

TypeScript

get detectedBody(): (ARBody2D) | null

Swift declaration

var detectedBody: ARBody2D? { get }

get · iOS 13.0+

estimatedDepthData

TypeScript

get estimatedDepthData(): (_CoreVideo_CVBuffer) | null

Swift declaration

var estimatedDepthData: CVPixelBuffer? { get }

get · iOS 16.0+

exifData

TypeScript

get exifData(): Record<string, unknown>

Swift declaration

var exifData: [String : Any] { get }

get · iOS 14.0+

geoTrackingStatus

TypeScript

get geoTrackingStatus(): (ARGeoTrackingStatus) | null

Swift declaration

var geoTrackingStatus: ARGeoTrackingStatus? { get }

get · iOS 11.0+

lightEstimate

TypeScript

get lightEstimate(): (ARLightEstimate) | null

Swift declaration

var lightEstimate: ARLightEstimate? { get }

get · iOS 27.0+

metadataObjects

TypeScript

get metadataObjects(): Array<_AVFoundation_AVMetadataObject>

Swift declaration

var metadataObjects: [AVMetadataObject] { get }

get · iOS 11.0+

rawFeaturePoints

TypeScript

get rawFeaturePoints(): (ARPointCloud) | null

Swift declaration

var rawFeaturePoints: ARPointCloud? { get }

get · iOS 14.0+

sceneDepth

TypeScript

get sceneDepth(): (ARDepthData) | null

Swift declaration

var sceneDepth: ARDepthData? { get }

get · iOS 13.0+

segmentationBuffer

TypeScript

get segmentationBuffer(): (_CoreVideo_CVBuffer) | null

Swift declaration

var segmentationBuffer: CVPixelBuffer? { get }

get · iOS 14.0+

smoothedSceneDepth

TypeScript

get smoothedSceneDepth(): (ARDepthData) | null

Swift declaration

var smoothedSceneDepth: ARDepthData? { get }

get · iOS 11.0+

timestamp

TypeScript

get timestamp(): number

Swift declaration

var timestamp: TimeInterval { get }

get · iOS 12.0+

worldMappingStatus

TypeScript

get worldMappingStatus(): ARFrame_WorldMappingStatus

Swift declaration

var worldMappingStatus: ARFrame.WorldMappingStatus { get }

Skipped declarations

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

ARFrame.init()

inherited init: clang: 'init' is unavailable

All ARKit types →