One Logo Pool Ball
Graphics and Games · IOS API REFERENCE

ARKit

Integrate hardware sensing features to produce augmented reality apps and games.

94 types

509 callable entries

53 skipped

91% entry coverage

Generated from iOS SDK 27.1. Availability is shown on each declaration; permissions and entitlements still apply.

Types

ARAnchor

class · iOS 11.0+

ARAnchorCopying

protocol · iOS 12.0+

ARAppClipCodeAnchor

class · iOS 14.3+

ARAppClipCodeAnchor.URLDecodingState

enum · iOS 14.3+

ARBody2D

class · iOS 13.0+

ARBodyAnchor

class · iOS 13.0+

ARBodyTrackingConfiguration

class · iOS 13.0+

ARCamera

class · iOS 11.0+

ARCamera.TrackingState

enum · iOS 11.0+

ARCamera.TrackingState.Reason

enum · iOS 11.0+

ARCoachingOverlayView

class · iOS 13.0+

ARCoachingOverlayView.Goal

enum · iOS 13.0+

ARCoachingOverlayViewDelegate

protocol · iOS 13.0+

ARConfidenceLevel

enum · iOS 14.0+

ARConfiguration

class · iOS 11.0+

ARConfiguration.FrameSemantics

struct · iOS 13.0+

ARConfiguration.SceneReconstruction

struct · iOS 13.4+

ARConfiguration.VideoFormat

class · iOS 11.3+

ARConfiguration.WorldAlignment

enum · iOS 11.0+

ARDepthData

class · iOS 14.0+

ARDirectionalLightEstimate

class · iOS 11.0+

AREnvironmentProbeAnchor

class · iOS 12.0+

ARError

struct · iOS 11.0+

ARError.Code

enum · iOS 11.0+

ARFaceAnchor

class · iOS 11.0+

ARFaceAnchor.BlendShapeLocation

struct · iOS 11.0+

ARFaceGeometry

class · iOS 11.0+

ARFaceTrackingConfiguration

class · iOS 11.0+

ARFrame

class · iOS 11.0+

ARFrame.SegmentationClass

enum · iOS 13.0+

ARFrame.WorldMappingStatus

enum · iOS 12.0+

ARGeoAnchor

class · iOS 14.0+

ARGeoAnchor.AltitudeSource

enum · iOS 14.0+

ARGeometryElement

class · iOS 13.4+

ARGeometryPrimitiveType

enum · iOS 13.4+

ARGeometrySource

class · iOS 13.4+

ARGeoTrackingConfiguration

class · iOS 14.0+

ARGeoTrackingStatus

class · iOS 14.0+

ARGeoTrackingStatus.Accuracy

enum · iOS 14.0+

ARGeoTrackingStatus.State

enum · iOS 14.0+

ARGeoTrackingStatus.StateReason

enum · iOS 14.0+

ARHitTestResult

class · iOS 11.0+ · Deprecated in iOS 14.0

ARHitTestResult.ResultType

struct · iOS 11.0+ · Deprecated in iOS 14.0

ARImageAnchor

class · iOS 11.3+

ARImageTrackingConfiguration

class · iOS 12.0+

ARLightEstimate

class · iOS 11.0+

ARMatteGenerator

class · iOS 13.0+

ARMatteGenerator.Resolution

enum · iOS 13.0+

ARMeshAnchor

class · iOS 13.4+

ARMeshClassification

enum · iOS 13.4+

ARMeshGeometry

class · iOS 13.4+

ARObjectAnchor

class · iOS 12.0+

ARObjectScanningConfiguration

class

AROrientationTrackingConfiguration

class · iOS 11.0+

ARParticipantAnchor

class · iOS 13.0+

ARPlaneAnchor

class · iOS 11.0+

ARPlaneAnchor.Alignment

enum · iOS 11.0+

ARPlaneAnchor.Classification

enum · iOS 12.0+

ARPlaneAnchor.Classification.Status

enum · iOS 12.0+

ARPlaneExtent

class · iOS 16.0+

ARPlaneGeometry

class · iOS 11.3+

ARPointCloud

class · iOS 11.0+

ARPositionalTrackingConfiguration

class · iOS 13.0+

ARRaycastQuery

