Namespace UnityEngine.XR.ARSubsystems

Classes

ARRenderingUtils

A utilities class for containing universally useful Rendering operations and information for rendering AR.

AddReferenceImageJobStatusExtensions

Extensions to the AddReferenceImageJobStatus enum.

The base class for configuration choosers, which determines which configuration a session will use. Used by DetermineConfiguration(Feature). Use configurationChooser to get or set the session's configuration choosers.

DefaultConfigurationChooser

A default implementation of a ConfigurationChooser.

EnvironmentDepthModeExtension

Extension for the EnvironmentDepthMode.

FeatureExtensions

Extension methods for Feature flags.

GuidUtil

Utility for dealing with Guids.

HandheldARInputDevice

A Handheld AR device layout that represents a mobile AR device, for use with the Input System package.

MutableRuntimeReferenceImageLibrary

A reference image library that can be constructed and modified at runtime.

NativeCopyUtility

Utilities for copying native arrays.

PlaneAlignmentExtensions

Extension methods for the PlaneAlignment enum.

PlaneClassificationExtensions

Utility methods for converting between PlaneClassification and PlaneClassifications values. These methods will be removed once the deprecated PlaneClassification enumeration is removed.

Promise<T>

A Promise is used for operations that retrieve data asynchronously. Use this object to determine the status of the operation (that is, whether it has completed), and the resulting data.

RuntimeReferenceImageLibrary

The runtime representation of a XRReferenceImageLibrary. Some libraries are mutable; see MutableRuntimeReferenceImageLibrary.

TrackingSubsystem<TTrackable, TSubsystem, TSubsystemDescriptor, TProvider>

Base class for subsystems that detect and track things in the physical environment.

ValidationUtility<T>

A utility to validate data from certain types of Subsystems.

XRAnchorSubsystem

This subsystem provides information regarding anchors. An anchor is a pose (position and rotation) in the physical environment that is tracked by an XR device. Anchors are updated as the device refines its understanding of the environment, allowing you to reliably place virtual content at a real-world pose.

XRAnchorSubsystem.Provider

An abstract class to be implemented by providers of this subsystem.

XRAnchorSubsystemDescriptor

Indicates the capabilities supported by a provider of the XRAnchorSubsystem. Provider implementations must derive from XRAnchorSubsystem.Provider and may override virtual class members.

XRBoundingBoxSubsystem

This subsystem provides information regarding the detection of 3D bounding boxes in the physical environment.

XRBoundingBoxSubsystem.Provider

The provider API for XRBoundingBoxSubsystem-derived classes to implement.

XRBoundingBoxSubsystemDescriptor

Indicates the capabilities supported by a provider of the XRBoundingBoxSubsystem. Provider implementations must derive from XRBoundingBoxSubsystem.Provider and may override virtual class members.

XRCameraSubsystem

Provides access to a device's camera.

XRCameraSubsystem.Provider

Interface for providing camera functionality for the implementation.

XRCameraSubsystemDescriptor

Specifies the functionalities supported by a provider of the XRCameraSubsystem. Provider implementations must derive from XRCameraSubsystem.Provider and may override virtual class members.

XRCpuImage.Api

An API for interacting with XRCpuImages.

XRCpuImageAsyncConversionStatusExtensions

Extension methods for the XRCpuImage.AsyncConversionStatus enum.

XRCpuImageFormatExtensions

Extensions to convert between TextureFormat and XRCpuImage.Format.

XRDepthSubsystem

An abstract class that provides a generic API for low-level depth detection features.

XRDepthSubsystem.Provider

The interface that each derived class must implement.

XRDepthSubsystemDescriptor

The descriptor of the XRDepthSubsystem that shows which depth detection features are available on that XRSubsystem.

XREnvironmentProbeSubsystem

Defines an interface for interacting with environment probe functionality for creating realistic lighting and environment texturing in AR scenes.

XREnvironmentProbeSubsystem.Provider

