Window: vrdisplayactivate event

{{APIRef("Window")}}{{Deprecated_Header}}{{Non-standard_Header}}

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 {{domxref("EventTarget.addEventListener", "addEventListener()")}}, or set an event handler property.

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

onvrdisplayactivate = (event) => { }

Event type

A {{domxref("VRDisplayEvent")}}. Inherits from {{domxref("Event")}}.

{{InheritanceDiagram("VRDisplayEvent")}}

Event properties

VRDisplayEvent also inherits properties from its parent object, {{domxref("Event")}}.

• {{domxref("VRDisplayEvent.display")}} {{Deprecated_Inline}} {{ReadOnlyInline}}
  • : The {{domxref("VRDisplay")}} associated with this event.
• {{domxref("VRDisplayEvent.reason")}} {{Deprecated_Inline}} {{ReadOnlyInline}}
  • : A human-readable reason why the event was fired.

Examples

You can use the vrdisplayactivate event in an addEventListener method:

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

Or use the onvrdisplayactivate event handler property:

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

{{Compat}}

See also

• WebVR API