Select your preferred scripting language. All code snippets will be displayed in this language.
class in UnityEngine.XR
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.
CloseGlobal XR related settings.
enabled | Globally enables or disables XR for the application. |
eyeTextureDesc | Fetch the eye texture RenderTextureDescriptor from the active stereo device. |
eyeTextureHeight | The current height of an eye texture for the loaded device. |
eyeTextureResolutionScale | Controls the actual size of eye textures as a multiplier of the device's default resolution. |
eyeTextureWidth | The current width of an eye texture for the loaded device. |
isDeviceActive | Read-only value that can be used to determine if the XR device is active. |
loadedDeviceName | Type of XR device that is currently loaded. |
occlusionMaskScale | A scale applied to the standard occulsion mask for each platform. |
renderViewportScale | Controls how much of the allocated eye texture should be used for rendering. |
showDeviceView | Mirror what is shown on the device to the main display, if possible. |
supportedDevices | Returns a list of supported XR devices that were included at build time. |
useOcclusionMesh | Specifies whether or not the occlusion mesh should be used when rendering. Enabled by default. |
LoadDeviceByName | Loads the requested device at the beginning of the next frame. |