The Gamepad
interface of the Gamepad API defines an individual gamepad or other controller, allowing access to information such as button presses, axis positions, and id.
A Gamepad object can be returned in one of two ways: via the gamepad
property of the gamepadconnected
and gamepaddisconnected
events, or by grabbing any position in the array returned by the Navigator.getGamepads()
method.
Properties
Gamepad.displayId
Read only
- Returns the
VRDisplay.displayId
of an associated VRDisplay
(if relevant) — the VRDisplay
that the gamepad is controlling the displayed scene of.
Gamepad.id
Read only
- A
DOMString
containing identifying information about the controller.
Gamepad.index
Read only
- An integer that is auto-incremented to be unique for each device currently connected to the system.
Gamepad.mapping
Read only
- A string indicating whether the browser has remapped the controls on the device to a known layout.
Gamepad.connected
Read only
- A boolean indicating whether the gamepad is still connected to the system.
Gamepad.buttons
Read only
- An array of
gamepadButton
objects representing the buttons present on the device.
Gamepad.axes
Read only
- An array representing the controls with axes present on the device (e.g. analog thumb sticks).
Gamepad.timestamp
Read only
- A
DOMHighResTimeStamp
representing the last time the data for this gamepad was updated.
Experimental extensions to Gamepad
The following interfaces are defined in the Gamepad Extensions specification, and provide access to experimental features like haptic feedback and WebVR controller pose information.
Gamepad.hand
Read only
- An enum defining what hand the controller is being held in, or is most likely to be held in.
Gamepad.hapticActuators
Read only
- An array containing
GamepadHapticActuator
objects, each of which represents haptic feedback hardware available on the controller.
Gamepad.pose
Read only
- A
GamepadPose
object representing the pose information associated with a WebVR controller (e.g. its position and orientation in 3D space).
Example
window.addEventListener("gamepadconnected", function(e) {
console.log("Gamepad connected at index %d: %s. %d buttons, %d axes.",
e.gamepad.index, e.gamepad.id,
e.gamepad.buttons.length, e.gamepad.axes.length);
});
Specifications
Browser compatibility
Feature | Android webview | Chrome for Android | Edge mobile | Firefox for Android | IE mobile | Opera Android | iOS Safari |
---|
Basic support |
No |
Yes |
Yes | 32 |
No |
No |
No |
axes |
No |
Yes |
Yes | 32 |
No |
No |
No |
buttons |
No |
Yes |
Yes | 32 |
No |
No |
No |
connected |
No |
Yes |
Yes | 32 |
No |
No |
No |
displayId |
No |
Yes5 |
? |
? |
No |
? |
? |
hand |
No |
No |
No |
No |
No |
No |
No |
hapticActuators |
No |
No |
No |
No |
No |
No |
No |
id |
No |
Yes |
Yes | 32 |
No |
No |
No |
index |
No |
Yes |
Yes | 32 |
No |
No |
No |
mapping |
No |
Yes |
Yes | 32 |
No |
No |
No |
pose |
No |
No |
No |
No |
No |
No |
No |
timestamp |
No |
Yes |
Yes | 32 |
No |
No |
No |
1. From version 24 until version 28 (exclusive): this feature is behind the dom.gamepad.enabled
preference (needs to be set to true
). To change preferences in Firefox, visit about:config.
2. Only works on desktop in an experimental version of Chrome (other builds won't return any devices when Navigator.getVRDisplays()
is invoked).
3. This feature is behind the WebVR
preference. To change preferences in Chrome, visit chrome://flags.
4. Currently only Windows support is enabled by default. Mac support is available in Firefox Nightly.
5. Currently supported only by Google Daydream.
6. The flag is enabled by default in Firefox Nightly and Beta, versions 55 and above.
7. This feature is behind the dom.gamepad-extensions.enabled
preference (needs to be set to true
). To change preferences in Firefox, visit about:config.
| Desktop | Mobile |
---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | Android webview | Chrome for Android | Edge Mobile | Firefox for Android | IE mobile | Opera for Android | iOS Safari |
---|
Basic support |
Full support
35-
Full support
35
-
No support
21 — 34
- Prefixed Requires the vendor prefix: webkit
|
Full support
Yes |
Full support
29-
Full support
29
-
No support
24 — 28
- Disabled From version 24 until version 28 (exclusive): this feature is behind the
dom.gamepad.enabled preference (needs to be set to true ). To change preferences in Firefox, visit about:config.
|
No support
No |
Full support
22-
Full support
22
-
No support
15 — 21
- Prefixed Requires the vendor prefix: webkit
|
No support
No |
No support
No |
Full support
Yes |
Full support
Yes |
Full support
32 |
No support
No |
No support
No |
No support
No |
---|
axes |
Full support
35-
Full support
35
-
No support
21 — 34
- Prefixed Requires the vendor prefix: webkit
|
Full support
Yes |
Full support
29-
Full support
29
-
No support
24 — 28
- Disabled From version 24 until version 28 (exclusive): this feature is behind the
dom.gamepad.enabled preference (needs to be set to true ). To change preferences in Firefox, visit about:config.
|
No support
No |
Full support
22-
Full support
22
-
No support
15 — 21
- Prefixed Requires the vendor prefix: webkit
|
No support
No |
No support
No |
Full support
Yes |
Full support
Yes |
Full support
32 |
No support
No |
No support
No |
No support
No |
---|
buttons |
Full support
35-
Full support
35
-
No support
21 — 34
- Prefixed Requires the vendor prefix: webkit
|
Full support
Yes |
Full support
29-
Full support
29
-
No support
24 — 28
- Disabled From version 24 until version 28 (exclusive): this feature is behind the
dom.gamepad.enabled preference (needs to be set to true ). To change preferences in Firefox, visit about:config.
|
No support
No |
Full support
22-
Full support
22
-
No support
15 — 21
- Prefixed Requires the vendor prefix: webkit
|
No support
No |
No support
No |
Full support
Yes |
Full support
Yes |
Full support
32 |
No support
No |
No support
No |
No support
No |
---|
connected |
Full support
35-
Full support
35
-
No support
21 — 34
- Prefixed Requires the vendor prefix: webkit
|
Full support
Yes |
Full support
29-
Full support
29
-
No support
24 — 28
- Disabled From version 24 until version 28 (exclusive): this feature is behind the
dom.gamepad.enabled preference (needs to be set to true ). To change preferences in Firefox, visit about:config.
|
No support
No |
Full support
22-
Full support
22
-
No support
15 — 21
- Prefixed Requires the vendor prefix: webkit
|
No support
No |
No support
No |
Full support
Yes |
Full support
Yes |
Full support
32 |
No support
No |
No support
No |
No support
No |
---|
displayId |
Full support
Yes-
Full support
Yes
- Notes Only works on desktop in an experimental version of Chrome (other builds won't return any devices when
Navigator.getVRDisplays() is invoked). - Disabled This feature is behind the
WebVR preference. To change preferences in Chrome, visit chrome://flags.
|
Full support
Yes |
Full support
56-
Full support
56
- Notes Currently only Windows support is enabled by default. Mac support is available in Firefox Nightly.
|
No support
No |
?
|
?
|
No support
No |
Full support
Yes-
Full support
Yes
- Notes Currently supported only by Google Daydream.
|
?
|
?
|
No support
No |
?
|
?
|
---|
hand |
No support
No |
No support
No |
Full support
Yes-
Full support
Yes
- Notes The flag is enabled by default in Firefox Nightly and Beta, versions 55 and above.
- Disabled This feature is behind the
dom.gamepad-extensions.enabled preference (needs to be set to true ). To change preferences in Firefox, visit about:config.
|
No support
No |
No support
No |
No support
No |
No support
No |
No support
No |
No support
No |
No support
No |
No support
No |
No support
No |
No support
No |
---|
hapticActuators |
No support
No |
No support
No |
Full support
Yes-
Full support
Yes
- Notes The flag is enabled by default in Firefox Nightly and Beta, versions 55 and above.
- Disabled This feature is behind the
dom.gamepad-extensions.enabled preference (needs to be set to true ). To change preferences in Firefox, visit about:config.
|
No support
No |
No support
No |
No support
No |
No support
No |
No support
No |
No support
No |
No support
No |
No support
No |
No support
No |
No support
No |
---|
id |
Full support
35-
Full support
35
-
No support
21 — 34
- Prefixed Requires the vendor prefix: webkit
|
Full support
Yes |
Full support
29-
Full support
29
-
No support
24 — 28
- Disabled From version 24 until version 28 (exclusive): this feature is behind the
dom.gamepad.enabled preference (needs to be set to true ). To change preferences in Firefox, visit about:config.
|
No support
No |
Full support
22-
Full support
22
-
No support
15 — 21
- Prefixed Requires the vendor prefix: webkit
|
No support
No |
No support
No |
Full support
Yes |
Full support
Yes |
Full support
32 |
No support
No |
No support
No |
No support
No |
---|
index |
Full support
35-
Full support
35
-
No support
21 — 34
- Prefixed Requires the vendor prefix: webkit
|
Full support
Yes |
Full support
29-
Full support
29
-
No support
24 — 28
- Disabled From version 24 until version 28 (exclusive): this feature is behind the
dom.gamepad.enabled preference (needs to be set to true ). To change preferences in Firefox, visit about:config.
|
No support
No |
Full support
22-
Full support
22
-
No support
15 — 21
- Prefixed Requires the vendor prefix: webkit
|
No support
No |
No support
No |
Full support
Yes |
Full support
Yes |
Full support
32 |
No support
No |
No support
No |
No support
No |
---|
mapping |
Full support
35-
Full support
35
-
No support
21 — 34
- Prefixed Requires the vendor prefix: webkit
|
Full support
Yes |
Full support
29-
Full support
29
-
No support
24 — 28
- Disabled From version 24 until version 28 (exclusive): this feature is behind the
dom.gamepad.enabled preference (needs to be set to true ). To change preferences in Firefox, visit about:config.
|
No support
No |
Full support
22-
Full support
22
-
No support
15 — 21
- Prefixed Requires the vendor prefix: webkit
|
No support
No |
No support
No |
Full support
Yes |
Full support
Yes |
Full support
32 |
No support
No |
No support
No |
No support
No |
---|
pose |
No support
No |
No support
No |
Full support
Yes-
Full support
Yes
- Notes The flag is enabled by default in Firefox Nightly and Beta, versions 55 and above.
- Disabled This feature is behind the
dom.gamepad-extensions.enabled preference (needs to be set to true ). To change preferences in Firefox, visit about:config.
|
No support
No |
No support
No |
No support
No |
No support
No |
No support
No |
No support
No |
No support
No |
No support
No |
No support
No |
No support
No |
---|
timestamp |
Full support
35-
Full support
35
-
No support
21 — 34
- Prefixed Requires the vendor prefix: webkit
|
Full support
Yes |
Full support
29-
Full support
29
-
No support
24 — 28
- Disabled From version 24 until version 28 (exclusive): this feature is behind the
dom.gamepad.enabled preference (needs to be set to true ). To change preferences in Firefox, visit about:config.
|
No support
No |
Full support
22-
Full support
22
-
No support
15 — 21
- Prefixed Requires the vendor prefix: webkit
|
No support
No |
No support
No |
Full support
Yes |
Full support
Yes |
Full support
32 |
No support
No |
No support
No |
No support
No |
---|
See also