VRDisplayEvent: VRDisplayEvent() constructor
Deprecated
Avoid using this feature in new projects. Development of the WebVR API halted in favor of WebXR. This feature may be a candidate for removal from web standards or browsers.
Consider using the following features instead: WebXR.
Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.
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, orvrdisplaypresentchange. options-
An object that, in addition of the properties defined in
Event(), can have the following properties:display-
The
VRDisplaythe 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. Read Meta's Porting from WebVR to WebXR guide for more information.