Gamepad API
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The Gamepad API is a way for developers to access and respond to signals from gamepads and other game controllers in a simple, consistent way. It contains three interfaces, two events and one specialist function, to respond to gamepads being connected and disconnected, and to access other information about the gamepads themselves, and what buttons and other controls are currently being pressed.
Interfaces
Gamepad
-
Represents a gamepad/controller connected to the computer.
-
Represents a button on one of the connected controllers.
GamepadEvent
-
The event object representing events fired that are related to gamepads.
Experimental Gamepad extensions
GamepadHapticActuator
-
Represents hardware in the controller designed to provide haptic feedback to the user (if available), most commonly vibration hardware.
GamepadPose
-
Represents the pose of a controller (e.g. position and orientation in 3D space) in the case of a WebVR controller. This is not used by the newer WebXR standard.
See also the extensions to the Gamepad interface, for features that allow you to access the above information.
Extensions to other interfaces
Navigator
-
An extension to the
Navigator
object that returns an array ofGamepad
objects, one for each connected gamepad.
Window events
gamepadconnected
-
An event that will fire when a gamepad is connected.
gamepaddisconnected
-
An event that will fire when a gamepad is disconnected.
Tutorials and guides
Specifications
Specification |
---|
Gamepad # gamepad-interface |
Gamepad Extensions # partial-gamepad-interface |
Browser compatibility
BCD tables only load in the browser
See also
- The Gamepad API by Ted Mielczarek and Robert Nyman
- Simple API demo page (source)