This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The VRDisplayCapabilities
interface of the WebVR API describes the capabilities of a VRDisplay
— its features can be used to perform VR device capability tests, for example can it return position information.
This interface is accessible through the VRDisplay.capabilities
property.
Properties
VRDisplayCapabilities.canPresent
Read only- Returns a
Boolean
stating whether the VR display is capable of presenting content (e.g. through an HMD). VRDisplayCapabilities.hasExternalDisplay
Read only- Returns a
Boolean
stating whether the VR display is separate from the device's primary display. VRDisplayCapabilities.hasOrientation
Read only- Returns a
Boolean
stating whether the VR display can track and return orientation information. VRDisplayCapabilities.hasPosition
Read only- Returns a
Boolean
stating whether the VR display can track and return position information. VRDisplayCapabilities.maxLayers
Read only- Returns a number indicating the maximum number of
VRLayer
s that the VR display can present at once (e.g. the maximum length of the array thatVRDisplay.requestPresent()
can accept.)
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 'VRDisplayCapabilities' in that specification. |
Editor's Draft | Initial definition |
Browser compatibility
Feature | Chrome | Edge | Firefox | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|---|
Basic support | Yes1 2 | Yes | 553 584 | No | ? | ? |
canPresent | Yes1 2 | Yes | 553 584 | No | ? | ? |
hasExternalDisplay | Yes1 2 | Yes | 553 584 | No | ? | ? |
hasPosition | Yes1 2 | Yes | 553 584 | No | ? | ? |
hasOrientation | Yes1 2 | Yes | 553 584 | No | ? | ? |
maxLayers | 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 | ? | ? |
canPresent | No | Yes5 | ? | ? | No | ? | ? |
hasExternalDisplay | No | Yes5 | ? | ? | No | ? | ? |
hasPosition | No | Yes5 | ? | ? | No | ? | ? |
hasOrientation | No | Yes5 | ? | ? | No | ? | ? |
maxLayers | 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.
See also
- WebVR API homepage
- MozVr.com — demos, downloads, and other resources from the Mozilla VR team.