VRDisplayEvent
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 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 interface of the WebVR API represents the event object of WebVR-related events (see the list of WebVR window extensions).
Note: This interface was part of the old WebVR API. It has been superseded by the WebXR Device API.
Constructor
VRDisplayEvent()-
Creates a
VRDisplayEventobject instance.
Instance properties
VRDisplayEvent also inherits properties from its parent object, Event.
VRDisplayEvent.displayRead only-
The
VRDisplayassociated with this event. VRDisplayEvent.reasonRead only-
A human-readable reason why the event was fired.
Examples
window.addEventListener("vrdisplaypresentchange", (e) => {
console.log(
`Display ${e.display.displayId} presentation has changed. Reason given: ${e.reason}.`,
);
});
Specifications
This interface 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.
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
VRDisplayEvent
|
|
|
|
|
|
|
|
|
|
|
|
|
VRDisplayEvent() constructor
|
|
|
|
|
|
|
|
|
|
|
|
|
display
|
|
|
|
|
|
|
|
|
|
|
|
|
reason
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- Non-standard. Check cross-browser support before using.
- Deprecated. Not for use in new websites.
- See implementation notes.
- User must explicitly enable this feature.
- Has more compatibility info.