Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseThe XR module contains the VR and AR related platform support functionality.
InputDevices | An interface for accessing devices in the XR input subsytem. |
InputTracking | A collection of methods and properties for interacting with the XR tracking system. |
IntegratedSubsystem | An IntegratedSubsystem is initialized from an IntegratedSubsystemDescriptor for a given Subsystem (Example, Input, Environment, Display, etc.) and provides an interface to interact with that given IntegratedSubsystem until it is Destroyed. After an IntegratedSubsystem is created it can be Started or Stopped to turn on and off functionality (and preserve performance). The base type for IntegratedSubsystem only exposes this functionality; this class is designed to be a base class for derived classes that expose more functionality specific to a given IntegratedSubsystem. Note: initializing a second IntegratedSubsystem from the same IntegratedSubsystemDescriptor will return a reference to the existing IntegratedSubsystem as only one IntegratedSubsystem is currently allowed for a single IntegratedSubsystem provider. |
IntegratedSubsystemDescriptor | Information about a subsystem that can be queried before creating a subsystem instance. |
Subsystem | A Subsystem is initialized from a SubsystemDescriptor for a given Subsystem (Example, Input, Environment, Display, etc.) and provides an interface to interact with that given Subsystem until it is Destroyed. After a Subsystem is created it can be Started or Stopped to turn on and off functionality (and preserve performance). The base type for Subsystem only exposes this functionality; this class is designed to be a base class for derived classes that expose more functionality specific to a given Subsystem. Note: initializing a second Subsystem from the same SubsystemDescriptor will return a reference to the existing Subsystem as only one Subsystem is currently allowed for a single Subsystem provider. |
SubsystemDescriptor | Information about a subsystem that can be queried before creating a subsystem instance. |
SubsystemManager | Gives access to subsystems which provide additional functionality through plugins. |
XRCameraSubsystem | Provides access to a device's camera. |
XRCameraSubsystemDescriptor | Class providing information about XRCameraSubsystem registration. |
XRDepthSubsystem | Provides access to depth data of the physical environment, such as a point cloud. |
XRDepthSubsystemDescriptor | Class providing information about XRDepthSubsystem registration. |
XRDisplaySubsystem | An XRDisplaySubsystem controls rendering to a head tracked display. |
XRDisplaySubsystemDescriptor | Class providing information about XRDisplaySubsystem registration. |
XRInputSubsystem | XRInputSubsystem Instance is used to enable and disable the inputs coming from a specific plugin. |
XRInputSubsystemDescriptor | Information about an Input subsystem. |
XRMeshSubsystem | Allows external systems to provide dynamic meshes to Unity. |
XRMeshSubsystemDescriptor | Information about an XRMeshSubsystem. |
XRPlaneSubsystem | Provides methods, events, and properties that provides information about planes detected in the environment. |
XRPlaneSubsystemDescriptor | Class providing information about XRPlaneSubsystem registration. |
XRRaycastSubsystem | Provides methods and properties that allow for querying portions of the physical environment that are near a provided specified ray. These trackables include planes and depth data. |
XRRaycastSubsystemDescriptor | Class providing information about XRRaycastSubsystem registration. |
XRReferencePointSubsystem | Provides methods and properties that allow for querying, creating, and removing of reference points. These reference points are cues to the XRSessionSubsystem that indicate areas of interest in the environment which helps assure that tracking of these points remains accurate. |
XRReferencePointSubsystemDescriptor | Class providing information about XRReferencePointSubsystem registration. |
XRSessionSubsystem | A collection of methods and properties used to interact with and configure an XR session. |
XRSessionSubsystemDescriptor | Class providing information about XRSessionSubsystem registration. |
BoundedPlane | Structure describing a bounded plane representing a real-world surface. |
FrameReceivedEventArgs | Structure containing data passed during Frame Received Event. |
HapticCapabilities | Describes the haptic capabilities of the device at an XRNode in the XR input subsystem. |
InputDevice | Defines an input device in the XR input subsystem. |
MeshGenerationResult | Contains event information related to a generated mesh. |
MeshInfo | Contains state information related to a tracked mesh. |
PlaneAddedEventArgs | Contains data supplied to a XRPlaneSubsystem.PlaneAdded event. |
PlaneRemovedEventArgs | Contains data supplied to a XRPlaneSubsystem.PlaneRemoved event. |
PlaneUpdatedEventArgs | Contains data supplied to a XRPlaneSubsystem.PlaneUpdated event. |
PointCloudUpdatedEventArgs | Contains data supplied to a XRDepth.PointCloudUpdated event. |
ReferencePoint | Describes the transform data of a real-world point. |
ReferencePointUpdatedEventArgs | Data to be passed to the user when the device corrects its understanding of the world enough that the ReferencePoint's position or rotation has changed. |
SessionTrackingStateChangedEventArgs | Structure defining Tracking State Changed event arguments passed when tracking state changes. |
TrackableId | A session-unique identifier for trackables in the environment, e.g., planes and feature points. |
XRNodeState | Describes the state of a node tracked by a XR system. . |
XRRaycastHit | Structure describing the result of a XRRaycastSubsystem.Raycast hit. |
MeshChangeState | The state of a tracked mesh since the last query. |
MeshGenerationStatus | The status of a XRMeshSubsystem.GenerateMeshAsync. |
MeshVertexAttributes | A set of vertex attributes. |
PlaneAlignment | Describes current plane alignment in mixed reality space. |
TrackableType | A trackable is feature in the physical environment that a device is able to track, such as a plane. |
TrackingState | Current tracking state of the device. |
XRNode | Enumeration of XR nodes which can be updated by XR input or sent haptic data. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thanks for helping to make the Unity documentation better!