Namespace UnityEngine.XR.ARSubsystems | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Namespace UnityEngine.XR.ARSubsystems

    Classes

    NativeCopyUtility

    Utilities for copying native arrays.

    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.

    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.

    XRCameraSubsystem

    Provides access to a device's camera.

    XRCameraSubsystem.IProvider

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

    The interface that each derived class must implement.

    XRDepthSubsystemDescriptor

    XRPlaneSubsystem

    Base class for plane subsystems.

    XRPlaneSubsystem.IProvider

    The API that derived classes must implement.

    XRPlaneSubsystemDescriptor

    Describes the capabilities of an XRPlaneSubsystem.

    XRRaycastSubsystem

    Base class for a raycast subsystem.

    XRRaycastSubsystem.IProvider

    An interface to be implemented by providers of this subsystem.

    XRRaycastSubsystemDescriptor

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

    XRReferencePointSubsystem

    Base class for a reference point subsystem.

    XRReferencePointSubsystem.IProvider

    An interface to be implemented by providers of this subsystem.

    XRReferencePointSubsystemDescriptor

    Describes the capabilities of an XRReferencePointSubsystem.

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

    XRSessionSubsystem.IProvider

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

    XRSessionSubsystemDescriptor

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

    Structs

    BoundedPlane

    The session relative data associated with a plane.

    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.

    XRCameraFrame

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

    XRCameraFrameReceivedArgs

    Encapsulates all information provided in an event callback for when the camera frame is received.

    XRCameraIntrinsics

    Camera intrinsics describe physical characteristics of a camera.

    XRCameraParams

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

    XRCameraSubsystemCinfo

    Encapsulates the parameters for creating a new XRCameraSubsystemDescriptor.

    XRDepthSubsystemDescriptor.Cinfo

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

    XRReferencePoint

    Describes session relative data for a reference point.

    XRReferencePointSubsystemDescriptor.Cinfo

    Constructor info used to register a descriptor.

    XRSessionSubsystemDescriptor.Cinfo

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

    XRSessionUpdateParams

    Update parameters for Update(XRSessionUpdateParams).

    XRTextureDescriptor

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

    Interfaces

    ITrackable

    Defines an interface for the structs associated with tracking subsystems.

    Enums

    CameraFocusMode

    Represents the focus mode of the camera.

    LightEstimationMode

    Represents the light estimation mode.

    PlaneAlignment

    Represents the alignment of a plane, e.g., whether it is horizontal or vertical.

    PlaneDetectionMode

    Used to configure the types of planes to detect.

    SessionAvailability

    Flags used to determine session availability.

    SessionInstallationStatus

    An enum used to determine that current status of the software install.

    TrackableType

    Flags representing trackable types in XR. A "trackable" is feature in the physical environment that a device is able to track, such as a surface. Often used in conjunction with XRRaycastHit.

    TrackingState

    Represents pose tracking quality. May apply to a device or trackables it is tracking in the environment.

    XRCameraFrameProperties

    Represents the properties included in the camera frame.

    XRDepthSubsystemDescriptor.Capabilities

    Describes the capabilities of an XRDepthSubsystem.

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023