This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The canPresent
read-only property of the VRDisplayCapabilities
interface returns a Boolean
stating whether the VR display is capable of presenting content (e.g. through an HMD).
This is useful for identifying "magic window" devices that are capable of 6DoF tracking but for which VRDisplay.requestPresent()
is not meaningful. If canPresent
is false
, calls to VRDisplay.requestPresent()
will fail, and VRDisplay.getEyeParameters()
will return null
.
var canIPresent = vrDisplayCapabilitiesInstance.canPresent;
A Boolean
.
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); } }); }
Specification | Status | Comment |
---|---|---|
WebVR 1.1 The definition of 'canPresent' in that specification. | Editor's Draft | Initial definition |
Feature | Chrome | Edge | Firefox | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|---|
Basic support | Yes1 2 | Yes |
553 584 |
No | ? | ? |
Feature | Android webview | Chrome for Android | Edge mobile | Firefox for Android | IE mobile | Opera Android | iOS Safari |
---|---|---|---|---|---|---|---|
Basic support | No | Yes5 | ? | ? | No | ? | ? |
1. Only works on desktop in an experimental version of Chrome (other builds won't return any devices when Navigator.getVRDisplays()
is invoked).
2. This feature is behind the WebVR
preference. To change preferences in Chrome, visit chrome://flags.
3. Windows support was enabled in Firefox 55.
4. macOS support was enabled in Firefox 58.
5. Currently supported only by Google Daydream.
© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/VRDisplayCapabilities/canPresent