Window: vrdisplayactivate 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 thecompatibility 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.
Thevrdisplayactivate event of theWebVR API is fired when a VR display is able to be presented to, for example if an HMD has been moved to bring it out of standby, or woken up by being put on.
Note:This event was part of the oldWebVR API. It has been superseded by theWebXR Device API.
This event is not cancelable and does not bubble.
Syntax
Use the event name in methods likeaddEventListener(), or set an event handler property.
addEventListener("vrdisplayactivate", (event) => { })onvrdisplayactivate = (event) => { }Event type
AVRDisplayEvent. Inherits fromEvent.
Event properties
VRDisplayEvent also inherits properties from its parent object,Event.
VRDisplayEvent.displayDeprecatedRead onlyThe
VRDisplayassociated with this event.VRDisplayEvent.reasonDeprecatedRead onlyA human-readable reason why the event was fired.
Examples
You can use thevrdisplayactivate event in anaddEventListener method:
window.addEventListener("vrdisplayactivate", () => { info.textContent = "Display activated."; reportDisplays();});Or use theonvrdisplayactivate event handler property:
window.onvrdisplayactivate = () => { info.textContent = "Display activated."; reportDisplays();};Specifications
This event was part of the oldWebVR API that has been superseded by theWebXR Device API. It is no longer on track to becoming a standard.
Until all browsers have implemented the newWebXR Device API, it is recommended to rely on frameworks, likeA-Frame,Babylon.js, orThree.js, or apolyfill, to develop WebXR applications that will work across all browsers. ReadMeta's Porting from WebVR to WebXR guide for more information.