The class for providers to implement to support the XREnvironmentProbeSubsystem.

XREnvironmentProbeSubsystemDescriptor

Specifies a functionality description that can be registered for each implementation that provides the XREnvironmentProbeSubsystem interface.

XRFaceSubsystem

An abstract class that provides a generic API for low-level face tracking features.

XRFaceSubsystem.Provider

Class to be implemented by an implementor of the XRFaceSubsystem.

XRFaceSubsystemDescriptor

The descriptor of the XRFaceSubsystem that shows which face tracking features are available on that XRSubsystem.

XRHumanBodySubsystem

Defines an interface for interacting with human body functionality.

XRHumanBodySubsystem.Provider

The provider which will service the XRHumanBodySubsystem.

XRHumanBodySubsystemDescriptor

The descriptor for the XRHumanBodySubsystem.

XRImageTrackingSubsystem

A subsystem for detecting and tracking a preconfigured set of images in the environment.

XRImageTrackingSubsystem.Provider

Methods to implement by the implementing provider.

XRImageTrackingSubsystemDescriptor

Describes the capabilities of an XRImageTrackingSubsystem.

XRObjectTrackingSubsystem

Base class for object tracking subsystems.

XRObjectTrackingSubsystem.Provider

For AR implementors: implement this class to provide support for object tracking.

XRObjectTrackingSubsystemDescriptor

Describes features of an XRObjectTrackingSubsystem.

XROcclusionSubsystem

Defines an interface for interacting with occlusion functionality.

XROcclusionSubsystem.Provider

The provider which will service the XROcclusionSubsystem.

XROcclusionSubsystemDescriptor

Descriptor for the XROcclusionSubsystem.

XRParticipantSubsystem

Subsystem for managing the participants in a multi-user collaborative session.

XRParticipantSubsystem.Provider

The API this subsystem uses to interact with different provider implementations.

XRParticipantSubsystemDescriptor

The descriptor of the XRParticipantSubsystem that shows which features are available on that XRSubsystem.

XRPlaneSubsystem

This subsystem provides information regarding the detection of planes (that is, flat surfaces) in the real-world environment.

XRPlaneSubsystem.Provider

The provider API for XRPlaneSubsystem-derived classes to implement.

XRPlaneSubsystemDescriptor

Indicates the capabilities supported by a provider of the XRPlaneSubsystem. Provider implementations must derive from XRPlaneSubsystem.Provider and may override virtual class members.

XRPointCloudSubsystem

An abstract class that provides a generic API for low-level point cloud detection features.

XRPointCloudSubsystem.Provider

The interface that each derived class must implement.

XRPointCloudSubsystemDescriptor

The descriptor of the XRPointCloudSubsystem that shows which point cloud detection features are available on that XRSubsystem.

XRRaycastSubsystem

Base class for a raycast subsystem.

XRRaycastSubsystem.Provider

An interface to be implemented by providers of this subsystem.

XRRaycastSubsystemDescriptor

Descriptor for the XRRaycastSubsystem. Describes capabilities of a specific raycast provider.

XRReferenceImageLibrary

A reference image library is a collection of images to search for in the physical environment when image tracking is enabled.

XRReferenceObjectEntry

A provider-specific reference object.

XRReferenceObjectLibrary

A container for reference objects. A reference object represents a 3D scan of a real object that can be recognized in the environment. A XRObjectTrackingSubsystem will search for objects based on the contents of a XRReferenceObjectLibrary.

XRSessionSubsystem

This subsystem controls the lifecycle of an XR session. Some platforms, particularly those that have non-XR modes, need to be able to turn the session on and off to enter and exit XR modes of operation.

XRSessionSubsystem.Provider

The API this subsystem uses to interop with different provider implementations.

XRSessionSubsystemDescriptor

Descriptor for the XRSessionSubsystem describing capabilities which may vary by implementation.

Structs

AddReferenceImageJobState

