Version: 2019.2
  • C#


class in UnityEngine.XR


Implemented in:UnityEngine.VRModule

Suggest a change


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.


Submission failed

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




Contains all functionality related to a XR device.

Static Properties

fovZoomFactorZooms the XR projection.
isPresentSuccessfully detected a XR device in working order.
modelSpecific model of loaded XR device.
refreshRateRefresh rate of the display in Hertz.
trackingOriginModeReturns the devices TrackingOriginType.
userPresenceIndicates whether the user is present and interacting with the device.

Static Methods

DisableAutoXRCameraTrackingSets whether the camera passed in the first parameter is controlled implicitly by the XR Device
GetNativePtrThis method returns an IntPtr representing the native pointer to the XR device if one is available, otherwise the value will be IntPtr.Zero.
GetTrackingSpaceTypeReturns the device's current TrackingSpaceType. This value determines how the camera is positioned relative to its starting position. For more, see the section "Understanding the camera" in VROverview.
SetTrackingSpaceTypeSets the device's current TrackingSpaceType. Returns true on success. Returns false if the given TrackingSpaceType is not supported or the device fails to switch.
UpdateEyeTextureMSAASettingRecreates the XR platform's eye texture swap chain with the appropriate anti-aliasing sample count. The reallocation of the eye texture will only occur if the MSAA quality setting's sample count is different from the sample count of the current eye texture. Reallocations of the eye textures will happen at the beginning of the next frame. This is an expensive operation and should only be used when necessary.


deviceLoadedSubscribe a delegate to this event to get notified when an XRDevice is successfully loaded.