medius 3.4.1

Host control library for the medius transparent mouse passthrough box
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

use crate::error::Result;
use crate::protocol::FrameType;
use crate::protocol::command::{move_cursor_payload, move_pan_payload, move_wheel_payload};
use crate::types::{Motion, MoveTiming, PendingMotion};

use super::Device;

impl Device {
    /// `MOVE` (cursor): relative cursor movement; full `i16`, no clamp.
    pub fn move_rel(&self, dx: i16, dy: i16) -> Result<()> {
        self.move_axis(
            Motion::Cursor { dx, dy },
            MoveTiming::Ride,
            PendingMotion::Keep,
        )
    }

    /// `MOVE` (wheel): vertical scroll; full `i16`, no clamp.
    pub fn wheel(&self, delta: i16) -> Result<()> {
        self.move_axis(Motion::Wheel(delta), MoveTiming::Ride, PendingMotion::Keep)
    }

    /// `MOVE` (cursor) that bypasses movement riding: emits on the box's own clock even while riding is
    /// on, and leaves motion already held for a ride held.
    pub fn move_rel_now(&self, dx: i16, dy: i16) -> Result<()> {
        self.move_axis(
            Motion::Cursor { dx, dy },
            MoveTiming::Now,
            PendingMotion::Keep,
        )
    }

    /// `MOVE` (wheel) that bypasses movement riding.
    pub fn wheel_now(&self, delta: i16) -> Result<()> {
        self.move_axis(Motion::Wheel(delta), MoveTiming::Now, PendingMotion::Keep)
    }

    /// `MOVE` (AC Pan): horizontal scroll; full `i16`, no clamp.
    pub fn pan(&self, delta: i16) -> Result<()> {
        self.move_axis(Motion::Pan(delta), MoveTiming::Ride, PendingMotion::Keep)
    }

    /// `MOVE` (AC Pan) that bypasses movement riding.
    pub fn pan_now(&self, delta: i16) -> Result<()> {
        self.move_axis(Motion::Pan(delta), MoveTiming::Now, PendingMotion::Keep)
    }

    /// `MOVE` (zero delta, `FLUSH`): emit the motion held for a ride now, ignoring the ride window.
    pub fn flush_motion(&self) -> Result<()> {
        self.move_axis(
            Motion::Cursor { dx: 0, dy: 0 },
            MoveTiming::Ride,
            PendingMotion::Flush,
        )
    }

    /// `MOVE` (zero delta, `DISCARD`): drop the motion held for a ride. Motion sent with
    /// [`move_rel_now`](Self::move_rel_now) is untouched.
    pub fn discard_motion(&self) -> Result<()> {
        self.move_axis(
            Motion::Cursor { dx: 0, dy: 0 },
            MoveTiming::Ride,
            PendingMotion::Discard,
        )
    }

    /// `MOVE`: drive a relative axis, choosing when this delta reaches the game PC and what happens to
    /// motion already held for a ride.
    pub fn move_axis(
        &self,
        motion: Motion,
        timing: MoveTiming,
        pending: PendingMotion,
    ) -> Result<()> {
        let flags = timing.as_u8() | pending.as_u8();
        match motion {
            Motion::Cursor { dx, dy } => self
                .link
                .send(FrameType::Move, &move_cursor_payload(dx, dy, flags)),
            Motion::Wheel(dz) => self
                .link
                .send(FrameType::Move, &move_wheel_payload(dz, flags)),
            Motion::Pan(dpan) => self
                .link
                .send(FrameType::Move, &move_pan_payload(dpan, flags)),
        }
    }
}