diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 19:33:14 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 19:33:14 +0000 |
commit | 36d22d82aa202bb199967e9512281e9a53db42c9 (patch) | |
tree | 105e8c98ddea1c1e4784a60a5a6410fa416be2de /dom/webidl/Gamepad.webidl | |
parent | Initial commit. (diff) | |
download | firefox-esr-upstream.tar.xz firefox-esr-upstream.zip |
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | dom/webidl/Gamepad.webidl | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/dom/webidl/Gamepad.webidl b/dom/webidl/Gamepad.webidl new file mode 100644 index 0000000000..a8ec894441 --- /dev/null +++ b/dom/webidl/Gamepad.webidl @@ -0,0 +1,114 @@ +/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * The origin of this IDL file is + * https://w3c.github.io/gamepad/ + * https://w3c.github.io/gamepad/extensions.html + * https://w3c.github.io/webvr/spec/1.1/#interface-gamepad + */ + +[Pref="dom.gamepad.enabled", + Exposed=Window, + SecureContext] +interface GamepadButton { + readonly attribute boolean pressed; + readonly attribute boolean touched; + readonly attribute double value; +}; + +enum GamepadHand { + "", + "left", + "right" +}; + +/** + * https://www.w3.org/TR/gamepad/#gamepadmappingtype-enum + * https://immersive-web.github.io/webxr-gamepads-module/#enumdef-gamepadmappingtype + */ +enum GamepadMappingType { + "", + "standard", + "xr-standard" +}; + +[Pref="dom.gamepad.enabled", + Exposed=Window, + SecureContext] +interface Gamepad { + /** + * An identifier, unique per type of device. + */ + readonly attribute DOMString id; + + /** + * The game port index for the device. Unique per device + * attached to this system. + */ + readonly attribute long index; + + /** + * The mapping in use for this device. The empty string + * indicates that no mapping is in use. + */ + readonly attribute GamepadMappingType mapping; + + /** + * The hand in use for this device. The empty string + * indicates that unknown, both hands, or not applicable + */ + [Pref="dom.gamepad.extensions.enabled"] + readonly attribute GamepadHand hand; + + /** + * The displayId in use for as an association point in the VRDisplay API + * to identify which VRDisplay that the gamepad is associated with. + */ + [Pref="dom.vr.enabled"] + readonly attribute unsigned long displayId; + + /** + * true if this gamepad is currently connected to the system. + */ + readonly attribute boolean connected; + + /** + * The current state of all buttons on the device, an + * array of GamepadButton. + */ + [Pure, Cached, Frozen] + readonly attribute sequence<GamepadButton> buttons; + + /** + * The current position of all axes on the device, an + * array of doubles. + */ + [Pure, Cached, Frozen] + readonly attribute sequence<double> axes; + + /** + * Timestamp from when the data of this device was last updated. + */ + readonly attribute DOMHighResTimeStamp timestamp; + + /** + * The current pose of the device, a GamepadPose. + */ + [Pref="dom.gamepad.extensions.enabled"] + readonly attribute GamepadPose? pose; + + /** + * The current haptic actuator of the device, an array of + * GamepadHapticActuator. + */ + [Constant, Cached, Frozen, Pref="dom.gamepad.extensions.enabled"] + readonly attribute sequence<GamepadHapticActuator> hapticActuators; + + [Constant, Cached, Frozen, Pref="dom.gamepad.extensions.enabled", Pref="dom.gamepad.extensions.lightindicator"] + readonly attribute sequence<GamepadLightIndicator> lightIndicators; + + [Constant, Cached, Frozen, Pref="dom.gamepad.extensions.enabled", Pref="dom.gamepad.extensions.multitouch"] + readonly attribute sequence<GamepadTouch> touchEvents; +}; |