Legacy Documentation: Version 5.4
LanguageEnglish
  • C#
  • JS

Script language

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

VRSettings.enabled

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static var enabled: bool;
public static bool enabled;

Description

Globally enables or disables VR for the application.

When enabled, we are accepting input from the device and rendering to the device. This can become false if a device is disconnected or a device could not be intialized (see VRSettings.LoadDeviceByName).

VR output is automatically mirrored to the main display (if applicable). This can be controlled with VRSettings.showDeviceView.

The main window is still controlled by Screen and related APIs.