VRDisplayCapabilities

Experimental

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 VRLayers that the VR display can present at once (e.g. the maximum length of the array that VRDisplay.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.	Draft	Initial definition

Browser compatibility

BCD tables only load in the browser