Struct embedded_graphics::fonts::font_builder::FontBuilder

pub struct FontBuilder<'a, C: PixelColor, Conf> {
    pub pos: Coord,
    // some fields omitted
}

The font builder

This is a helper struct to reduce code duplication when implementing fonts. View the module level type definitions for a list of usable fonts.

Fields

pos: Coord

Top left corner of the text

Trait Implementations

impl<'a, C: PixelColor + Clone, Conf> Clone for FontBuilder<'a, C, Conf>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, C: PixelColor + Copy, Conf> Copy for FontBuilder<'a, C, Conf>

impl<'a, C: Debug + PixelColor, Conf: Debug> Debug for FontBuilder<'a, C, Conf>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'a, C, Conf> Dimensions for FontBuilder<'a, C, Conf> where
    C: PixelColor,
    Conf: FontBuilderConf, 

fn top_left(&self) -> Coord

Get the top left corner of the bounding box for an object

fn bottom_right(&self) -> Coord

Get the bottom right corner of the bounding box for an object

fn size(&self) -> UnsignedCoord

Get the bounding box of a piece of text

Currently does not handle newlines (but neither does the rasteriser). It will give (0, 0) if the string to render is empty.

impl<'a, C: 'a, Conf: 'a> Drawable for FontBuilder<'a, C, Conf> where
    C: PixelColor,
    Conf: FontBuilderConf, 

impl<'a, C, Conf> Font<'a, C> for FontBuilder<'a, C, Conf> where
    C: PixelColor,
    Conf: FontBuilderConf, 

fn render_str(text: &'a str) -> Self

Render a string in the implementing font's typeface.

impl<'a, C: 'a, Conf: 'a> IntoIterator for FontBuilder<'a, C, Conf> where
    C: PixelColor,
    Conf: FontBuilderConf, 

type Item = Pixel<C>

The type of the elements being iterated over.

type IntoIter = FontBuilderIterator<'a, C, Conf>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, C, Conf> IntoIterator for &'a FontBuilder<'a, C, Conf> where
    C: PixelColor,
    Conf: FontBuilderConf, 

type IntoIter = FontBuilderIterator<'a, C, Conf>

Which kind of iterator are we turning this into?

type Item = Pixel<C>

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, C, Conf> Transform for FontBuilder<'a, C, Conf> where
    C: PixelColor, 

fn translate(&self, by: Coord) -> Self

Translate the image from its current position to a new position by (x, y) pixels, returning a new Font8x16. For a mutating transform, see translate_mut.

// 8px x 1px test image
let text = Font8x16::render_str("Hello world")
let moved = text.translate(Coord::new(25, 30));

assert_eq!(text.pos, Coord::new(0, 0));
assert_eq!(moved.pos, Coord::new(25, 30));

fn translate_mut(&mut self, by: Coord) -> &mut Self

Translate the font origin from its current position to a new position by (x, y) pixels.

// 8px x 1px test image
let mut text = Font8x16::render_str("Hello world")
text.translate_mut(Coord::new(25, 30));

assert_eq!(text.pos, Coord::new(25, 30));

impl<'a, C, Conf> WithStyle<C> for FontBuilder<'a, C, Conf> where
    C: PixelColor, 

fn style(self, style: Style<C>) -> Self

Add a complete style to the object

fn stroke(self, color: Option<C>) -> Self

Set the stroke colour for the object

fn stroke_width(self, _width: u8) -> Self

Set the stroke width for the object

fn fill(self, color: Option<C>) -> Self

Set the fill property of the object's style