Legacy Documentation: Version 2017.2 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

XRSettings

class in UnityEngine.XR

Suggest a change

Success!

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.

Close

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.

Close

Cancel

Description

Global XR related settings.

Static Properties

enabledGlobally enables or disables XR for the application.
eyeTextureDescFetch the eye texture RenderTextureDescriptor from the active stereo device.
eyeTextureHeightThe current height of an eye texture for the loaded device.
eyeTextureResolutionScaleControls the actual size of eye textures as a multiplier of the device's default resolution.
eyeTextureWidthThe current width of an eye texture for the loaded device.
isDeviceActiveRead-only value that can be used to determine if the XR device is active.
loadedDeviceNameType of XR device that is currently loaded.
occlusionMaskScaleA scale applied to the standard occulsion mask for each platform.
renderViewportScaleControls how much of the allocated eye texture should be used for rendering.
showDeviceViewMirror what is shown on the device to the main display, if possible.
supportedDevicesReturns a list of supported XR devices that were included at build time.

Static Methods

LoadDeviceByNameLoads the requested device at the beginning of the next frame.

Did you find this page useful? Please give it a rating: