Struct TextStyleBuilder

pub struct TextStyleBuilder<C, F>
where
    C: PixelColor,
    F: Font + Clone,
{ /* private fields */ }

Text style builder.

Use this builder to create TextStyles for Text.

The text_style! macro can also be used to create TextStyles, but with a shorter syntax. See the text_style! documentation for examples.

Examples

Render yellow text on a blue background

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

use embedded_graphics::{
    fonts::{Font6x8, Text},
    pixelcolor::Rgb565,
    prelude::*,
    style::{TextStyle, TextStyleBuilder},
};

let style: TextStyle<Rgb565, Font6x8> = TextStyleBuilder::new(Font6x8)
    .text_color(Rgb565::YELLOW)
    .background_color(Rgb565::BLUE)
    .build();

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

Render black text on white background using macros

This uses the Font8x16 font with the egtext! and text_style! macros for shorter code.

use embedded_graphics::{
    egtext,
    fonts::{Font8x16, Text},
    pixelcolor::Rgb565,
    prelude::*,
    style::TextStyle,
    text_style,
};

let style = text_style!(
    font = Font8x16,
    text_color = Rgb565::WHITE,
    background_color = Rgb565::BLACK
);

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

Transparent background

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

use embedded_graphics::{
    egtext,
    fonts::{Font6x8, Text},
    pixelcolor::Rgb565,
    prelude::*,
    style::{TextStyle, TextStyleBuilder},
    text_style,
};

let style: TextStyle<Rgb565, Font6x8> = TextStyleBuilder::new(Font6x8)
    .text_color(Rgb565::WHITE)
    .build();

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

Implementations

impl<C, F> TextStyleBuilder<C, F>

where C: PixelColor, F: Font + Clone,

pub fn new(font: F) -> Self

Creates a new text style builder with a given font.

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

Sets the text color.

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

Sets the background color.

pub fn build(self) -> TextStyle<C, F>

Builds the text style.

Trait Implementations

impl<C, F> Clone for TextStyleBuilder<C, F>

where C: PixelColor + Clone, F: Font + Clone + Clone,

fn clone(&self) -> TextStyleBuilder<C, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C, F> Debug for TextStyleBuilder<C, F>

where C: PixelColor + Debug, F: Font + Clone + Debug,

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

Formats the value using the given formatter.

impl<C, F> Default for TextStyleBuilder<C, F>

where C: PixelColor + Default, F: Font + Clone + Default,

fn default() -> TextStyleBuilder<C, F>

Returns the “default value” for a type.

impl<C, F> Hash for TextStyleBuilder<C, F>

where C: PixelColor + Hash, F: Font + Clone + Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<C, F> Ord for TextStyleBuilder<C, F>

where C: PixelColor + Ord, F: Font + Clone + Ord,

fn cmp(&self, other: &TextStyleBuilder<C, F>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<C, F> PartialEq for TextStyleBuilder<C, F>

where C: PixelColor + PartialEq, F: Font + Clone + PartialEq,

fn eq(&self, other: &TextStyleBuilder<C, F>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<C, F> PartialOrd for TextStyleBuilder<C, F>

where C: PixelColor + PartialOrd, F: Font + Clone + PartialOrd,

fn partial_cmp(&self, other: &TextStyleBuilder<C, F>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<C, F> Copy for TextStyleBuilder<C, F>

where C: PixelColor + Copy, F: Font + Clone + Copy,

impl<C, F> Eq for TextStyleBuilder<C, F>

where C: PixelColor + Eq, F: Font + Clone + Eq,

impl<C, F> StructuralPartialEq for TextStyleBuilder<C, F>

where C: PixelColor, F: Font + Clone,

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.