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
.
Syntax
var myDisplayId = gamepadInstance.displayId;
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
Specification | Status | Comment |
---|---|---|
WebVR 1.1 The definition of 'displayId' in that specification. |
Draft | Initial definition |
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.