tiny-led-matrix 1.0.2

A library for direct control of a small monochrome LED display.
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

//! The interface between images and the display.

/// The number of brightness levels for greyscale images (ie, 10).
pub const BRIGHTNESSES : usize = 10;

/// The maximum brightness level for greyscale images (ie, 9; the minimum is 0).
pub const MAX_BRIGHTNESS : u8 = (BRIGHTNESSES as u8)-1;


/// A trait providing the information that [`Display`] needs to render an image.
///
/// [`Display`]: crate::display::Display
///
/// # Example implementation
///
/// Here's an example of a 5×5 image type, using one byte for each 'pixel':
///
/// ```
/// # use tiny_led_matrix::Render;
/// struct GreyscaleImage (
///     [[u8; 5]; 5]
/// );
///
/// impl GreyscaleImage {
///     const fn new(data: &[[u8; 5]; 5]) -> GreyscaleImage {
///         GreyscaleImage(*data)
///     }
/// }
///
/// impl Render for GreyscaleImage {
///     fn brightness_at(&self, x: usize, y: usize) -> u8 {
///         self.0[y][x]
///     }
/// }
/// const GREY_HEART: GreyscaleImage = GreyscaleImage::new(&[
///     [0, 9, 0, 9, 0],
///     [9, 5, 9, 5, 9],
///     [9, 5, 5, 5, 9],
///     [0, 9, 5, 9, 0],
///     [0, 0, 9, 0, 0],
/// ]);
/// ```


pub trait Render {

    /// Returns the brightness value for a single LED.
    ///
    /// The ranges for the x and y coordinates are 0..IMAGE_COLS and
    /// 0..IMAGE_ROWS, as defined by the [`Matrix`] for the [`Display`]'s
    /// [`Frame`].
    ///
    /// (0, 0) is the top left.
    ///
    /// The result must be in the range 0..=[`MAX_BRIGHTNESS`]
    ///
    /// # Panics
    ///
    /// If the provided coordinates are out of range, may panic or return an
    /// arbitrary in-range result.
    ///
    /// [`Display`]: crate::display::Display
    /// [`Matrix`]: crate::display::Matrix
    /// [`Frame`]: crate::display::Frame
    fn brightness_at(&self, x: usize, y: usize) -> u8;

}