XRInputSource: gamepad property

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The read-only XRInputSource property gamepad returns a Gamepad object describing the state of the buttons and axes on the XR input source, if it is a gamepad or comparable device. If the device isn't a gamepad-like device, this property's value is null.

The Gamepad instance returned behaves as described by the Gamepad API. However, there are a few things to note:

Examples

Using a gamepad input source

js
for (const source of frame.session.inputSources) {
  const gamepad = source.gamepad;
  if (gamepad) {
    if (gamepad.buttons[2].pressed) {
      // do something
    }
  }
}

Specifications

Specification
WebXR Gamepads Module - Level 1
# dom-xrinputsource-gamepad

Browser compatibility

BCD tables only load in the browser