embedded-graphics 0.4.7

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

//! Pixel based fonts

mod font12x16;
mod font6x12;
mod font6x8;
mod font8x16;
pub mod font_builder;

pub use self::font12x16::Font12x16;
pub use self::font6x12::Font6x12;
pub use self::font6x8::Font6x8;
pub use self::font8x16::Font8x16;
use drawable::Dimensions;
use pixelcolor::PixelColor;
use style::WithStyle;
use unsignedcoord::UnsignedCoord;

/// Common methods for all fonts
pub trait Font<'a, C>: WithStyle<C> + Dimensions
where
    C: PixelColor,
{
    /// Render a string in the implementing font's typeface.
    ///
    /// Defaults to 1u8 for stroke_color and 0u8 for fill_color
    ///
    /// ```rust
    /// # use embedded_graphics::fonts::{Font, Font6x8};
    /// # use embedded_graphics::prelude::*;
    /// # use embedded_graphics::pixelcolor::PixelColorU8;
    /// #
    /// # struct Display {}
    /// # impl Display {
    /// #     pub fn draw<T>(&self, item_pixels: T) -> Result<(), ()>
    /// #     where
    /// #         T: Iterator<Item = Pixel<PixelColorU8>>,
    /// #     {
    /// #         Ok(())
    /// #     }
    /// # }
    /// #
    /// fn main() {
    ///     let disp: Display = Display {};
    ///     // Render a string with a 8bit color
    ///     let text = Font6x8::render_str("Hello world")
    ///         .with_style(Style::with_stroke(1u8.into()));
    ///
    ///     disp.draw(text.into_iter());
    /// }
    /// ```
    fn render_str(chars: &'a str) -> Self;

    /// Get the dimensions of a piece of text rendered in a particular font
    #[deprecated(since = "0.4.5", note = "use `.size()` instead")]
    fn dimensions(&self) -> UnsignedCoord;
}