VRDisplayCapabilities.canPresent

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.

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.

Syntax

var canIPresent = vrDisplayCapabilitiesInstance.canPresent;

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 'canPresent' in that specification.		 Draft Initial definition

Browser compatibility

BCD tables only load in the browser

See also