Gamepad: displayId property
Deprecated
Avoid using this feature in new projects. Development of the WebVR API halted in favor of WebXR. This feature may be a candidate for removal from web standards or browsers.
Consider using the following features instead: WebXR.
Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.
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.