Version: Unity 6.6 (6000.6)
LanguageEnglish
  • C#

XRSettings.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

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

public static bool enabled;

Description

Indicates whether Unity loaded and initialized the XR display subsystem.

This property is read-only. Its setter is obsolete and causes a compilation error. To start or stop XR at runtime, call Start or Stop on an XRDisplaySubsystem instance instead. In a project that uses the XR Plug-in Management package, manage the loader lifecycle through that package rather than calling these methods directly.

This property reports the loaded state, not the running state. It stays true after you stop the display subsystem, and becomes false only when Unity destroys that subsystem. To test whether XR is currently running, use XRSettings.isDeviceActive.