Represents the state of an asynchronous "add image job" scheduled by ScheduleAddImageWithValidationJob(NativeSlice<byte>, Vector2Int, TextureFormat, XRReferenceImage, JobHandle).

BoundedPlane

The session-relative data associated with a plane.

Configuration

Represents a session configuration. It consists of a configuration descriptor, which contains information about the capabilities of the configuration, and the specific features which should be enabled by this configuration. Use DetermineConfiguration(Feature) to get a Configuration given a set of features.

ConfigurationDescriptor

Information about a configuration supported by a XRSessionSubsystem. Used by a ConfigurationChooser to select a configuration for the session.

FaceSubsystemParams

This struct is an initializer for the creation of a XRFaceSubsystemDescriptor.

MutableRuntimeReferenceImageLibrary.Enumerator

An enumerator to be used in a foreach statement.

Result<T>

Represents the result of a completed operation that attempted to create an object of type T.

ScopedProfiler

An IDisposable profiler object that will begin a profiler sample on instantiation and end the same when disposed.

Example:

using (new ScopedProfiler("MySample"))
{
    CodeToProfile();
}

SerializableGuid

A Guid that can be serialized by Unity. The 128-bit Guid is stored as two 64-bit ulongs. See also the creation utility at UnityEditor.XR.ARSubsystems.SerializableGuidUtil.

ShaderKeywords

Stores the enabled and disabled shader keywords for a material.

TrackableChanges<T>

Holds arrays of changes to trackables (added, updated, and removed). This is typically used by subsystems to report changes each frame.

TrackableId

A session-unique identifier for trackables in the real-world environment, such as planes and feature points.

XRAnchor

Describes session-relative data for an anchor.

XRAnchorSubsystemDescriptor.Cinfo

Contains the parameters necessary to construct a new XRAnchorSubsystemDescriptor instance.

XRBoundingBox

The session-relative data associated with a 3D bounding box.

XRBoundingBoxSubsystemDescriptor.Cinfo

Contains the parameters necessary to construct a new XRBoundingBoxSubsystemDescriptor instance.

XRCameraBackgroundRenderingParams

Describes the geometry and transform of the camera background for a given platform.

XRCameraConfiguration

Contains information about camera configuration.

XRCameraFrame

Represents a frame captured by the device camera with included metadata.

XRCameraFrameExifData

Represents EXIF data from the frame captured by the device camera.

XRCameraIntrinsics

Camera intrinsics describe physical characteristics of a camera.

XRCameraParams

Parameters of the Unity Camera that might be necessary or useful to the provider.

XRCameraSubsystemCinfo

Contains the parameters for creating a new XRCameraSubsystemDescriptor.

XRCameraSubsystemDescriptor.Cinfo

Contains the parameters for creating a new XRCameraSubsystemDescriptor.

XRCpuImage

Represents a single, raw image from a device camera. Provides access to the raw image plane data, as well as conversion methods to convert to color and grayscale formats. See Convert(ConversionParams, IntPtr, int) and ConvertAsync(ConversionParams). Use TryAcquireLatestCpuImage(out XRCpuImage) to get a XRCpuImage.

XRCpuImage.AsyncConversion

Holds information related to an asynchronous camera image conversion request. Returned by ConvertAsync(ConversionParams).

XRCpuImage.Cinfo

Container for native camera image construction metadata.

XRCpuImage.ConversionParams

Describes a set of conversion parameters for use with XRCpuImage's conversion methods.

XRCpuImage.Plane

Information about the camera image planes. An image plane refers to an image channel used in video encoding.

XRCpuImage.Plane.Cinfo

Container for the metadata that describes access to the raw camera image plane data.

XRDepthSubsystemDescriptor.Cinfo

This struct is an initializer for the creation of a XRDepthSubsystemDescriptor.

XREnvironmentProbe

Contains all of the data provided for an individual environment probe in an AR session.

XREnvironmentProbeSubsystemCinfo

