This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The hasExternalDisplay read-only property of the VRDisplayCapabilities interface returns a Boolean stating whether 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.
Examples
function reportDisplays() {
navigator.getVRDisplays().then(function(displays) {
for(var i = 0; i < displays.length; i++) {
var cap = displays[i].capabilities;
// cap is a VRDisplayCapabilities object
var listItem = document.createElement('li');
listItem.innerHTML = '<strong>Display ' + (i+1) + '</strong>'
+ '<br>VR Display ID: ' + displays[i].displayId
+ '<br>VR Display Name: ' + displays[i].displayName
+ '<br>Display can present content: ' + cap.canPresent
+ '<br>Display is separate from the computer\'s main display: ' + cap.hasExternalDisplay
+ '<br>Display can return position info: ' + cap.hasPosition
+ '<br>Display can return orientation info: ' + cap.hasOrientation
+ '<br>Display max layers: ' + cap.maxLayers;
list.appendChild(listItem);
}
});
}
Specifications
| Specification | Status | Comment |
|---|---|---|
| WebVR 1.1 The definition of 'hasExternalDisplay' in that specification. |
Draft | Initial definition |
Browser compatibility
| Feature | Chrome | Edge | Firefox | Internet Explorer | Opera | Safari |
|---|---|---|---|---|---|---|
| Basic support | No | 15 | 555 606 | No | ? | ? |
| Feature | Android webview | Chrome for Android | Edge mobile | Firefox for Android | Opera Android | iOS Safari | Samsung Internet |
|---|---|---|---|---|---|---|---|
| Basic support | No | 561 2 3 4 | ? | ? | ? | ? | 6.0 |
1. Only works in an experimental version of Chrome. (Other builds won't return any devices when Navigator.getVRDisplays() is invoked.)
2. Daydream View supported in Chrome 56.
3. Google Cardboard supported in Chrome 57.
4. From version 56: this feature is behind the WebVR preference. To change preferences in Chrome, visit chrome://flags.
5. Windows support was enabled in Firefox 55.
6. macOS support was enabled in Firefox 60.
See also
- WebVR API homepage
- MozVr.com — demos, downloads, and other resources from the Mozilla VR team.