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 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 vrdisplayactivate event of the WebVR 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 old WebVR API. It has been superseded by the WebXR Device API.

This event is not cancelable and does not bubble.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

js
addEventListener("vrdisplayactivate", (event) => {});

onvrdisplayactivate = (event) => {};

Event type

A VRDisplayEvent. Inherits from Event.

Event properties

VRDisplayEvent also inherits properties from its parent object, Event.

VRDisplayEvent.display Read only

The VRDisplay associated with this event.

VRDisplayEvent.reason Read only

A human-readable reason why the event was fired.

Examples

You can use the vrdisplayactivate event in an addEventListener method:

js
window.addEventListener("vrdisplayactivate", () => {
  info.textContent = "Display activated.";
  reportDisplays();
});

Or use the onvrdisplayactivate event handler property:

js
window.onvrdisplayactivate = () => {
  info.textContent = "Display activated.";
  reportDisplays();
};

Specifications

This event 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 Device API, 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

BCD tables only load in the browser

See also