Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


isDeviceActive

Read-only value that can be used to determine if the XR device is active.
Read time 1 minuteLast updated 12 days ago

Definition

  • Type: Property
  • Namespace: UnityEngine.XR
  • Assembly: UnityEngine.XRModule
public static bool isDeviceActive { get; }

Remarks

When true, Unity accepts input from the device and attempts to render to the device's display(s). Note that this returns true even if the device is not currently rendering due to lack of user presence (see userPresence). This can become false if a device is disconnected, could not be initialized (see XRSettings.LoadDeviceByName), or XRSettings.enabled is set to false.
XR output is automatically mirrored to the main display (if applicable). This can be controlled with XRSettings.showDeviceView.
The main window is still controlled by Screen and related APIs.