embedded-graphics 0.5.0

Embedded graphics library for small hardware displays
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191

//! Graphics primitives

use crate::drawable::Dimensions;

pub mod circle;
pub mod line;
pub mod rect;
pub mod triangle;

/// Primitive trait
pub trait Primitive: Dimensions {}

pub use self::circle::Circle;
pub use self::line::Line;
pub use self::rect::Rect;
pub use self::triangle::Triangle;

/// Create a [`Circle`](./primitives/circle/struct.Circle.html) with optional styling using a
/// convenient macro.
///
/// ```rust
/// use embedded_graphics::{circle, style::Style, primitives::Circle};
///
/// let line_circle: Circle<u8> = circle!((10, 20), 30);
/// let filled_circle: Circle<u8> = circle!((10, 20), 30, stroke = Some(5u8), fill = Some(10u8));
/// let default_style: Circle<u8> = circle!((10, 20), 30, style = Style::default());
/// ```
///
/// Style properties like `stroke` map to the method calls on the
/// [`WithStyle`](style/trait.WithStyle.html) trait. For example, the following code makes two
/// identical circles:
///
/// ```rust
/// use embedded_graphics::prelude::*;
/// use embedded_graphics::{circle, style::Style, primitives::Circle};
///
/// let circle: Circle<u8> = circle!((10, 20), 30, stroke = Some(5u8), fill = Some(10u8));
/// let circle: Circle<u8> = Circle::new(Coord::new(10, 20), 30).stroke(Some(5u8)).fill(Some(10u8));
/// ```
#[macro_export]
macro_rules! circle {
    (($cx:expr, $cy:expr), $r:expr $(, $style_key:ident = $style_value:expr )* $(,)?) => {{
        #[allow(unused_imports)]
        use $crate::style::WithStyle;
        $crate::primitives::Circle::new($crate::coord::Coord::new($cx, $cy), $r)
            $( .$style_key($style_value) )*
    }};
}

/// Create a [`Line`](./primitives/line/struct.Line.html) with optional styling using a
/// convenient macro.
///
/// Note that only the `stroke` property has any effect on lines currently.
///
/// ```rust
/// use embedded_graphics::{line, style::Style, primitives::Line};
///
/// let line: Line<u8> = line!((10, 20), (30, 40));
/// let stroke_line: Line<u8> = line!((10, 20), (30, 40), stroke = Some(5u8));
/// ```
///
/// Style properties like `stroke` map to the method calls on the
/// [`WithStyle`](style/trait.WithStyle.html) trait. For example, the following code makes two
/// identical lines:
///
/// ```rust
/// use embedded_graphics::prelude::*;
/// use embedded_graphics::{line, style::Style, primitives::Line};
///
/// let Line: Line<u8> = line!((10, 20), (30, 40), stroke = Some(5u8), fill = Some(10u8));
/// let Line: Line<u8> = Line::new(Coord::new(10, 20), Coord::new(30, 40))
///     .stroke(Some(5u8))
///     .fill(Some(10u8));
/// ```
#[macro_export]
macro_rules! line {
    (($x1:expr, $y1:expr), ($x2:expr, $y2:expr) $(, $style_key:ident = $style_value:expr )* $(,)?) => {{
        #[allow(unused_imports)]
        use $crate::style::WithStyle;
        $crate::primitives::Line::new($crate::coord::Coord::new($x1, $y1), $crate::coord::Coord::new($x2, $y2))
            $( .$style_key($style_value) )*
    }};
}