class · iOS 13.0+

ARRaycastQuery.Target

enum · iOS 13.0+

ARRaycastQuery.TargetAlignment

enum · iOS 13.0+

ARRaycastResult

class · iOS 13.0+

ARReferenceImage

class · iOS 11.3+

ARReferenceObject

class · iOS 12.0+

ARSCNDebugOptions

typealias · iOS 11.0+

ARSCNFaceGeometry

class · iOS 11.0+

ARSCNPlaneGeometry

class · iOS 11.3+

ARSCNView

class · iOS 11.0+

ARSCNViewDelegate

protocol · iOS 11.0+

ARSession

class · iOS 11.0+

ARSession.CollaborationData

class · iOS 13.0+

ARSession.CollaborationData.Priority

enum · iOS 13.0+

ARSession.RunOptions

struct · iOS 11.0+

ARSessionDelegate

protocol · iOS 11.0+

ARSessionObserver

protocol · iOS 11.0+

ARSessionProviding

protocol

ARSkeleton

class · iOS 13.0+

ARSkeleton.JointName

struct · iOS 13.0+

ARSkeleton2D

class · iOS 13.0+

ARSkeleton3D

class · iOS 13.0+

ARSkeletonDefinition

class · iOS 13.0+

ARSKView

class · iOS 11.0+

ARSKViewDelegate

protocol · iOS 11.0+

ARTrackable

protocol · iOS 11.0+

ARTrackedRaycast

class · iOS 13.0+

ARWorldMap

class · iOS 12.0+

ARWorldTrackingConfiguration

class · iOS 11.0+

ARWorldTrackingConfiguration.EnvironmentTexturing

enum · iOS 12.0+

ARWorldTrackingConfiguration.PlaneDetection

struct · iOS 11.0+

Functions and constants

get · iOS 11.0+

ARErrorDomain

TypeScript
const ARErrorDomain: string
Swift declaration
let ARErrorDomain: String

Skipped declarations

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

ARGeometrySource.subscript(_:)

The iOS SDK compiler rejected this binding: ambiguous use of 'subscript(_:)'

ARGeometrySource.subscript(_:)

The iOS SDK compiler rejected this binding: ambiguous use of 'subscript(_:)'

SCNDebugOptions.showWorldOrigin

The iOS SDK compiler rejected this binding: type 'SCNDebugOptions' has no member 'showWorldOrigin'

SCNDebugOptions.showFeaturePoints

The iOS SDK compiler rejected this binding: type 'SCNDebugOptions' has no member 'showFeaturePoints'

ARReferenceObject.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

ARRaycastQuery.init()

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

ARParticipantAnchor.init()

inherited init: clang: 'init' is unavailable

ARSession.CollaborationData.init()

inherited init: clang: 'init' is unavailable

ARHitTestResult.init()

inherited init: clang: 'init' is unavailable

ARObjectAnchor.init()

inherited init: clang: 'init' is unavailable

AREnvironmentProbeAnchor.init()

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

ARAnchor.init()

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

ARGeoTrackingStatus.init()

inherited init: clang: 'init' is unavailable

ARSCNPlaneGeometry.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

ARGeoAnchor.init()

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

ARConfiguration.init()

inherited init: clang: 'init' is unavailable

ARDirectionalLightEstimate.init()

inherited init: clang: 'init' is unavailable

ARLightEstimate.init()

inherited init: clang: 'init' is unavailable

ARPlaneAnchor.init()

inherited init: clang: 'init' is unavailable

ARImageAnchor.init()

inherited init: clang: 'init' is unavailable

ARPlaneGeometry.init()

inherited init: clang: 'init' is unavailable

ARPointCloud.init()

inherited init: clang: 'init' is unavailable

ARMatteGenerator.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

ARRaycastResult.init()

inherited init: clang: 'init' is unavailable

ARSkeleton.init()

inherited init: clang: 'init' is unavailable

ARSkeleton2D.init()

inherited init: clang: 'init' is unavailable

ARSkeleton3D.init()

inherited init: clang: 'init' is unavailable

ARMeshAnchor.init()

inherited init: clang: 'init' is unavailable

ARReferenceImage.init()

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

ARBody2D.init()

inherited init: clang: 'init' is unavailable