stickup 0.2.9

A modular input device abstraction layer with HID and virtual device support.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

//! src/devices/backends/virtual_input.rs

use crate::device::Device;
use crate::event::InputKind;

/// A software-emulated input device.
///
/// Useful for testing, scripting, or simulating physical input.
#[derive(Default)]
pub struct VirtualDevice {
    id: String,
    name: String,
    events: Vec<InputKind>,
}

impl VirtualDevice {
    /// Creates a new virtual device with a custom ID and name.
    pub fn new(id: &str, name: &str) -> Self {
        Self {
            id: id.to_string(),
            name: name.to_string(),
            events: Vec::new(),
        }
    }

    /// Queues a raw input event.
    pub fn feed(&mut self, event: InputKind) {
        self.events.push(event);
    }

    /// Queues an axis movement event.
    pub fn set_axis(&mut self, axis: u8, value: f32) {
        self.feed(InputKind::AxisMoved { axis, value });
    }

    /// Queues a button press.
    pub fn press_button(&mut self, button: u8) {
        self.feed(InputKind::ButtonPressed { button });
    }

    /// Queues a button release.
    pub fn release_button(&mut self, button: u8) {
        self.feed(InputKind::ButtonReleased { button });
    }
}

impl Device for VirtualDevice {
    /// Returns and clears all queued events.
    fn poll(&mut self) -> Vec<InputKind> {
        let events = self.events.clone();
        self.events.clear();
        events
    }

    fn name(&self) -> &str {
        &self.name
    }

    fn id(&self) -> &str {
        &self.id
    }
}

/// Returns a single default virtual input device.
pub fn create_virtual_devices() -> Vec<Box<dyn Device>> {
    vec![Box::new(VirtualDevice::new("virtual:0", "Virtual Input 0"))]
}