Namespace UnityEngine.XR.ARFoundation
Classes
ARAnchor
Represents an Anchor tracked by an XR device.
ARAnchorManager
Manages anchors.
ARBackgroundRendererFeature
A render feature for rendering the camera background for AR devices.
ARCameraBackground
Add this component to a Camera
to copy the color camera's texture onto the background.
If you are using the Universal Render Pipeline (version 7.0.0 or later), you must also add the ARBackgroundRendererFeature to the list of render features for the scriptable renderer.
ARCameraManager
Manages the life cycle of the XRCameraSubsystem. Add one of these to a Camera
in your scene
if you want camera texture and light estimation information to be available.
ARDebugMenu
Menu that is added to a scene to surface tracking data and visualize trackables in order to aid in debugging.
AREnvironmentProbe
A GameObject component to manage the reflection probe settings as the environment probe changes are applied.
AREnvironmentProbeManager
This class creates, maintains, and destroys environment probe GameObject components as the
XREnvironmentProbeSubsystem
provides updates from environment probes as they are detected in the
environment.
ARFace
Represents a face detected by an AR device.
ARFaceManager
Creates, updates, and removes GameObject
s with ARFace components under the
Unity.XR.CoreUtils.XROrigin's Unity.XR.CoreUtils.XROrigin.TrackablesParent.
ARFaceMeshVisualizer
Generates a mesh for an ARFace.
ARHumanBody
Trackable human body containing the base pose for the body and the body skeleton.
ARHumanBodyManager
The manager for the human body subsystem.
ARInputManager
Manages the lifetime of the XRInputSubsystem
. Add one of these to any GameObject
in your scene
if you want device pose information to be available. Read the input by using the TrackedPoseDriver
ARLightEstimationDataTestFixture
ARMeshManager
A manager for triangle meshes generated by an AR device.
Creates, updates, and removes GameObject
s in
response to the environment. For each mesh, a meshPrefab is instantiated which must contain at
least a MeshFilter
. If the
meshPrefab's GameObject
also has a
MeshCollider
, then a physics mesh is generated
asynchronously, without blocking the main thread.
AROcclusionManager
The manager for the occlusion subsystem.
ARParticipant
Represents a participant (that is, another device in a collaborative session).
ARParticipantManager
A manager for ARParticipants. Creates, updates, and removes
GameObject
s in response to other users in a multi-user collaborative session.
ARPlane
Represents a plane (that is, a flat surface) detected by an AR device.
ARPlaneManager
A manager for ARPlanes. Creates, updates, and removes
GameObject
s in response to detected surfaces in the physical
environment.
ARPlaneMeshGenerators
Generator methods for ARPlane mesh geometery.
ARPlaneMeshVisualizer
Generates a mesh for an ARPlane.
ARPointCloud
Represents a detected point cloud. These are also known as feature points.
ARPointCloudManager
A manager for ARTrackedObjects. Uses the XRPointCloudSubsystem
to recognize and track point cloud data in the physical environment.
ARPointCloudMeshVisualizer
Renders an ARPointCloud as a Mesh
with MeshTopology.Points
.
ARPointCloudParticleVisualizer
Renders an ARPointCloud as a ParticleSystem
.
ARPoseDriver
The ARPoseDriver component applies the current Pose value of an AR device to the transform of the GameObject.
ARRaycast
Represents a raycast that updates automatically.
ARRaycastManager
Manages an XRRaycastSubsystem
, exposing raycast functionality in AR Foundation. Use this component
to raycast against trackables (that is, detected features in the physical environment) when they do not have
a presence in the Physics world.
ARSession
Controls the lifecycle and configuration options for an AR session. There is only one active session. If you have multiple ARSession components, they all communicate to the same session and will conflict with each other.
Enabling or disabling the ARSession starts or stops the session, respectively.
ARSessionOrigin
An ARSessionOrigin
is the parent for an AR setup. It contains a Camera
and
any GameObject
s created from detected features, such as planes or point clouds.
ARSessionTestFixture
ARTrackable
The base class for all ARTrackable<TSessionRelativeData, TTrackable> types.
ARTrackableManager<TSubsystem, TSubsystemDescriptor, TProvider, TSessionRelativeData, TTrackable>
A generic manager for components generated by features detected in the physical environment.
ARTrackable<TSessionRelativeData, TTrackable>
A generic component for trackables. A "trackable" is a feature in the physical environment that can be detected and tracked by an XR device.
ARTrackedImage
Represents a tracked image in the physical environment.
ARTrackedImageManager
A manager for ARTrackedImages. Uses the XRImageTrackingSubsystem
to recognize and track 2D images in the physical environment.
ARTrackedObject
Represents a tracked object in the physical environment.
ARTrackedObjectManager
A manager for ARTrackedObjects. Uses the XRObjectTrackingSubsystem
to recognize and track 3D objects in the physical environment.
ARUpdateOrder
The update order for MonoBehaviour
s in AR Foundation.
CameraBackgroundRenderingModeUtilities
Provides conversion utilities between XRCameraBackgroundRenderingMode and CameraBackgroundRenderingMode.
CameraModeExtensions
Extensions related to the CameraFacingDirection enum.
LightEstimationExtensions
Extension methods for the LightEstimation enum.
LoaderUtility
A utility for interacting with an XRLoader
from
XR Management.
MeshQueueTestFixture
MutableRuntimeReferenceImageLibraryExtensions
Extension methods for MutableRuntimeReferenceImageLibrary.
PlaneDetectionModeMaskAttribute
An attribute that can be placed on MonoBehaviour
fields to
generate the correct UI for the
PlaneDetectionMode
enum.
PoseExtensions
Several method extensions to Pose
for inverse-transforming additional Unity types.
SubsystemLifecycleManager<TSubsystem, TSubsystemDescriptor, TProvider>
A base class for subsystems whose lifetime is managed by a MonoBehaviour
.
ToolButton
Script that handles button highlighting in menus when button is selected.
TrackingModeExtensions
Extensions for the TrackingMode and Feature
enums,
allowing conversion between the two.
TransformExtensions
Several method extensions to Transform
for transforming and inverse-transforming additional Unity types.
Structs
ARAnchorsChangedEventArgs
Event arguments for the anchorsChanged event.
ARCameraFrameEventArgs
A structure for camera-related information pertaining to a particular frame. This is used to communicate information in the frameReceived event.
AREnvironmentProbesChangedEvent
Event arguments for the environmentProbesChanged event.
ARFaceUpdatedEventArgs
Holds data relevant to the updated event.
ARFacesChangedEventArgs
Event arguments for the facesChanged event.
ARHumanBodiesChangedEventArgs
Container for the changed humanBodiesChanged of the event.
ARLightEstimationData
A structure for light estimation information provided by the AR device.
ARMeshesChangedEventArgs
Event arguments for the meshesChanged event.
AROcclusionFrameEventArgs
A structure for occlusion information pertaining to a particular frame. This is used to communicate information in the frameReceived event.
ARParticipantsChangedEventArgs
Event arguments for the participantsChanged event.
ARPlaneBoundaryChangedEventArgs
Data associated with an boundaryChanged event.
ARPlanesChangedEventArgs
Event arguments for the planesChanged event.
ARPointCloudChangedEventArgs
Event arguments for the pointCloudsChanged event.
ARPointCloudUpdatedEventArgs
The arguments for the updated event. This is currently empty, but it might change in the future without the need to change the subscribers' method signatures.
ARRaycastHit
Represents the result of a raycast intersection with a trackable.
ARRaycastUpdatedEventArgs
Provides arguments for the updated event.
ARSessionStateChangedEventArgs
Event arguments for stateChanged.
ARTrackedImagesChangedEventArgs
Event arguments for the trackedImagesChanged event.
ARTrackedObjectsChangedEventArgs
Event arguments for the trackedObjectsChanged event.
TrackableCollection<TTrackable>
A collection for ARTrackable<TSessionRelativeData, TTrackable>s.
This collection implements an IEnumerable-like interface which can be used
in a foreach
statement.
TrackableCollection<TTrackable>.Enumerator
An Enumerator
for TTrackable
s.
Enums
AREnvironmentProbePlacementType
Represents the method used to place an environment probe in the AR session.
ARSessionState
Represents the current state of the AR system.
CameraBackgroundRenderingMode
Describes when the AR Camera Background should render.
CameraFacingDirection
Represents the camera used when supplying the video feed.
LightEstimation
Defines types of light estimation.
TrackingMode
Represents the tracking mode for the session.