Expand description
§Bindings to the ARKit
framework
See Apple’s docs and the general docs on framework crates for more information.
Structs§
- ARAltitude
Source ARGeoTrackingTypes
andobjc2
- Keeps track of where an altitude value came from and informs the user about the expected accuracy.
- ARAnchor
ARAnchor
andobjc2
- Object representing a physical location and orientation in 3D space.
- ARApp
Clip Code Anchor ARAnchor
andARAppClipCodeAnchor
andobjc2
- An anchor representing an app clip code in the world.
- ARApp
Clip CodeURL Decoding State ARAppClipCodeAnchor
andobjc2
- A value describing app clip code URL decoding state.
- ARBody2D
ARBody2D
andobjc2
- Representation of a body in 2D.
- ARBody
Anchor ARAnchor
andARBodyAnchor
andobjc2
- An anchor representing a body in the world.
- ARBody
Tracking Configuration ARConfiguration
andobjc2
- A configuration for running body tracking.
- ARCamera
ARCamera
andobjc2
- A model representing the camera and its parameters.
- ARCoaching
Goal ARCoachingOverlayView
andobjc2
- A value describing the context required for successful coaching
- ARCoaching
Overlay View ARCoachingOverlayView
andobjc2
andobjc2-ui-kit
- A view that guides users through session initialization
- ARCollaboration
Data ARCollaborationData
andobjc2
- Object representing data for collaborative session.
- ARCollaboration
Data Priority ARCollaborationData
andobjc2
- A value describing the priority of the collaboration data.
- ARConfidence
Level ARDepthData
andobjc2
- Constants indicating the confidence level of per-pixel depth data.
- ARConfiguration
ARConfiguration
andobjc2
- An object to describe and configure the Augmented Reality techniques to be used in an ARSession.
- ARDepth
Data ARDepthData
andobjc2
- A container for depth data and its associated confidence.
- ARDirectional
Light Estimate ARLightEstimate
andobjc2
- A directional light estimate representing the light intensity and direction in the scene.
- AREnvironment
Probe Anchor ARAnchor
andAREnvironmentProbeAnchor
andobjc2
- An object representing an environment probe in the world.
- AREnvironment
Texturing ARConfiguration
andobjc2
- Enum constants for indicating the mode of environment texturing to run.
- ARError
Code ARError
andobjc2
- Apple’s documentation
- ARFace
Anchor ARAnchor
andARFaceAnchor
andobjc2
- An anchor representing a face and its geometry.
- ARFace
Geometry ARFaceGeometry
andobjc2
- An object representing the geometry of a face.
- ARFace
Tracking Configuration ARConfiguration
andobjc2
- A configuration for running face tracking.
- ARFrame
ARFrame
andobjc2
- An object encapsulating the state of everything being tracked for a given moment in time.
- ARFrame
Semantics ARConfiguration
andobjc2
- Option set indicating semantic understanding types of the image frame.
- ARGeo
Anchor ARAnchor
andARGeoAnchor
andobjc2
- An anchor representing a geographical location in the world.
- ARGeo
Tracking Accuracy ARGeoTrackingTypes
andobjc2
- A value describing geo tracking accuracy.
- ARGeo
Tracking Configuration ARConfiguration
andobjc2
- A configuration for running geographical world tracking.
- ARGeo
Tracking State ARGeoTrackingTypes
andobjc2
- A value describing geo tracking state.
- ARGeo
Tracking State Reason ARGeoTrackingTypes
andobjc2
- Reasons for geo tracking failure states.
- ARGeo
Tracking Status ARGeoTrackingTypes
andobjc2
- Collection of fields to give information on geo tracking status.
- ARGeometry
Element ARMeshGeometry
andobjc2
- A container for index data describing how vertices connect to define a geometry.
- ARGeometry
Primitive Type ARMeshGeometry
andobjc2
- The primitive that defines how vertices are connected.
- ARGeometry
Source ARMeshGeometry
andobjc2
- A container for vector data of a geometry.
- ARHit
Test Result Deprecated ARHitTestResult
andobjc2
- A result of an intersection found during a hit-test.
- ARHit
Test Result Type ARHitTestResult
andobjc2
- Option set of hit-test result types.
- ARImage
Anchor ARAnchor
andARImageAnchor
andobjc2
- An anchor representing an image in the world.
- ARImage
Tracking Configuration ARConfiguration
andobjc2
- A configuration for running image tracking.
- ARLight
Estimate ARLightEstimate
andobjc2
- A light estimate representing the light in the scene.
- ARMatte
Generator ARMatteGenerator
andobjc2
- An object designed to generate either full resolution or half resolution matte given the ARFrame.
- ARMatte
Resolution ARMatteGenerator
andobjc2
- The resolution at which the matte is to be generated.
- ARMesh
Anchor ARAnchor
andARMeshAnchor
andobjc2
- Apple’s documentation
- ARMesh
Classification ARMeshGeometry
andobjc2
- A value describing the classification of a mesh face.
- ARMesh
Geometry ARMeshGeometry
andobjc2
- A three-dimensional shape that represents the geometry of a mesh.
- ARObject
Anchor ARAnchor
andARObjectAnchor
andobjc2
- An anchor representing an object in the world.
- ARObject
Scanning Configuration ARConfiguration
andobjc2
- A configuration for scanning objects.
- AROrientation
Tracking Configuration ARConfiguration
andobjc2
- A configuration for running orientation tracking.
- ARParticipant
Anchor ARAnchor
andARParticipantAnchor
andobjc2
- This anchor represents the physical position and orientation of another participant in the collaborative session.
- ARPlane
Anchor ARAnchor
andARPlaneAnchor
andobjc2
- An anchor representing a planar surface in the world.
- ARPlane
Anchor Alignment ARPlaneAnchor
andobjc2
- A value describing the alignment of a plane anchor.
- ARPlane
Classification ARPlaneAnchor
andobjc2
- A value describing the classification of a plane anchor.
- ARPlane
Classification Status ARPlaneAnchor
andobjc2
- A value describing the classification status of a plane anchor.
- ARPlane
Detection ARPlaneDetectionTypes
andobjc2
- Option set indicating the type of planes to detect.
- ARPlane
Extent ARPlaneAnchor
andobjc2
- Represents the extents of a plane.
- ARPlane
Geometry ARPlaneGeometry
andobjc2
- Object representing the geometry of a plane.
- ARPoint
Cloud ARPointCloud
andobjc2
- Apple’s documentation
- ARPositional
Tracking Configuration ARConfiguration
andobjc2
- A configuration for running positional tracking.
- ARQuick
Look Preview Item ARQuickLookPreviewItem
andobjc2
- Apple’s documentation
- ARRaycast
Query ARRaycastQuery
andobjc2
- Representation of a ray and its target which is used for raycasting.
- ARRaycast
Result ARRaycastResult
andobjc2
- Result of a raycast on a single target.
- ARRaycast
Target ARRaycastQuery
andobjc2
- A value describing the target of a ray used for raycasting.
- ARRaycast
Target Alignment ARRaycastQuery
andobjc2
- A value describing the alignment of a target.
- ARReference
Image ARReferenceImage
andobjc2
- A reference image to be detected in the scene.
- ARReference
Object ARReferenceObject
andobjc2
- A reference object to track in the scene.
- ARSCN
Face Geometry ARSCNFaceGeometry
andobjc2
andobjc2-scene-kit
- A SceneKit geometry representing a face.
- ARSCN
Plane Geometry ARSCNPlaneGeometry
andobjc2
andobjc2-scene-kit
- A SceneKit geometry representing a plane.
- ARScene
Reconstruction ARConfiguration
andobjc2
- Types of scene reconstruction.
- ARSegmentation
Class ARFrame
- Segmentation classes which defines a pixel’s semantic label.
- ARSession
ARSession
andobjc2
- The ARSession class configures and runs different Augmented Reality techniques on a device.
- ARSession
RunOptions ARSession
andobjc2
- Set of options for running the session.
- ARSkeleton
ARSkeleton
andobjc2
- An object representing a skeleton.
- ARSkeleton2D
ARSkeleton
andobjc2
- An object representing a skeleton in 2D.
- ARSkeleton3D
ARSkeleton
andobjc2
- An object representing a skeleton in 3D.
- ARSkeleton
Definition ARSkeletonDefinition
andobjc2
- Definition of a skeleton.
- ARTracked
Raycast ARTrackedRaycast
andobjc2
- A tracked raycast representation.
- ARTracking
State ARTrackingStatusTypes
andobjc2
- A value describing the camera’s tracking state.
- ARTracking
State Reason ARTrackingStatusTypes
andobjc2
- A reason describing why the camera’s tracking state is limited.
- ARVideo
Format ARVideoFormat
andobjc2
- Apple’s documentation
- ARWorld
Alignment ARConfiguration
andobjc2
- Enum constants for indicating the world alignment.
- ARWorld
Map ARWorldMap
andobjc2
- Object representing the mapping of a physical 3D space.
- ARWorld
Mapping Status ARFrame
andobjc2
- A value describing the world mapping status for the area visible in a given frame.
- ARWorld
Tracking Configuration ARConfiguration
andobjc2
- A configuration for running world tracking.
Statics§
- ARBlend
Shape ⚠Location Brow Down Left ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Brow Down Right ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Brow Inner Up ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Brow Outer UpLeft ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Brow Outer UpRight ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Cheek Puff ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Cheek Squint Left ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Cheek Squint Right ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location EyeBlink Left ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location EyeBlink Right ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location EyeLook Down Left ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location EyeLook Down Right ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location EyeLook InLeft ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location EyeLook InRight ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location EyeLook OutLeft ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location EyeLook OutRight ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location EyeLook UpLeft ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location EyeLook UpRight ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location EyeSquint Left ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location EyeSquint Right ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location EyeWide Left ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location EyeWide Right ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location JawForward ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location JawLeft ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location JawOpen ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location JawRight ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Close ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Dimple Left ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Dimple Right ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Frown Left ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Frown Right ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Funnel ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Left ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Lower Down Left ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Lower Down Right ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Press Left ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Press Right ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Pucker ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Right ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Roll Lower ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Roll Upper ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Shrug Lower ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Shrug Upper ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Smile Left ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Smile Right ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Stretch Left ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Stretch Right ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Upper UpLeft ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Mouth Upper UpRight ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Nose Sneer Left ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Nose Sneer Right ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARBlend
Shape ⚠Location Tongue Out ARFaceAnchor
andobjc2-foundation
- Apple’s documentation
- ARError
Domain ⚠ARError
andobjc2-foundation
- Apple’s documentation
- ARReference
Object ⚠Archive Extension ARReferenceObject
andobjc2-foundation
- Apple’s documentation
- ARSCN
Debug ⚠Option Show Feature Points ARSCNView
andobjc2-scene-kit
- Show detected 3D feature points in the world.
- ARSCN
Debug ⚠Option Show World Origin ARSCNView
andobjc2-scene-kit
- Show the world origin in the scene.
- ARSkeleton
Joint ⚠Name Head ARSkeletonDefinition
andobjc2-foundation
- Apple’s documentation
- ARSkeleton
Joint ⚠Name Left Foot ARSkeletonDefinition
andobjc2-foundation
- Apple’s documentation
- ARSkeleton
Joint ⚠Name Left Hand ARSkeletonDefinition
andobjc2-foundation
- Apple’s documentation
- ARSkeleton
Joint ⚠Name Left Shoulder ARSkeletonDefinition
andobjc2-foundation
- Apple’s documentation
- ARSkeleton
Joint ⚠Name Right Foot ARSkeletonDefinition
andobjc2-foundation
- Apple’s documentation
- ARSkeleton
Joint ⚠Name Right Hand ARSkeletonDefinition
andobjc2-foundation
- Apple’s documentation
- ARSkeleton
Joint ⚠Name Right Shoulder ARSkeletonDefinition
andobjc2-foundation
- Apple’s documentation
- ARSkeleton
Joint ⚠Name Root ARSkeletonDefinition
andobjc2-foundation
- Apple’s documentation
Traits§
- ARAnchor
Copying ARAnchor
andobjc2
andobjc2-foundation
- An anchor object that can be copied from values of an existing anchor.
- ARCoaching
Overlay View Delegate ARCoachingOverlayView
andobjc2
- Apple’s documentation
- ARSCN
View Delegate ARSCNView
andARSession
andobjc2
andobjc2-scene-kit
- Apple’s documentation
- ARSK
View Delegate ARSKView
andARSession
andobjc2
andobjc2-sprite-kit
- Apple’s documentation
- ARSession
Delegate ARSession
andobjc2
- Apple’s documentation
- ARSession
Observer ARSession
andobjc2
- Apple’s documentation
- ARSession
Providing ARSession
andobjc2
- A data source for an ARSession
- ARTrackable
ARAnchor
andobjc2
- A real world object or location in the scene that is being tracked.
Functions§
- ARSkeleton
Joint ⚠Name ForRecognized Point Key ARSkeleton
andARSkeletonDefinition
andobjc2
andobjc2-foundation
andobjc2-vision
- Returns the landmark joint name that corresponds to a key point defined in Vision framework.
Type Aliases§
- ARBlend
Shape Location ARFaceAnchor
andobjc2-foundation
- Blend shape locations of a face geometry.
- ARSCN
Debug Options ARSCNView
andobjc2-scene-kit
- Extended debug options for an ARSCNView
- ARSkeleton
Joint Name ARSkeletonDefinition
andobjc2-foundation
- Apple’s documentation