Namespace UnityEngine.XR.ARSubsystems

Classes

MutableRuntimeReferenceImageLibrary

A reference image library that can be constructed and modified at runtime. By contrast, an XRReferenceImageLibrary can only be constructed at edit-time and is immutable at runtime.

PlaneAlignmentExtensions

Extension methods for the PlaneAlignment enum.

Promise<T>

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

RuntimeReferenceImageLibrary

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

SessionAvailabilityExtensions

Extensions to the SessionAvailability and SessionInstallationStatus enums.

TrackingSubsystem<TTrackable, TSubsystemDescriptor>

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.Provider

An interface to be implemented by providers of this subsystem.

XRAnchorSubsystemDescriptor

Describes the capabilities of an XRAnchorSubsystem.

XRAsyncCameraImageConversionStatusExtensions

Extension methods for the AsyncCameraImageConversionStatus enum.

XRCameraSubsystem.Provider

Interface for providing camera functionality for the implementation.

XRCameraSubsystemDescriptor

Specifies a functionality description that may be registered for each implementation that provides the XRCameraSubsystem interface.

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.

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 may 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.

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.

XRParticipantSubsystem

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

XRParticipantSubsystem.Provider

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

XRParticipantSubsystemDescriptor

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

XRPlaneSubsystem.Provider

The API that derived classes must implement.

XRPlaneSubsystemDescriptor

Describes the capabilities of an XRPlaneSubsystem.

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.

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 mode(s) 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.

XRSubsystem<TSubsystemDescriptor>

Serves as the base class for all the subsystems in this package.

Structs

BoundedPlane

The session relative data associated with a plane.

FaceSubsystemParams

MutableRuntimeReferenceImageLibrary.Enumerator

An enumerator to be used in a foreach statement.

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.

TrackableChanges<T>

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

TrackableId

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

XRAnchor

Describes session relative data for an anchor.

XRAnchorSubsystemDescriptor.Cinfo

Constructor info used to register a descriptor.

XRAsyncCameraImageConversion

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

XRCameraConfiguration

Contains information regarding the camera configuration. Different devices support different camera configurations. This includes the resolution of the image and may include framerate on some platforms.

XRCameraFrame

Parameters of the Unity Camera that may be necessary/useful to the provider.

XRCameraImage

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(XRCameraImageConversionParams, IntPtr, Int32) and ConvertAsync(XRCameraImageConversionParams). Use TryGetLatestImage(out XRCameraImage) to get a XRCameraImage.

XRCameraImageConversionParams

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

XRCameraImagePlane

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

XRCameraIntrinsics

Camera intrinsics describe physical characteristics of a camera.

XRCameraParams

Parameters of the Unity Camera that may be necessary/useful to the provider.

XRCameraSubsystem.CameraImageCinfo

Container for native camera image construction metadata.

XRCameraSubsystem.CameraImagePlaneCinfo

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

XRCameraSubsystemCinfo

Encapsulates the parameters for creating a new XRCameraSubsystemDescriptor.

XRDepthSubsystemDescriptor.Cinfo

XREnvironmentProbe

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

XREnvironmentProbeSubsystemCinfo

Encapsulates the parameters for creating a new XREnvironmentProbeSubsystemDescriptor.

XRFace

A struct describing face data that is 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.

XRImageTrackingSubsystemDescriptor.Cinfo

Construction information for the XRImageTrackingSubsystemDescriptor.

XRParticipant

The session-relative data associated with a participant.

XRPlaneSubsystemDescriptor.Cinfo

Constructor info used to register a descriptor.

XRPointCloud

Represents the session relative data for the XRDepthSubsystem. XRPointClouds are usually created by .

XRPointCloudData

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

XRRaycastHit

Represents the intersection of a raycast with a trackable.

XRRaycastSubsystemDescriptor.Cinfo

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

XRReferenceImage

Represents an entry in an XRReferenceImageLibrary.

XRSessionSubsystemDescriptor.Cinfo

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