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.

GamepadButton

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.getGamepads()

An extension to the Navigator object that returns an array of Gamepad objects, one for each connected gamepad.

Window events

Window.ongamepadconnected

Represents an event handler that will run when a gamepad is connected (when the gamepadconnected event fires).

Window.ongamepaddisconnected

Represents an event handler that will run when a gamepad is disconnected (when the gamepaddisconnected event fires).

Tutorials and guides

Specifications

Specification Status Comment
Gamepad Extensions Editor's Draft Defines the Experimental Gamepad extensions.
Gamepad
The definition of 'The Gamepad API specification' in that specification.
Working Draft Initial definition

Browser compatibility

BCD tables only load in the browser

See also