Gamepad.displayId
Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.
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 VRDisplay.pose
.
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", function(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 [1].
Browser compatibility
BCD tables only load in the browser
See also
- WebVR API homepage
- https://mixedreality.mozilla.org/ — demos, downloads, and other resources from the Mozilla VR team.