device-envoy-core 0.1.3

Shared traits and data types for device-envoy platform crates
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

//! Touch-side support types for the CYD's `cyd` device abstraction.
//!
//! Applications read calibrated, oriented events via [`TouchEvent`]. Device
//! Envoy's platform implementations connect raw controller samples to the
//! private calibration workflow. Applications use
//! [`CydTouch`](super::CydTouch); see its
//! [example](super::CydTouch::try_read).

pub(crate) mod calibration;
pub(crate) mod driver;
pub(crate) mod flow;

use embedded_graphics::geometry::Point;

/// A touch event in logical display coordinates (already calibrated and oriented).
///
/// Read it with [CydTouch::try_read](super::CydTouch::try_read) in the
/// [focused example](super::CydTouch::try_read), or see the larger
/// [application example](../index.html#application-example) for a complete
/// read-and-draw flow. Applications receive coordinates bounded by
/// [`CydDisplay::screen_size()`](super::CydDisplay::screen_size) and must not
/// apply another orientation mapping.
/// Calibration remains defined against the fixed `320×240` landscape panel
/// internally; the platform touch implementation maps the result into the
/// runtime display orientation before returning it.
#[derive(Clone, Copy, Debug)]
pub enum TouchEvent {
    /// The touch contact began at `point`.
    Down {
        /// The contact position.
        point: Point,
    },
    /// The active contact moved to `point`.
    Move {
        /// The contact position.
        point: Point,
    },
    /// The touch contact ended.
    Up,
}

/// A raw XPT2046 touch sample used internally by calibration.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub(crate) struct RawPoint {
    pub x: u16,
    pub y: u16,
}