Version: 2020.2
LanguageEnglish
  • C#

XRSettings

class in UnityEngine.XR

/

Implemented in:UnityEngine.VRModule

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

deviceEyeTextureDimensionFetch the device eye texture dimension from the active stereo device.
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.
gameViewRenderModeSets the render mode for the XR device. The render mode controls how the view of the XR device renders in the Game view and in the main window on a host PC.
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.
showDeviceViewThis property has been deprecated. Use XRSettings.gameViewRenderMode instead.
stereoRenderingModeThe stereo rendering mode that is currently in use.
supportedDevicesReturns a list of supported XR devices that were included at build time.
useOcclusionMeshSpecifies whether or not the occlusion mesh should be used when rendering. Enabled by default.

Static Methods

LoadDeviceByNameLoads the requested device at the beginning of the next frame.
Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961