Contains the parameters for creating a new XREnvironmentProbeSubsystemDescriptor.

XREnvironmentProbeSubsystemDescriptor.Cinfo

Contains the parameters for creating a new XREnvironmentProbeSubsystemDescriptor.

XRFace

A struct that describes face data stored in the XRFaceSubsystem.

XRFaceMesh

Container for mesh data associated with an XRFace. Not all implementations support all data. Check for existence with NativeArray's IsCreated property.

XRFaceSubsystemDescriptor.Cinfo

This struct is an initializer for the creation of a XRFaceSubsystemDescriptor.

XRHumanBody

Container for the data that represents a trackable human body.

XRHumanBodyJoint

Containter for the human body joint data.

XRHumanBodyPose2DJoint

Container for a human body pose 2D joint as part of a AR detected screen space skeleton.

XRHumanBodySubsystemCinfo

Constructor info for the XRHumanBodySubsystemDescriptor.

XRHumanBodySubsystemDescriptor.Cinfo

Constructor info for the XRHumanBodySubsystemDescriptor.

XRImageTrackingSubsystemDescriptor.Cinfo

Construction information for the XRImageTrackingSubsystemDescriptor.

XRObjectTrackingSubsystemDescriptor.Capabilities

Describes the capabilities of an XRObjectTrackingSubsystem implementation.

XRObjectTrackingSubsystemDescriptor.Cinfo

This struct is an initializer for the creation of a XRObjectTrackingSubsystemDescriptor.

XROcclusionSubsystemCinfo

Constructor parameters for the XROcclusionSubsystemDescriptor.

XROcclusionSubsystemDescriptor.Cinfo

Constructor parameters for the XROcclusionSubsystemDescriptor.

XRParticipant

The session-relative data associated with a participant.

XRParticipantSubsystemDescriptor.Cinfo

This struct is an initializer for the creation of a XRParticipantSubsystemDescriptor.

XRPlaneSubsystemDescriptor.Cinfo

Contains the parameters necessary to construct a new XRPlaneSubsystemDescriptor instance.

XRPointCloud

Represents the session relative data for the XRPointCloudSubsystem. XRPointClouds are usually created by GetChanges(Allocator).

XRPointCloudData

Represents the data (arrays of positions, confidence values, and identifiers) associated with a point cloud.

XRPointCloudSubsystemDescriptor.Cinfo

This struct is an initializer for the creation of a XRPointCloudSubsystemDescriptor.

XRRaycast

Represents the intersection of a raycast with a trackable.

XRRaycastHit

Represents the intersection of a raycast with a trackable.

XRRaycastSubsystemDescriptor.Cinfo

Used to register a descriptor. See RegisterDescriptor(Cinfo).

XRReferenceImage

Represents an entry in an XRReferenceImageLibrary.

XRReferenceObject

Represents a 3D scan of a real object that can be recognized in the environment.

XRResultStatus

Represents the status of a completed operation as a cross-platform statusCode and a platform-specific nativeStatusCode.

XRSessionSubsystemDescriptor.Cinfo

Used in conjunction with RegisterDescriptor(Cinfo) to register a provider. This should only be used by subsystem implementors.

XRSessionUpdateParams

Update parameters for Update(XRSessionUpdateParams).

XRTextureDescriptor

Contains a native texture object and includes various metadata about the texture.

XRTrackedImage

Contains low-level data for a tracked image in the environment.

XRTrackedObject

Describes a tracked object detected by the XRObjectTrackingSubsystem.

Interfaces

IReferenceImageLibrary

An interface for a reference image library. This is a set of reference images to search for in the physical environment.

ITrackable

Defines the interface for a trackable. A trackable represents anything that can be detected and tracked in the physical environment.

Delegates

XRCpuImage.Api.OnImageRequestCompleteDelegate

Callback from native code for when the asynchronous conversion is complete.

Namespace UnityEngine.XR.ARSubsystems

Classes

Structs

Interfaces

Enums