W3cubDocs

/DOM

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.	Draft	Initial definition

Browser compatibilityUpdate compatibility data on GitHub

	Desktop
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari
Basic support	No	15	55 55 Windows support was enabled in Firefox 55. 63 macOS support was enabled in Firefox 63.	No	?	?

	Mobile
	Android webview	Chrome for Android	Edge Mobile	Firefox for Android	Opera for Android	iOS Safari	Samsung Internet
Basic support	No	56 Disabled 56 Disabled Only works in an experimental version of Chrome. (Other builds won't return any devices when `Navigator.getVRDisplays()` is invoked.) Daydream View supported in Chrome 56. Google Cardboard supported in Chrome 57. Disabled From version 56: this feature is behind the `WebVR` preference. To change preferences in Chrome, visit chrome://flags.	?	?	?	?	6.0

VRDisplay.ispresenting

Syntax

Value

Examples

Specifications

Browser compatibilityUpdate compatibility data on GitHub

See also