Window: vrdisplaypointerrestricted event

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 vrdisplaypointerrestricted event of the WebVR API is fired when the VR display's pointer input is restricted to consumption via a pointerlocked element.

Bubbles No
Cancelable No
Interface VRDisplayEvent
Event handler property onvrdisplaypointerrestricted

Examples

You can use the vrdisplaypointerrestricted event in an addEventListener method:

window.addEventListener('vrdisplaypointerrestricted', function() {
  // Run code to handle pointer lock
});

Or use the onvrdisplaypointerrestricted event handler property:

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

Specifications

Specification Status Comment
WebVR 1.1
The definition of 'vrdisplaypointerrestricted' in that specification.
Draft Initial definition

Browser compatibility

BCD tables only load in the browser

See also