Gamepad: Implement GamepadHapticActuator

components/constellation/tracing.rs

@@ -237,6 +237,8 @@ mod from_script {
                 Self::OnDevtoolsStarted(..) => target_variant!("OnDevtoolsStarted"),
                 Self::ReadyToPresent(..) => target_variant!("ReadyToPresent"),
                 Self::EventDelivered(..) => target_variant!("EventDelivered"),
+                Self::PlayGamepadHapticEffect(..) => target_variant!("PlayGamepadHapticEffect"),
+                Self::StopGamepadHapticEffect(..) => target_variant!("StopGamepadHapticEffect"),
             }
         }
     }

components/script/dom/bindings/codegen/Bindings.conf

@@ -176,6 +176,10 @@ DOMInterfaces = {
         'CreateRenderPipelineAsync',
         'CreateShaderModule' # Creates promise for compilation info
     ],
+},
+
+'GamepadHapticActuator': {
+    'inRealms': ['PlayEffect', 'Reset']
 }
 
 }

components/script/dom/document.rs

@@ -4125,6 +4125,19 @@ impl Document {
         // Step 6 Run any page visibility change steps which may be defined in other specifications, with visibility
         // state and document. Any other specs' visibility steps will go here.
 
+        // <https://www.w3.org/TR/gamepad/#handling-visibility-change>
+        if visibility_state == DocumentVisibilityState::Hidden {
+            self.window
+                .Navigator()
+                .GetGamepads()
+                .iter_mut()
+                .for_each(|gamepad| {
+                    if let Some(g) = gamepad {
+                        g.vibration_actuator().handle_visibility_change();
+                    }
+                });
+        }
+
         // Step 7 Fire an event named visibilitychange at document, with its bubbles attribute initialized to true.
         self.upcast::<EventTarget>()
             .fire_bubbling_event(atom!("visibilitychange"));

components/script/dom/gamepad.rs

@@ -6,7 +6,7 @@ use std::cell::Cell;
 
 use dom_struct::dom_struct;
 use js::typedarray::{Float64, Float64Array};
-use script_traits::GamepadUpdateType;
+use script_traits::{GamepadSupportedHapticEffects, GamepadUpdateType};
 
 use super::bindings::buffer_source::HeapBufferSource;
 use crate::dom::bindings::codegen::Bindings::GamepadBinding::{GamepadHand, GamepadMethods};
@@ -20,6 +20,7 @@ use crate::dom::event::Event;
 use crate::dom::eventtarget::EventTarget;
 use crate::dom::gamepadbuttonlist::GamepadButtonList;
 use crate::dom::gamepadevent::{GamepadEvent, GamepadEventType};
+use crate::dom::gamepadhapticactuator::GamepadHapticActuator;
 use crate::dom::gamepadpose::GamepadPose;
 use crate::dom::globalscope::GlobalScope;
 use crate::script_runtime::JSContext;
@@ -49,6 +50,7 @@ pub struct Gamepad {
     axis_bounds: (f64, f64),
     button_bounds: (f64, f64),
     exposed: Cell<bool>,
+    vibration_actuator: Dom<GamepadHapticActuator>,
 }
 
 impl Gamepad {
@@ -65,6 +67,7 @@ impl Gamepad {
         hand: GamepadHand,
         axis_bounds: (f64, f64),
         button_bounds: (f64, f64),
+        vibration_actuator: &GamepadHapticActuator,
     ) -> Gamepad {
         Self {
             reflector_: Reflector::new(),
@@ -81,6 +84,7 @@ impl Gamepad {
             axis_bounds,
             button_bounds,
             exposed: Cell::new(false),
+            vibration_actuator: Dom::from_ref(vibration_actuator),
         }
     }
 
@@ -90,8 +94,16 @@ impl Gamepad {
         id: String,
         axis_bounds: (f64, f64),
         button_bounds: (f64, f64),
+        supported_haptic_effects: GamepadSupportedHapticEffects,
     ) -> DomRoot<Gamepad> {
-        Self::new_with_proto(global, gamepad_id, id, axis_bounds, button_bounds)
+        Self::new_with_proto(
+            global,
+            gamepad_id,
+            id,
+            axis_bounds,
+            button_bounds,
+            supported_haptic_effects,
+        )
     }
 
     /// When we construct a new gamepad, we initialize the number of buttons and
@@ -105,8 +117,11 @@ impl Gamepad {
         id: String,
         axis_bounds: (f64, f64),
         button_bounds: (f64, f64),
+        supported_haptic_effects: GamepadSupportedHapticEffects,
     ) -> DomRoot<Gamepad> {
         let button_list = GamepadButtonList::init_buttons(global);
+        let vibration_actuator =
+            GamepadHapticActuator::new(global, gamepad_id, supported_haptic_effects);
         let gamepad = reflect_dom_object_with_proto(
             Box::new(Gamepad::new_inherited(
                 gamepad_id,
@@ -120,6 +135,7 @@ impl Gamepad {
                 GamepadHand::_empty,
                 axis_bounds,
                 button_bounds,
+                &vibration_actuator,
             )),
             global,
             None,
@@ -165,6 +181,11 @@ impl GamepadMethods for Gamepad {
         DomRoot::from_ref(&*self.buttons)
     }
 
+    // https://w3c.github.io/gamepad/#dom-gamepad-vibrationactuator
+    fn VibrationActuator(&self) -> DomRoot<GamepadHapticActuator> {
+        DomRoot::from_ref(&*self.vibration_actuator)
+    }
+
     // https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
     fn Hand(&self) -> GamepadHand {
         self.hand
@@ -286,6 +307,10 @@ impl Gamepad {
     pub fn set_exposed(&self, exposed: bool) {
         self.exposed.set(exposed);
     }
+
+    pub fn vibration_actuator(&self) -> &GamepadHapticActuator {
+        &*self.vibration_actuator
+    }
 }
 
 /// <https://www.w3.org/TR/gamepad/#dfn-gamepad-user-gesture>