Version: 2018.4

XRSettings

class in UnityEngine.XR

Switch to Manual

Description

Global XR related settings.

Static Variables

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 Functions

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