VRDisplay: isPresenting property
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.
Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.
The isPresenting
read-only property of the VRDisplay
interface returns a boolean value indicating whether the VRDisplay
is currently having content presented through it.
Note: This property was part of the old WebVR API. It has been superseded by the WebXR Device API.
Value
A boolean value; true
means the display is presenting; false
means it isn't.
Examples
js
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(
() => {
// Nothing to do because we're handling things in onVRPresentChange.
},
(err) => {
let 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
This property was part of the old WebVR API that has been superseded by the WebXR Device API. It is no longer on track to becoming a standard.
Until all browsers have implemented the new WebXR APIs, it is recommended to rely on frameworks, like A-Frame, Babylon.js, or Three.js, or a polyfill, to develop WebXR applications that will work across all browsers [1].
Browser compatibility
BCD tables only load in the browser
See also
- WebVR API homepage
- https://mixedreality.mozilla.org/ — demos, downloads, and other resources from the Mozilla VR team.