Back to Content

Window: vrdisplaydisconnect event

files/en-us/web/api/window/vrdisplaydisconnect_event/index.md

latest2.5 KB
Original Source

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

The vrdisplaydisconnect event of the WebVR API is fired when a compatible VR display is disconnected from the computer.

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.

js-nolint
addEventListener("vrdisplaydisconnect", (event) => { })

onvrdisplaydisconnect = (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 vrdisplaydisconnect event in an addEventListener method:

[!NOTE] This event was part of the old WebVR API. It has been superseded by the WebXR Device API.

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

Or use the onvrdisplaydisconnect event handler property:

js
window.onvrdisplaydisconnect = () => {
  info.textContent = "Display disconnected.";
  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