Gamepad device events 2

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Unreleased
 
+- Improve event API documentation.
+- Overhaul device event API:
+  - **Breaking**: `Event::DeviceEvent` split into `MouseEvent`, `KeyboardEvent`, and `GamepadEvent`.
+  - **Breaking**: Remove `DeviceEvent::Text` variant.
+  - **Breaking**: `DeviceId` split into `MouseId`, `KeyboardId`, and `GamepadHandle`.
+  - **Breaking**: Removed device IDs from `WindowEvent` variants.
+  - Add `enumerate` function on device ID types to list all attached devices of that type.
+  - Add `is_connected` function on device ID types check if the specified device is still available.
+  - **Breaking**: On Windows, rename `DeviceIdExtWindows` to `DeviceExtWindows`.
+    - Add `handle` function to retrieve the underlying `HANDLE`.
+- On Windows, fix duplicate device events getting sent if Winit managed multiple windows.
+- On Windows, raw mouse events now report Mouse4 and Mouse5 presses and releases.
+- Added gamepad support on Windows via raw input and XInput.
 - On macOS, drop the event callback before exiting.
 - On Android, implement `Window::request_redraw`
 - **Breaking:** On Web, remove the `stdweb` backend.

Cargo.toml

@@ -56,6 +56,7 @@ features = ["display_link"]
 
 [target.'cfg(target_os = "windows")'.dependencies]
 parking_lot = "0.11"
+rusty-xinput = "1.0"
 
 [target.'cfg(target_os = "windows")'.dependencies.winapi]
 version = "0.3.6"
