VRDisplayCapabilities.hasExternalDisplay

Deprecated

This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

Note: This property was part of the old WebVR API. It has been superseded by the WebXR Device API.

The hasExternalDisplay read-only property of the VRDisplayCapabilities interface returns true if the VR display is separate from the device's primary display.

Note: If presenting VR content would obscure other content on the device, this will return false, in which case the application should not attempt to mirror VR content or update non-VR UI because that content will not be visible.

Syntax

var hasAnExternalDisplay = vrDisplayCapabilitiesInstance.hasExternalDisplay;

Value

A boolean value.

Examples

See VRDisplayCapabilities for example code.

Specifications

This property was part of the old WebVR API that has been superseded by the WebXR Device API. It is no longer on track to becoming a standard.

Until all browsers have implemented the new WebXR APIs, it is recommended to rely on frameworks, like A-Frame, Babylon.js, or Three.js, or a polyfill, to develop WebXR applications that will work across all browsers [1].

Browser compatibility

BCD tables only load in the browser

See also