/// Create a [`Rect`](./primitives/rect/struct.Rect.html) with optional styling using a
/// convenient macro.
///
/// ```rust
/// use embedded_graphics::{rect, style::Style, primitives::Rect};
///
/// let empty_rect: Rect<u8> = rect!((10, 20), (30, 40));
/// let filled_rect: Rect<u8> = rect!((10, 20), (30, 40), stroke = Some(5u8), fill = Some(10u8));
/// let rect_default_style: Rect<u8> = rect!((10, 20), (30, 40), style = Style::default());
/// ```
///
/// Style properties like `stroke` map to the method calls on the
/// [`WithStyle`](style/trait.WithStyle.html) trait. For example, the following code makes two
/// identical rectangles:
///
/// ```rust
/// use embedded_graphics::prelude::*;
/// use embedded_graphics::{rect, style::Style, primitives::Rect};
///
/// let Rect: Rect<u8> = rect!((10, 20), (30, 40), stroke = Some(5u8), fill = Some(10u8));
/// let Rect: Rect<u8> = Rect::new(Coord::new(10, 20), Coord::new(30, 40))
///     .stroke(Some(5u8))
///     .fill(Some(10u8));
/// ```
#[macro_export]
macro_rules! rect {
    (($x1:expr, $y1:expr), ($x2:expr, $y2:expr) $(, $style_key:ident = $style_value:expr )* $(,)?) => {{
        #[allow(unused_imports)]
        use $crate::style::WithStyle;
        $crate::primitives::Rect::new($crate::coord::Coord::new($x1, $y1), $crate::coord::Coord::new($x2, $y2))
            $( .$style_key($style_value) )*
    }};
}

/// Create a [`Triangle`](./primitives/triangle/struct.Triangle.html) with optional styling using a
/// convenient macro.
///
/// ```rust
/// use embedded_graphics::{triangle, style::Style, primitives::Triangle};
///
/// let empty_triangle: Triangle<u8> = triangle!((10, 20), (30, 40), (50, 60));
/// let filled_triangle: Triangle<u8> = triangle!((10, 20), (30, 40), (50, 60), stroke = Some(5u8), fill = Some(10u8));
/// let triangle_default_style: Triangle<u8> = triangle!((10, 20), (30, 40), (50, 60), style = Style::default());
/// ```
///
/// Style properties like `stroke` map to the method calls on the
/// [`WithStyle`](style/trait.WithStyle.html) trait. For example, the following code makes two
/// identical triangles:
///
/// ```rust
/// use embedded_graphics::prelude::*;
/// use embedded_graphics::{triangle, style::Style, primitives::Triangle};
///
/// let Triangle: Triangle<u8> = triangle!((10, 20), (30, 40), (50, 60), stroke = Some(5u8), fill = Some(10u8));
/// let Triangle: Triangle<u8> = Triangle::new(Coord::new(10, 20), Coord::new(30, 40), Coord::new(50, 60))
///     .stroke(Some(5u8))
///     .fill(Some(10u8));
/// ```
#[macro_export]
macro_rules! triangle {
    (($x1:expr, $y1:expr), ($x2:expr, $y2:expr), ($x3:expr, $y3:expr) $(, $style_key:ident = $style_value:expr )* $(,)?) => {{
        #[allow(unused_imports)]
        use $crate::style::WithStyle;
        $crate::primitives::Triangle::new($crate::coord::Coord::new($x1, $y1), $crate::coord::Coord::new($x2, $y2), $crate::coord::Coord::new($x3, $y3))
            $( .$style_key($style_value) )*
    }};
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::style::Style;

    #[test]
    fn circle() {
        let _c: Circle<u8> = circle!((10, 20), 30);
        let _c: Circle<u8> = circle!((10, 20), 30, stroke = Some(1u8), fill = Some(10u8));
        let _c: Circle<u8> = circle!((10, 20), 30, style = Style::default());
    }

    #[test]
    fn line() {
        let _l: Line<u8> = line!((10, 20), (30, 40));
        let _l: Line<u8> = line!((10, 20), (30, 40), stroke = Some(1u8), fill = Some(10u8));
        let _l: Line<u8> = line!((10, 20), (30, 40), style = Style::default());
    }

    #[test]
    fn rect() {
        let _r: Rect<u8> = rect!((10, 20), (30, 40));
        let _r: Rect<u8> = rect!((10, 20), (30, 40), stroke = Some(1u8), fill = Some(10u8));
        let _r: Rect<u8> = rect!((10, 20), (30, 40), style = Style::default());
    }

    #[test]
    fn triangle() {
        let _t: Triangle<u8> = triangle!((10, 20), (30, 40), (50, 60));
        let _t: Triangle<u8> = triangle!(
            (10, 20),
            (30, 40),
            (50, 60),
            stroke = Some(1u8),
            fill = Some(10u8)
        );
        let _t: Triangle<u8> = triangle!((10, 20), (30, 40), (50, 60), style = Style::default());
    }
}