This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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
| Feature | Chrome | Edge | Firefox | Internet Explorer | Opera | Safari |
|---|---|---|---|---|---|---|
| Basic support | Yes1 2 | 15 | 564 | No | ? | ? |
| Feature | Android webview | Chrome for Android | Edge mobile | Firefox for Android | Opera Android | iOS Safari | Samsung Internet |
|---|---|---|---|---|---|---|---|
| Basic support | No | Yes3 | ? | ? | ? | ? | Yes |
1. Only works on desktop in an experimental version of Chrome (other builds won't return any devices when Navigator.getVRDisplays() is invoked).
2. This feature is behind the WebVR preference. To change preferences in Chrome, visit chrome://flags.
3. Currently supported only by Google Daydream.
4. Currently only Windows support is enabled by default. Mac support is available in Firefox Nightly.
See also
- WebVR API homepage
- MozVr.com — demos, downloads, and other resources from the Mozilla VR team.