easytab 0.2.0

A Rust crate built for vendor-agnostic interaction with pen & tablet devices.
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102

use std::cell::{Cell, RefCell};
use std::collections::VecDeque;
use std::rc::Rc;

use thiserror::Error;

#[cfg(target_os = "windows")]
pub mod win32;
#[cfg(target_os = "windows")]
use win32::TabletData;
#[cfg(target_os = "windows")]
pub use win32::WindowsError;

#[cfg(not(any(target_os = "windows")))]
compile_error!("easytab is not yet implemented for this platform");

#[derive(Error, Clone, Debug)]
pub enum EasyTabError {
    #[cfg(target_os = "windows")]
    #[error("windows error: {0}")]
    WindowsError(#[from] WindowsError),

    #[cfg(feature = "raw-window-handle")]
    #[error("{0}")]
    HandleError(#[from] raw_window_handle::HandleError),

    #[cfg(feature = "raw-window-handle")]
    #[error("unsupported platform")]
    UnsupportedPlatform,
}

pub type EasyTabResult<T> = std::result::Result<T, EasyTabError>;

/// Initialisation options for the tablet.
#[derive(Clone)]
pub struct EasyTabOptions {
    /// Divisor used to normalise raw pressure to 0.0..=1.0. Defaults to 1024.0.
    pub pressure_normalization: f32,
}

impl Default for EasyTabOptions {
    fn default() -> Self {
        Self {
            pressure_normalization: 1024.0,
        }
    }
}

#[non_exhaustive]
#[derive(Debug, Clone, Copy, PartialEq, PartialOrd)]
pub enum TabletEvent {
    /// Pen entered hover range above the tablet.
    StylusEnter,
    /// Pen left hover range (or pointer capture was released).
    StylusLeave,
    /// Pen tip made contact with the tablet surface. `raw_pressure` is the un-normalised value.
    StylusDown {
        x: i32,
        y: i32,
        pressure: f32,
        raw_pressure: f32,
    },
    /// Pen tip lifted from the tablet surface.
    StylusUp { x: i32, y: i32 },
    /// Pen moved while hovering or in contact. `pressure` is 0.0 when hovering.
    StylusMove {
        x: i32,
        y: i32,
        pressure: f32,
        raw_pressure: f32,
    },
}

#[doc(hidden)]
pub(crate) struct TabletInner {
    pub(crate) enabled: Cell<bool>,
    pub(crate) events: RefCell<VecDeque<TabletEvent>>,
    pub(crate) options: EasyTabOptions,
}

pub struct EasyTablet {
    pub(crate) inner: Rc<TabletInner>,
    pub(crate) data: TabletData,
}

#[cfg(feature = "raw-window-handle")]
impl EasyTablet {
    pub fn from_window<W: raw_window_handle::HasWindowHandle>(window: &W) -> EasyTabResult<Self> {
        use raw_window_handle::RawWindowHandle;

        let raw = window
            .window_handle()
            .map_err(EasyTabError::HandleError)?
            .as_raw();

        match raw {
            #[cfg(target_os = "windows")]
            RawWindowHandle::Win32(h) => Self::init(h.hwnd.get() as usize),
            _ => Err(EasyTabError::UnsupportedPlatform),
        }
    }
}