One Logo Pool Ball
ARKit · IOS API REFERENCE

ARCamera

class · iOS 11.0+ · SDK 27.1

class ARCamera

Members (16)

method · iOS 11.0+ · Deprecated in iOS 27.0

projectPoint

TypeScript
projectPointOrientationViewportSize(point: SDKHandle, orientation: _UIKit_UIInterfaceOrientation, viewportSize: { width: number; height: number }): { x: number; y: number }
Swift declaration
func projectPoint(_ point: simd_float3, orientation: UIInterfaceOrientation, viewportSize: CGSize) -> CGPoint
method · iOS 27.0+

projectPoint

TypeScript
projectPointViewRotationAngleViewportSize(point: SDKHandle, viewRotationAngle: number, viewportSize: { width: number; height: number }): { x: number; y: number }
Swift declaration
func projectPoint(_ point: simd_float3, viewRotationAngle: CGFloat, viewportSize: CGSize) -> CGPoint
method · iOS 11.0+ · Deprecated in iOS 27.0

projectionMatrix

TypeScript
projectionMatrixForViewportSizeZNearZFar(orientation: _UIKit_UIInterfaceOrientation, viewportSize: { width: number; height: number }, zNear: number, zFar: number): SDKHandle
Swift declaration
func projectionMatrix(for orientation: UIInterfaceOrientation, viewportSize: CGSize, zNear: CGFloat, zFar: CGFloat) -> simd_float4x4
method · iOS 27.0+

projectionMatrix

TypeScript
projectionMatrixViewRotationAngleViewportSizeZNearZFar(viewRotationAngle: number, viewportSize: { width: number; height: number }, zNear: number, zFar: number): SDKHandle
Swift declaration
func projectionMatrix(viewRotationAngle: CGFloat, viewportSize: CGSize, zNear: CGFloat, zFar: CGFloat) -> simd_float4x4
method · iOS 11.0+ · Deprecated in iOS 27.0

viewMatrix

TypeScript
viewMatrixFor(orientation: _UIKit_UIInterfaceOrientation): SDKHandle
Swift declaration
func viewMatrix(for orientation: UIInterfaceOrientation) -> simd_float4x4
method · iOS 27.0+

viewMatrix

TypeScript
viewMatrixViewRotationAngle(viewRotationAngle: number): SDKHandle
Swift declaration
func viewMatrix(viewRotationAngle: CGFloat) -> simd_float4x4
get · iOS 11.0+

eulerAngles

TypeScript
get eulerAngles(): SDKHandle
Swift declaration
var eulerAngles: simd_float3 { get }
get · iOS 13.0+

exposureDuration

TypeScript
get exposureDuration(): number
Swift declaration
var exposureDuration: TimeInterval { get }
get · iOS 13.0+

exposureOffset

TypeScript
get exposureOffset(): number
Swift declaration
var exposureOffset: Float { get }
get · iOS 11.0+

imageResolution

TypeScript
get imageResolution(): { width: number; height: number }
Swift declaration
var imageResolution: CGSize { get }
get · iOS 11.0+

intrinsics

TypeScript
get intrinsics(): SDKHandle
Swift declaration
var intrinsics: simd_float3x3 { get }
get · iOS 11.0+

projectionMatrix

TypeScript
get projectionMatrix(): SDKHandle
Swift declaration
var projectionMatrix: simd_float4x4 { get }
get · iOS 11.0+

transform

TypeScript
get transform(): SDKHandle
Swift declaration
var transform: simd_float4x4 { get }
get · iOS 11.0+

trackingState

TypeScript
get trackingState(): ARCamera_TrackingState
Swift declaration
var trackingState: ARCamera.TrackingState { get }

The tracking state of the camera.

method · iOS 12.0+ · Deprecated in iOS 27.0

unprojectPoint

TypeScript
unprojectPointOntoPlaneOrientationViewportSize(point: { x: number; y: number }, planeTransform: SDKHandle, orientation: _UIKit_UIInterfaceOrientation, viewportSize: { width: number; height: number }): (SDKHandle) | null
Swift declaration
@nonobjc func unprojectPoint(_ point: CGPoint, ontoPlane planeTransform: simd_float4x4, orientation: UIInterfaceOrientation, viewportSize: CGSize) -> simd_float3?

Unprojects a 2D point in image space onto a 3D plane in world space. - Parameters: - point: The 2D point in the image to unproject. - planeTransform: The 4x4 matrix representing the plane in world space. - orientation: The interface orientation. - viewportSize: The size of the viewport. - Returns: The 3D point in world space, or `nil` if the point cannot be unprojected.

method · iOS 27.0+

unprojectPoint

TypeScript
unprojectPointOntoPlaneViewRotationAngleViewportSize(point: { x: number; y: number }, planeTransform: SDKHandle, viewRotationAngle: number, viewportSize: { width: number; height: number }): (SDKHandle) | null
Swift declaration
@nonobjc func unprojectPoint(_ point: CGPoint, ontoPlane planeTransform: simd_float4x4, viewRotationAngle: CGFloat, viewportSize: CGSize) -> simd_float3?

Unprojects a 2D point in image space onto a 3D plane in world space. - Parameters: - point: The 2D point in the image to unproject. - planeTransform: The 4x4 matrix representing the plane in world space. - viewRotationAngle: The view rotation angle, in degrees. Prefer it over an interface orientation, whose reported value cannot always be relied upon. Obtain it from `ARSession.viewRotationAngle`. - viewportSize: The size of the viewport. - Returns: The 3D point in world space, or `nil` if the point cannot be unprojected.

Skipped declarations

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

ARCamera.init()

inherited init: clang: 'init' is unavailable

All ARKit types →