Namespace UnityEngine.XR.ARFoundation
Classes
ARBackgroundRendererAsset
An asset used with the ARFoundationBackgroundRenderer. Useful for working with the Lightweight Render Pipeline (LWRP).
ARCameraBackground
Add this component to a Camera
to copy the color camera's texture onto the background.
ARCameraManager
Manages the lifetime 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.
AREnvironmentProbe
A game object component to manage the reflection probe settings as the environment probe changes are applied.
AREnvironmentProbeManager
This class creates, maintains, and destroys environment probe game object 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 ARSessionOrigin's trackablesParent.
ARFaceMeshVisualizer
Generates a mesh for an ARFace.
ARFoundationBackgroundRenderer
Uses command buffers to blit an image to a camera's background.
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.
ARPlane
Represents a plane (i.e., 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 functions for ARPlane mesh geometery.
ARPlaneMeshVisualizer
Generates a mesh for an ARPlane.
ARPointCloud
Represents a detected point cloud, aka feature points.
ARPointCloudManager
A manager for ARTrackedObjects. Uses the XRDepthSubsystem
to recognize and track depth data in the physical environment.
ARPointCloudMeshVisualizer
Renders an ARPointCloud as a Mesh
with MeshTopology.Points
.
ARPointCloudParticleVisualizer
Renders an ARPointCloud as a ParticleSystem
.
ARRaycastManager
Manages an XRRaycastSubsystem
, exposing raycast functionality in ARFoundation. Use this component
to raycast against trackables (i.e., detected features in the physical environment) when they do not have
a presence in the Physics world.
ARReferencePoint
Represents a Reference Point tracked by an XR device.
ARReferencePointManager
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 talk to the same session and will conflict with each other.
Enabling or disabling the ARSession will start or stop 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.
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.
ARTrackableManager<TSubsystem, TSubsystemDescriptor, TSessionRelativeData, TTrackable>
A generic manager for components generated by features detected in the physical environment.
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 ARFoundation.
MeshQueueTestFixture
MutableRuntimeReferenceImageLibraryExtensions
Extension methods for UnityEngine.XR.ARSubsystems.MutableRuntimeReferenceImageLibrary
.
PlaneDetectionModeMaskAttribute
An attribute that can be placed on MonoBehaviour
fields to
generate the correct UI for the
PoseExtensions
Several method extensions to Pose
for inverse-transforming additional Unity types.
PoseExtensionsTestFixture
SubsystemLifecycleManager<TSubsystem, TSubsystemDescriptor>
A base class for subsystems whose lifetime is managed by a MonoBehaviour
.
TransformExtensions
Several method extensions to Transform
for transforming and inverse-transforming additional Unity types.
Structs
ARCameraFrameEventArgs
A structure for camera-related information pertaining to a particular frame.
This is used to communicate information in the
AREnvironmentProbesChangedEvent
Event arguments for the environmentProbesChanged event.
ARFacesChangedEventArgs
Event arguments for the
ARFaceUpdatedEventArgs
Holds data relevant to the updated event.
ARFoundationBackgroundRendererChangedEventArgs
The arguments for the backgroundRendererChanged event. This is currently empty, but may change in the future without the need to change the subscribers' method signatures.
ARHumanBodiesChangedEventArgs
Container for the changed ARHumanBody
of the event.
ARLightEstimationData
A structure for light estimation information provided by the AR device.
ARMeshesChangedEventArgs
Event arguments for the meshesChanged event.
ARPlaneBoundaryChangedEventArgs
Data associated with an boundaryChanged event.
ARPlanesChangedEventArgs
Event arguments for the
ARPointCloudChangedEventArgs
Event arguments for the
ARPointCloudUpdatedEventArgs
The arguments for the updated event. This is currently empty, but may change in the future without the need to change the subscribers' method signatures.
ARRaycastHit
Represents the result of a raycast intersection with a trackable.
ARReferencePointsChangedEventArgs
Event arguments for the referencePointsChanged event.
ARSessionStateChangedEventArgs
Container for SystemState event arguments. Used by the
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.
ARRenderMode
AR rendering modes used with ARFoundationBackgroundRenderer.
ARSessionState
Represents the current state of the AR system.