Gamepad API

Gamepad API. The Gamepad API is a World Wide Web Consortium specification that allows JavaScript code within web browsers to detect and interact with connected game controller hardware. It provides a standardized interface for reading button states, analog stick positions, and other input data from devices like the Xbox Wireless Controller or DualShock 4. This enables the development of rich, interactive video game experiences directly within the World Wide Web without requiring additional plug-ins.

Overview

The API was first introduced by engineers at Google within the Chromium project to address the growing demand for browser games with console-like controls. It standardizes communication between a vast array of USB and Bluetooth input devices and the HTML5 Document Object Model. Major industry players, including Microsoft and Sony, have seen their official controllers become widely compatible through this specification. The development of the API is overseen by the Web Applications Working Group, ensuring it integrates with other modern web standards like WebGL and Web Audio API.

Technical details

The core interface is the `Gamepad` object, which is accessed via the `navigator.getGamepads()` method defined in the ECMAScript specification. Each connected controller is represented as an object containing arrays for its `buttons` and `axes`. Button presses are reported as floating-point values, allowing for detection of pressure-sensitive inputs from devices like the DualSense controller. The API dispatches standard DOM Events such as `gamepadconnected` and `gamepaddisconnected`, which developers can listen for within their event-driven programming logic. Support for advanced features like haptic feedback is covered in separate specifications from the W3C.

Browser support

Implementation began with Google Chrome and Microsoft Edge, followed by Mozilla Firefox and Opera. Apple's Safari added support in a later version, completing coverage across all major layout engines. Support can be verified through resources like MDN Web Docs or Can I use. The Chromium Embedded Framework and projects like Electron also inherit this capability, enabling its use in desktop applications built with web technologies. Ongoing updates are tracked by the Web Platform Tests project.

Usage examples

A common implementation involves checking for the `gamepadconnected` event during the loading of a Canvas element-based game. Developers at Unity Technologies and Epic Games have utilized the API to port experiences to the web platform. It is fundamental to game distribution on portals like Itch.io and Microsoft Store, and for playing titles from services such as Xbox Cloud Gaming via a browser. The API also facilitates innovative educational software and virtual reality experiments that run directly in Firefox or Chromium.

Security and privacy considerations

The specification includes user-facing requirements to prevent fingerprinting, mandating that permission to access the API must be gated by a tangible user action, such as pressing a button. This policy is enforced by browser vendors like Google and Mozilla to align with broader web privacy initiatives. The Web Application Security Working Group provides guidelines to ensure the API cannot be used to silently monitor user activity. These measures help protect against potential exploits that could compromise security within the browser sandbox.

Category:Web APIs Category:HTML5 Category:Video game development