Window.onvrdisplaypointerrestricted

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 onvrdisplaypointerrestricted property of the Window interface represents an event handler that will run when the VR display's pointer input is restricted to consumption via a pointerlocked element.

Note: This event handler was part of the old WebVR API. It has been superseded by the WebXR Device API.

The event object is of type VRDisplayEvent.

Syntax

window.onvrdisplaypointerrestricted = functionRef;

Examples

window.onvrdisplaypointerrestricted = function() {
  // Run code to handle pointer lock
};

Specifications

This event handler 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 Device API, 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

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
onvrdisplaypointerrestricted
No
15-79
No
No
No
No
No
No
No
No
No
No

See also

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Window/onvrdisplaypointerrestricted