interfaces/gamepad-extensions.idl

// GENERATED CONTENT - DO NOT EDIT
// Content was automatically extracted by Reffy into webref
// (https://github.com/w3c/webref)
// Source: Gamepad Extensions (https://w3c.github.io/gamepad/extensions.html)

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

[Exposed=Window]
interface GamepadHapticActuator {
  readonly attribute GamepadHapticActuatorType type;
  boolean canPlayEffectType(GamepadHapticEffectType type);
  Promise<GamepadHapticsResult> playEffect(
      GamepadHapticEffectType type,
      optional GamepadEffectParameters params = {});
  Promise<boolean> pulse(double value, double duration);
  Promise<GamepadHapticsResult> reset();
};

enum GamepadHapticsResult {
  "complete",
  "preempted"
};

enum GamepadHapticActuatorType {
  "vibration",
  "dual-rumble"
};

enum GamepadHapticEffectType {
  "dual-rumble"
};

dictionary GamepadEffectParameters {
    double duration = 0.0;
    double startDelay = 0.0;
    double strongMagnitude = 0.0;
    double weakMagnitude = 0.0;
};

[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;
};

[Exposed=Window, SecureContext]
interface GamepadTouch {
  readonly attribute unsigned long touchId;
  readonly attribute octet surfaceId;
  readonly attribute Float32Array position;
  readonly attribute Uint32Array? surfaceDimensions;
};

partial interface Gamepad {
  readonly attribute GamepadHand hand;
  readonly attribute FrozenArray<GamepadHapticActuator> hapticActuators;
  readonly attribute GamepadPose? pose;
  readonly attribute FrozenArray<GamepadTouch>? touchEvents;
  [SameObject] readonly attribute GamepadHapticActuator? vibrationActuator;
};