Back to Content

VRDisplay: displayId property

files/en-us/web/api/vrdisplay/displayid/index.md

latest1.6 KB
Original Source

{{APIRef("WebVR API")}}{{Deprecated_Header}}{{Non-standard_Header}}

The displayId read-only property of the {{domxref("VRDisplay")}} interface returns an identifier for this particular VRDisplay, which is also used as an association point in the Gamepad API (see {{domxref("Gamepad.displayId")}}).

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

Value

A number representing the ID of the specific VRDisplay.

Examples

See VRDisplayCapabilities for example code.

Specifications

This property 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

{{Compat}}

See also