Struct embedded_graphics::mono_font::MonoTextStyleBuilder

pub struct MonoTextStyleBuilder<'a, C> { /* private fields */ }

Text style builder for monospaced fonts.

Use this builder to create MonoTextStyles for Text.

Examples

Render yellow text on a blue background

This uses the FONT_6X9 font, but other fonts can also be used.

use embedded_graphics::{
    mono_font::{ascii::FONT_6X9, MonoTextStyle, MonoTextStyleBuilder},
    pixelcolor::Rgb565,
    prelude::*,
    text::Text,
};

let style = MonoTextStyleBuilder::new()
    .font(&FONT_6X9)
    .text_color(Rgb565::YELLOW)
    .background_color(Rgb565::BLUE)
    .build();

let text = Text::new("Hello Rust!", Point::new(0, 0), style);

Transparent background

If a property is omitted, it will remain at its default value in the resulting MonoTextStyle returned by .build(). This example draws white text with no background at all.

use embedded_graphics::{
    mono_font::{ascii::FONT_6X9, MonoTextStyle, MonoTextStyleBuilder},
    pixelcolor::Rgb565,
    prelude::*,
    text::Text,
};

let style = MonoTextStyleBuilder::new()
    .font(&FONT_6X9)
    .text_color(Rgb565::WHITE)
    .build();

let text = Text::new("Hello Rust!", Point::new(0, 0), style);

Modifying an existing style

The builder can also be used to modify an existing style.

use embedded_graphics::{
    mono_font::{ascii::{FONT_6X9, FONT_10X20}, MonoTextStyle, MonoTextStyleBuilder},
    pixelcolor::Rgb565,
    prelude::*,
    text::Text,
};

let style = MonoTextStyle::new(&FONT_6X9, Rgb565::YELLOW);

let style_larger = MonoTextStyleBuilder::from(&style)
    .font(&FONT_10X20)
    .build();

Implementations

impl<'a, C> MonoTextStyleBuilder<'a, C>where C: PixelColor,

pub const fn new() -> Self

Creates a new text style builder.

pub const fn font<'b>( self, font: &'b MonoFont<'b> ) -> MonoTextStyleBuilder<'b, C>

Sets the font.

pub const fn underline(self) -> Self

Enables underline using the text color.

pub const fn strikethrough(self) -> Self

Enables strikethrough using the text color.

pub const fn reset_text_color(self) -> Self

Resets the text color to transparent.

pub const fn reset_background_color(self) -> Self

Resets the background color to transparent.

pub const fn reset_underline(self) -> Self

Removes the underline decoration.

pub const fn reset_strikethrough(self) -> Self

Removes the strikethrough decoration.

pub const fn text_color(self, text_color: C) -> Self

Sets the text color.

pub const fn background_color(self, background_color: C) -> Self

Sets the background color.

pub const fn underline_with_color(self, underline_color: C) -> Self

Enables underline with a custom color.

pub const fn strikethrough_with_color(self, strikethrough_color: C) -> Self

Enables strikethrough with a custom color.

pub const fn build(self) -> MonoTextStyle<'a, C>

Builds the text style.

This method can only be called after a font was set by using the font method. All other settings are optional and they will be set to their default value if they are missing.

Trait Implementations

impl<'a, C: Clone> Clone for MonoTextStyleBuilder<'a, C>

fn clone(&self) -> MonoTextStyleBuilder<'a, C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, C: Debug> Debug for MonoTextStyleBuilder<'a, C>

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

Formats the value using the given formatter.

impl<'a, C> Format for MonoTextStyleBuilder<'a, C>where C: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl<'a, C> From<&MonoTextStyle<'a, C>> for MonoTextStyleBuilder<'a, C>where C: PixelColor,

fn from(style: &MonoTextStyle<'a, C>) -> Self

Converts to this type from the input type.

impl<'a, C: Copy> Copy for MonoTextStyleBuilder<'a, C>