MDN self-hosted library · e01.org

Gamepad: displayId property

WebVR API

Open notebook · 1 cells web-api-instance-property upstream source

WebVR API

The displayId read-only property of the Gamepad interface returns the VRDisplay.displayId of the associated VRDisplay — the VRDisplay that the gamepad is controlling the displayed scene of.

A Gamepad is considered to be associated with a VRDisplay if it reports a pose that is in the same space as the display's pose, see VRDisplay.getPose().

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

There is no direct replacement for this property. The Gamepad object associated with an XRInputSource can be obtained using the XRInputSource.gamepad property.

Value

A number representing the associated VRDisplay.displayId. If the number is 0, then the gamepad is not associated with a VR display.

Examples

window.addEventListener("gamepadconnected", (e) => {
  if (!e.gamepad.displayId) {
    console.log("Gamepad connected");
  } else {
    console.log(
      `Gamepad connected, associated with VR display ${e.gamepad.displayId}`,
    );
  }
});

Specifications

This property was part of the old WebVR API that has been superseded by the WebXR Gamepads Module. 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

See also