Gamepad Extensions

Conformance

As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this specification are non-normative. Everything else in this specification is normative.

The key words MAY and MUST in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.

GamepadHand Enum

This enum defines the set of possible hands a gamepad may be held by.

WebIDLenum GamepadHand {
  "",  /* unknown, both hands, or not applicable */
  "left",
  "right"
};

"" (the empty string)

The empty string indicates the hand that is holding the gamepad is unknown or not applicable (e.g., if the gamepad is held with two hands).

left

Gamepad is held or is most likely to be held in the left hand.

right

Gamepad is held or is most likely to be held in the right hand.

GamepadPose Interface

This interface defines the gamepad's position, orientation, velocity, and acceleration.

WebIDL[Exposed=Window]
interface GamepadPose {
  readonly attribute boolean hasOrientation;
  readonly attribute boolean hasPosition;

  readonly attribute Float32Array? position;
  readonly attribute Float32Array? linearVelocity;
  readonly attribute Float32Array? linearAcceleration;
  readonly attribute Float32Array? orientation;
  readonly attribute Float32Array? angularVelocity;
  readonly attribute Float32Array? angularAcceleration;
};

hasOrientation

The hasOrientation attribute MUST return whether the gamepad is capable of tracking its orientation.

hasPosition

The hasPosition attribute MUST return whether the gamepad is capable of tracking its position.

position

Position of the gamepad as a 3D vector, given in meters from an origin point, which is determined by the gamepad hardware and MAY be the position of the gamepad when first polled if no other reference point is available. The coordinate system uses these axis definitions, assuming the user is holding the gamepad in the forward orientation:

• Positive X is to the user's right.
• Positive Y is up.
• Positive Z is behind the user.

MUST be null if the gamepad is incapable of providing positional data. When not null, MUST be a three-element array.

linearVelocity

Linear velocity of the gamepad in meters per second. MUST be null if the sensor is incapable of providing linear velocity. When not null, MUST be a three-element array.

linearAcceleration

Linear acceleration of the gamepad in meters per second. MUST be null if the sensor is incapable of providing linear acceleration. When not null, MUST be a three-element array.

orientation

Orientation of the gamepad as a quaternion. An orientation of [0, 0, 0, 1] is considered to be forward. The forward direction MUST be determined by the gamepad hardware. The forward direction MAY be the orientation of the hardware when it was first polled if no other reference orientation is available. If the sensor is incapable of providing orientation data, the orientation MUST be null. When not null, the orientation MUST be a four-element array.

angularVelocity

Angular velocity of the gamepad in meters per second. MUST be null if the sensor is incapable of providing angular velocity. When not null, the angularVelocity MUST be a three-element array.

angularAcceleration

Angular acceleration of the gamepad in meters per second. MUST be null if the sensor is incapable of providing angular acceleration. When not null, angularAcceleration MUST be a three-element array.

Partial Gamepad Interface

This partial interface supplements the Gamepad interface described in the main Gamepad spec.

WebIDLpartial interface Gamepad {
  readonly attribute GamepadHand hand;
  readonly attribute FrozenArray<GamepadHapticActuator> hapticActuators;
  readonly attribute GamepadPose? pose;
};

Instances of Gamepad are created with the internal slots described in the following table:

hand

An enumeration, GamepadHand, that indicates which hand the controller is being held in or is most likely to be held in.

hapticActuators

A list of all the GamepadHapticActuators in the gamepad. The same object MUST be returned until the user agent needs to return different values (or values in a different order).

pose

The current GamepadPose of the gamepad, if supported by the hardware. Includes position, orientation, velocity, and acceleration. If the hardware cannot supply any pose values, MUST be set to null.

Partial GamepadHapticActuator Interface

This partial interface supplements the GamepadHapticActuator interface described in the main Gamepad spec.

WebIDL[Exposed=Window]
partial interface GamepadHapticActuator {
  Promise<boolean> pulse(double value, double duration);
};

pulse() method

pulse() applies a value to the actuator for duration milliseconds. The value passed to pulse() is clamped to limits defined by the actuator type. The returned Promise will resolve true once the pulse has completed.

Repeated calls to pulse() override the previous values.