Struct embedded_graphics::mono_font::MonoTextStyle

#[non_exhaustive]
pub struct MonoTextStyle<'a, C> {
    pub text_color: Option<C>,
    pub background_color: Option<C>,
    pub underline_color: DecorationColor<C>,
    pub strikethrough_color: DecorationColor<C>,
    pub font: &'a MonoFont<'a>,
}

Style properties for text using a monospaced font.

A MonoTextStyle can be applied to a Text object to define how the text is drawn.

Because MonoTextStyle has the non_exhaustive attribute, it cannot be created using a struct literal. To create a MonoTextStyle with a given text color and transparent background, use the new method. For more complex text styles, use the MonoTextStyleBuilder.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

text_color: Option<C>

Text color.

background_color: Option<C>

Background color.

underline_color: DecorationColor<C>

Underline color.

strikethrough_color: DecorationColor<C>

Strikethrough color.

font: &'a MonoFont<'a>

Font.

Implementations

impl<'a, C: PixelColor> MonoTextStyle<'a, C>

pub fn new(font: &'a MonoFont<'a>, text_color: C) -> Self

Creates a text style with transparent background.

pub fn is_transparent(&self) -> bool

Returns true if the style is transparent.

Drawing a Text with a transparent MonoTextStyle will not draw any pixels.

Trait Implementations

impl<C: PixelColor> CharacterStyle for MonoTextStyle<'_, C>

type Color = C

The color type.

fn set_text_color(&mut self, text_color: Option<Self::Color>)

Sets the text color.

fn set_background_color(&mut self, background_color: Option<Self::Color>)

Sets the background color.

fn set_underline_color(&mut self, underline_color: DecorationColor<Self::Color>)

Sets the underline color.

fn set_strikethrough_color(
    &mut self,
    strikethrough_color: DecorationColor<Self::Color>
)

Sets the strikethrough color.

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

fn clone(&self) -> MonoTextStyle<'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 MonoTextStyle<'a, C>

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

Formats the value using the given formatter.

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

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

Performs the conversion.

impl<'a, C: PartialEq> PartialEq<MonoTextStyle<'a, C>> for MonoTextStyle<'a, C>

fn eq(&self, other: &MonoTextStyle<'a, C>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MonoTextStyle<'a, C>) -> bool

This method tests for !=.

impl<C: PixelColor> TextRenderer for MonoTextStyle<'_, C>

type Color = C

Color type.

fn draw_string<D>(
    &self,
    text: &str,
    position: Point,
    baseline: Baseline,
    target: &mut D
) -> Result<Point, D::Error> where
    D: DrawTarget<Color = Self::Color>, 

Draws a string.

fn draw_whitespace<D>(
    &self,
    width: u32,
    position: Point,
    baseline: Baseline,
    target: &mut D
) -> Result<Point, D::Error> where
    D: DrawTarget<Color = Self::Color>, 

Draws whitespace of the given width.

fn measure_string(
    &self,
    text: &str,
    position: Point,
    baseline: Baseline
) -> TextMetrics

Returns the text metrics for a string.

fn line_height(&self) -> u32

Returns the default line height.

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

impl<'a, C> StructuralPartialEq for MonoTextStyle<'a, C>