Struct embedded_graphics::style::PrimitiveStyleBuilder

pub struct PrimitiveStyleBuilder<C> where
    C: PixelColor,  { /* fields omitted */ }

Primitive style builder.

Use this builder to create PrimitiveStyles. If any properties on the builder are omitted, the value will remain at its default value.

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

Examples

Build a style with configured stroke and fill

This example builds a style for a circle with a 3px red stroke and a solid green fill. The circle is centered at (20, 20) with a radius of 10px.

use embedded_graphics::{
    egtext,
    pixelcolor::Rgb565,
    prelude::*,
    primitives::Circle,
    style::{PrimitiveStyle, PrimitiveStyleBuilder},
};

let style: PrimitiveStyle<Rgb565> = PrimitiveStyleBuilder::new()
    .stroke_color(Rgb565::RED)
    .stroke_width(3)
    .fill_color(Rgb565::GREEN)
    .build();

let circle = Circle::new(Point::new(20, 20), 10).into_styled(style);

Build a style with stroke and no fill

This example builds a style for a rectangle with a 1px red stroke. Because .fill_color() is not called, the fill color remains the default value of None (i.e. transparent).

use embedded_graphics::{
    egtext,
    pixelcolor::Rgb565,
    prelude::*,
    primitives::Rectangle,
    style::{PrimitiveStyle, PrimitiveStyleBuilder},
};

let style: PrimitiveStyle<Rgb565> = PrimitiveStyleBuilder::new()
    .stroke_color(Rgb565::RED)
    .stroke_width(1)
    .build();

let rectangle = Rectangle::new(Point::new(20, 20), Point::new(40, 30)).into_styled(style);

Methods

impl<C> PrimitiveStyleBuilder<C> where
    C: PixelColor, 

pub fn new() -> Self

Creates a new primitive style builder.

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

Sets the fill color.

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

Sets the stroke color.

pub fn stroke_width(self, stroke_width: u32) -> Self

Sets the stroke width.

pub fn build(self) -> PrimitiveStyle<C>

Builds the primitive style.

Trait Implementations

impl<C: Clone> Clone for PrimitiveStyleBuilder<C> where
    C: PixelColor, 

fn clone(&self) -> PrimitiveStyleBuilder<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Copy> Copy for PrimitiveStyleBuilder<C> where
    C: PixelColor, 

impl<C: Debug> Debug for PrimitiveStyleBuilder<C> where
    C: PixelColor, 

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

Formats the value using the given formatter.

impl<C: Default> Default for PrimitiveStyleBuilder<C> where
    C: PixelColor, 

fn default() -> PrimitiveStyleBuilder<C>

Returns the "default value" for a type.

impl<C: Eq> Eq for PrimitiveStyleBuilder<C> where
    C: PixelColor, 

impl<C: Hash> Hash for PrimitiveStyleBuilder<C> where
    C: PixelColor, 

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, 

Feeds a slice of this type into the given [Hasher].

impl<C: Ord> Ord for PrimitiveStyleBuilder<C> where
    C: PixelColor, 

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<C: PartialEq> PartialEq<PrimitiveStyleBuilder<C>> for PrimitiveStyleBuilder<C> where
    C: PixelColor, 

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

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

fn ne(&self, other: &PrimitiveStyleBuilder<C>) -> bool

This method tests for !=.

impl<C: PartialOrd> PartialOrd<PrimitiveStyleBuilder<C>> for PrimitiveStyleBuilder<C> where
    C: PixelColor, 

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

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

fn lt(&self, other: &PrimitiveStyleBuilder<C>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &PrimitiveStyleBuilder<C>) -> bool

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

fn gt(&self, other: &PrimitiveStyleBuilder<C>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &PrimitiveStyleBuilder<C>) -> bool

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

impl<C> StructuralEq for PrimitiveStyleBuilder<C> where
    C: PixelColor, 

impl<C> StructuralPartialEq for PrimitiveStyleBuilder<C> where
    C: PixelColor,