@@ -64,6 +65,7 @@ features = [
     "commctrl",
     "dwmapi",
     "errhandlingapi",
+    "hidpi",
     "imm",
     "hidusage",
     "libloaderapi",
@@ -80,6 +82,7 @@ features = [
     "wingdi",
     "winnt",
     "winuser",
+    "xinput",
 ]
 
 [target.'cfg(any(target_os = "linux", target_os = "dragonfly", target_os = "freebsd", target_os = "openbsd", target_os = "netbsd"))'.dependencies]

examples/control_flow.rs

@@ -51,15 +51,11 @@ fn main() {
                 WindowEvent::CloseRequested => {
                     close_requested = true;
                 }
-                WindowEvent::KeyboardInput {
-                    input:
-                        KeyboardInput {
-                            virtual_keycode: Some(virtual_code),
-                            state: ElementState::Pressed,
-                            ..
-                        },
+                WindowEvent::KeyboardInput(KeyboardInput {
+                    virtual_keycode: Some(virtual_code),
+                    state: ElementState::Pressed,
                     ..
-                } => match virtual_code {
+                }) => match virtual_code {
                     VirtualKeyCode::Key1 => {
                         mode = Mode::Wait;
                         println!("\nmode: {:?}\n", mode);

examples/cursor.rs

@@ -20,14 +20,10 @@ fn main() {
         match event {
             Event::WindowEvent {
                 event:
-                    WindowEvent::KeyboardInput {
-                        input:
-                            KeyboardInput {
-                                state: ElementState::Pressed,
-                                ..
-                            },
+                    WindowEvent::KeyboardInput(KeyboardInput {
+                        state: ElementState::Pressed,
                         ..
-                    },
+                    }),
                 ..
             } => {
                 println!("Setting cursor to \"{:?}\"", CURSORS[cursor_idx]);

examples/cursor_grab.rs

@@ -1,6 +1,6 @@
 use simple_logger::SimpleLogger;
 use winit::{
-    event::{DeviceEvent, ElementState, Event, KeyboardInput, ModifiersState, WindowEvent},
+    event::{device::MouseEvent, ElementState, Event, KeyboardInput, ModifiersState, WindowEvent},
     event_loop::{ControlFlow, EventLoop},
     window::WindowBuilder,
 };
@@ -22,15 +22,11 @@ fn main() {
         match event {
             Event::WindowEvent { event, .. } => match event {
                 WindowEvent::CloseRequested => *control_flow = ControlFlow::Exit,
-                WindowEvent::KeyboardInput {
-                    input:
-                        KeyboardInput {
-                            state: ElementState::Released,
-                            virtual_keycode: Some(key),
-                            ..
-                        },
+                WindowEvent::KeyboardInput(KeyboardInput {
+                    state: ElementState::Released,
+                    virtual_keycode: Some(key),
                     ..
-                } => {
+                }) => {
                     use winit::event::VirtualKeyCode::*;
                     match key {
                         Escape => *control_flow = ControlFlow::Exit,
@@ -42,14 +38,16 @@ fn main() {
                 WindowEvent::ModifiersChanged(m) => modifiers = m,
                 _ => (),
             },
-            Event::DeviceEvent { event, .. } => match event {
-                DeviceEvent::MouseMotion { delta } => println!("mouse moved: {:?}", delta),
-                DeviceEvent::Button { button, state } => match state {
-                    ElementState::Pressed => println!("mouse button {} pressed", button),
-                    ElementState::Released => println!("mouse button {} released", button),
+
+            Event::MouseEvent(_, event) => match event {
+                MouseEvent::MovedRelative(x, y) => println!("mouse moved: {:?}", (x, y)),
+                MouseEvent::Button { button, state } => match state {
+                    ElementState::Pressed => println!("mouse button {:?} pressed", button),
+                    ElementState::Released => println!("mouse button {:?} released", button),
                 },
                 _ => (),
             },
+
             _ => (),
         }
     });

examples/drag_window.rs

@@ -42,15 +42,11 @@ fn main() {
                 entered_id = window_id;
                 name_windows(entered_id, switched, &window_1, &window_2)
             }
-            WindowEvent::KeyboardInput {
-                input:
-                    KeyboardInput {
-                        state: ElementState::Released,
-                        virtual_keycode: Some(VirtualKeyCode::X),
-                        ..
-                    },
+            WindowEvent::KeyboardInput(KeyboardInput {
+                state: ElementState::Released,
+                virtual_keycode: Some(VirtualKeyCode::X),
                 ..
-            } => {
+            }) => {
                 switched = !switched;
                 name_windows(entered_id, switched, &window_1, &window_2);
                 println!("Switched!")

examples/fullscreen.rs

@@ -37,15 +37,11 @@ fn main() {
         match event {
             Event::WindowEvent { event, .. } => match event {
                 WindowEvent::CloseRequested => *control_flow = ControlFlow::Exit,
-                WindowEvent::KeyboardInput {
-                    input:
-                        KeyboardInput {
-                            virtual_keycode: Some(virtual_code),
-                            state,
-                            ..
-                        },
+                WindowEvent::KeyboardInput(KeyboardInput {
+                    virtual_keycode: Some(virtual_code),
+                    state,
                     ..
-                } => match (virtual_code, state) {
+                }) => match (virtual_code, state) {
                     (VirtualKeyCode::Escape, _) => *control_flow = ControlFlow::Exit,
                     (VirtualKeyCode::F, ElementState::Pressed) => {
                         if window.fullscreen().is_some() {

examples/gamepad.rs

@@ -0,0 +1,52 @@
+use winit::{
+    event::{
+        device::{GamepadEvent, GamepadHandle},
+        Event, WindowEvent,
+    },
+    event_loop::{ControlFlow, EventLoop},
+    window::WindowBuilder,
+};
+
+fn main() {
+    let event_loop = EventLoop::new();
+
+    let _window = WindowBuilder::new()
+        .with_title("The world's worst video game")
+        .build(&event_loop)
+        .unwrap();
+
+    println!("enumerating gamepads:");
+    for gamepad in GamepadHandle::enumerate(&event_loop) {
+        println!(
+            "    gamepad={:?}\tport={:?}\tbattery level={:?}",
+            gamepad,
+            gamepad.port(),
+            gamepad.battery_level()
+        );
+    }
+
+    let deadzone = 0.12;
+
+    event_loop.run(move |event, _, control_flow| {
+        match event {
+            Event::GamepadEvent(gamepad_handle, event) => {
+                match event {
+                    // Discard any Axis events that has a corresponding Stick event.
+                    GamepadEvent::Axis { stick: true, .. } => (),
+
+                    // Discard any Stick event that falls inside the stick's deadzone.
+                    GamepadEvent::Stick {
+                        x_value, y_value, ..
+                    } if (x_value.powi(2) + y_value.powi(2)).sqrt() < deadzone => (),
+
+                    _ => println!("[{:?}] {:#?}", gamepad_handle, event),
+                }
+            }
+            Event::WindowEvent {
+                event: WindowEvent::CloseRequested,
+                ..
+            } => *control_flow = ControlFlow::Exit,
+            _ => (),
+        }
+    });
+}

examples/gamepad_rumble.rs

@@ -0,0 +1,60 @@
+use std::time::Instant;
+use winit::event_loop::EventLoop;
+
+#[derive(Debug, Clone)]
+enum Rumble {
+    None,
+    Left,
+    Right,
+}
+
+fn main() {
+    let event_loop = EventLoop::new();
+
+    // You should generally use `GamepadEvent::Added/Removed` to detect gamepads, as doing that will
+    // allow you to more easily support gamepad hotswapping. However, we're using `enumerate` here
+    // because it makes this example more concise.
+    let gamepads = winit::event::device::GamepadHandle::enumerate(&event_loop).collect::<Vec<_>>();
+
+    let rumble_patterns = &[
+        (0.5, Rumble::None),
+        (2.0, Rumble::Left),
+        (0.5, Rumble::None),
+        (2.0, Rumble::Right),
+    ];
+    let mut rumble_iter = rumble_patterns.iter().cloned().cycle();
+
+    let mut active_pattern = rumble_iter.next().unwrap();
+    let mut timeout = active_pattern.0;
+    let mut timeout_start = Instant::now();
+
+    event_loop.run(move |_, _, _| {
+        if timeout <= active_pattern.0 {
+            let t = (timeout / active_pattern.0) * std::f64::consts::PI;
+            let intensity = t.sin();
+
+            for g in &gamepads {
+                let result = match active_pattern.1 {
+                    Rumble::Left => g.rumble(intensity, 0.0),
+                    Rumble::Right => g.rumble(0.0, intensity),
+                    Rumble::None => Ok(()),
+                };
+
+                if let Err(e) = result {
+                    println!("Rumble failed: {:?}", e);
+                }
+            }
+
+            timeout = (Instant::now() - timeout_start).as_millis() as f64 / 1000.0;
+        } else {
+            active_pattern = rumble_iter.next().unwrap();
+            println!(
+                "Rumbling {:?} for {:?} seconds",
+                active_pattern.1, active_pattern.0
+            );
+
+            timeout = 0.0;
+            timeout_start = Instant::now();
+        }
+    });
+}

examples/handling_close.rs

@@ -43,15 +43,11 @@ fn main() {
                         // closing the window. How to close the window is detailed in the handler for
                         // the Y key.
                     }
-                    WindowEvent::KeyboardInput {
-                        input:
-                            KeyboardInput {
-                                virtual_keycode: Some(virtual_code),
-                                state: Released,
-                                ..
-                            },
+                    WindowEvent::KeyboardInput(KeyboardInput {
+                        virtual_keycode: Some(virtual_code),
+                        state: Released,
                         ..
-                    } => {
+                    }) => {
                         match virtual_code {
                             Y => {
                                 if close_requested {

examples/minimize.rs

@@ -25,7 +25,7 @@ fn main() {
 
             // Keyboard input event to handle minimize via a hotkey
             Event::WindowEvent {
-                event: WindowEvent::KeyboardInput { input, .. },
+                event: WindowEvent::KeyboardInput(input),
                 window_id,
             } => {
                 if window_id == window.id() {

examples/mouse_wheel.rs

@@ -1,6 +1,6 @@
 use simple_logger::SimpleLogger;
 use winit::{
-    event::{DeviceEvent, Event, WindowEvent},
+    event::{Event, WindowEvent},
     event_loop::{ControlFlow, EventLoop},
     window::WindowBuilder,
 };
@@ -20,10 +20,7 @@ fn main() {
         match event {
             Event::WindowEvent { event, .. } => match event {
                 WindowEvent::CloseRequested => *control_flow = ControlFlow::Exit,
-                _ => (),
-            },
-            Event::DeviceEvent { event, .. } => match event {
-                DeviceEvent::MouseWheel { delta } => match delta {
+                WindowEvent::MouseWheel { delta, .. } => match delta {
                     winit::event::MouseScrollDelta::LineDelta(x, y) => {
                         println!("mouse wheel Line Delta: ({},{})", x, y);
                         let pixels_per_line = 120.0;

examples/multithreaded.rs

@@ -49,17 +49,12 @@ fn main() {
                             );
                         }
                     }
-                    #[allow(deprecated)]
-                    WindowEvent::KeyboardInput {
-                        input:
-                            KeyboardInput {
-                                state: ElementState::Released,
-                                virtual_keycode: Some(key),
-                                modifiers,
-                                ..
-                            },
+                    WindowEvent::KeyboardInput(KeyboardInput {
+                        state: ElementState::Released,
+                        virtual_keycode: Some(key),
+                        modifiers,
                         ..
-                    } => {
+                    }) => {
                         window.set_title(&format!("{:?}", key));
                         let state = !modifiers.shift();
                         use VirtualKeyCode::*;
@@ -154,15 +149,11 @@ fn main() {
             Event::WindowEvent { event, window_id } => match event {
                 WindowEvent::CloseRequested
                 | WindowEvent::Destroyed
-                | WindowEvent::KeyboardInput {
-                    input:
-                        KeyboardInput {
-                            state: ElementState::Released,
-                            virtual_keycode: Some(VirtualKeyCode::Escape),
-                            ..
-                        },
+                | WindowEvent::KeyboardInput(KeyboardInput {
+                    state: ElementState::Released,
+                    virtual_keycode: Some(VirtualKeyCode::Escape),
                     ..
-                } => {
+                }) => {
                     window_senders.remove(&window_id);
                 }
                 _ => {

examples/multiwindow.rs

@@ -33,14 +33,10 @@ fn main() {
                             *control_flow = ControlFlow::Exit;
                         }
                     }
-                    WindowEvent::KeyboardInput {
-                        input:
-                            KeyboardInput {
-                                state: ElementState::Pressed,
-                                ..
-                            },
+                    WindowEvent::KeyboardInput(KeyboardInput {
+                        state: ElementState::Pressed,
                         ..
-                    } => {
+                    }) => {
                         let window = Window::new(&event_loop).unwrap();
                         windows.insert(window.id(), window);
                     }