W3cubDocs

VRDisplayEvent: VRDisplayEvent() constructor

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 VRDisplayEvent() constructor creates a VRDisplayEvent object.

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

Syntax

new VRDisplayEvent(type, options)

Parameters

type

A string with the name of the event. It is case-sensitive and browsers set it to vrdisplayconnect, vrdisplaydisconnect, vrdisplayactivate, vrdisplaydeactivate, vrdisplayblur, vrdisplaypointerrestricted, vrdisplaypointerunrestricted, or vrdisplaypresentchange.

options

An object that, in addition of the properties defined in Event(), can have the following properties:

display: The VRDisplay the event is to be associated with.
reason: A string representing the human-readable reason why the event is to be fired (see VRDisplayEvent.reason).

Return value

A new VRDisplayEvent object.

Examples

const myEventObject = new VRDisplayEvent("custom", {
  display: vrDisplay,
  reason: "Custom reason",
});

Specifications

This constructor 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