class in UnityEngine.XR
/
Implemented in:UnityEngine.VRModule
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. |
gameViewRenderMode | Sets 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. |
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 | This property has been deprecated. Use XRSettings.gameViewRenderMode instead. |
stereoRenderingMode | The stereo rendering mode that is currently in use. |
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. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thanks for helping to make the Unity documentation better!