VRDisplay.isPresenting

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The isPresenting read-only property of the VRDisplay interface returns a Boolean indicating whether the VRDisplay is currently having content presented through it.

Syntax

var isItPresenting = vrDisplayInstance.isPresenting;

Value

A Boolean; true means the display is presenting; false means it isn't.

Examples

function onVRExitPresent () {
  // No sense in exiting presentation if we're not actually presenting.
  // (This may happen if we get an event like vrdisplaydeactivate when
  // we weren't presenting.)
  if (!vrDisplay.isPresenting)
    return;
  vrDisplay.exitPresent().then(function () {
    // Nothing to do because we're handling things in onVRPresentChange.
  }, function (err) {
    var errMsg = "exitPresent failed.";
    if (err && err.message) {
      errMsg += "<br/>" + err.message
    }
    VRSamplesUtil.addError(errMsg, 2000);
  });
}

Note: Code snippet taken from Google's VR Presentation demo.

Specifications

Specification Status Comment
WebVR 1.1
The definition of 'isPresenting' in that specification.
Editor's Draft Initial definition

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support Yes1 2 Yes

553

584

No ? ?
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidIE mobileOpera AndroidiOS 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.

See also

Document Tags and Contributors

 Contributors to this page: fscholz, chrisdavidmills, abbycar
 Last updated by: fscholz,