Legacy Documentation: Version 5.5
LanguageEnglish
  • C#
  • JS

Script language

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

VRSettings

class in UnityEngine.VR

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 VR related settings.

Static Variables

enabledGlobally enables or disables VR for the application.
eyeTextureHeightThe current height of an eye texture for the loaded device.
eyeTextureWidthThe current width of an eye texture for the loaded device.
isDeviceActiveRead-only value that can be used to determine if the VR device is active.
loadedDeviceNameType of VR device that is currently loaded.
renderScaleControls the texel:pixel ratio before lens correction, trading performance for sharpness.
renderViewportScaleControls the texel:pixel ratio before lens correction, trading performance for sharpness.
showDeviceViewMirror what is shown on the device to the main display, if possible.
supportedDevicesReturns a list of supported VR devices that were included at build time.

Static Functions

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