pub struct PrimitiveStyleBuilder<C>
where C: PixelColor,
{ /* private fields */ }
Expand description

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.

§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 has its top-left at (10, 10) with a diameter of 20px.

use embedded_graphics::{
    pixelcolor::Rgb565,
    prelude::*,
    primitives::{Circle, 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(10, 10), 20).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::{
    pixelcolor::Rgb565,
    prelude::*,
    primitives::{Rectangle, PrimitiveStyle, PrimitiveStyleBuilder},
};

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

let rectangle = Rectangle::new(Point::new(20, 20), Size::new(20, 10)).into_styled(style);

Implementations§

source§

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

source

pub fn new() -> Self

Creates a new primitive style builder.

source

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

Sets the fill color.

source

pub fn reset_fill_color(self) -> Self

Resets the fill color to transparent.

source

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

Sets the stroke color.

source

pub fn reset_stroke_color(self) -> Self

Resets the stroke color to transparent.

source

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

Sets the stroke width.

source

pub fn stroke_alignment(self, stroke_alignment: StrokeAlignment) -> Self

Sets the stroke alignment.

source

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

Builds the primitive style.

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn default() -> PrimitiveStyleBuilder<C>

Returns the “default value” for a type. Read more
source§

impl<C> From<&PrimitiveStyle<C>> for PrimitiveStyleBuilder<C>
where C: PixelColor,

source§

fn from(style: &PrimitiveStyle<C>) -> Self

Converts to this type from the input type.
source§

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

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

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

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

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

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl<C> PartialOrd for PrimitiveStyleBuilder<C>

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

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

source§

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

source§

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

Auto Trait Implementations§

§

impl<C> Freeze for PrimitiveStyleBuilder<C>
where C: Freeze,

§

impl<C> RefUnwindSafe for PrimitiveStyleBuilder<C>
where C: RefUnwindSafe,

§

impl<C> Send for PrimitiveStyleBuilder<C>
where C: Send,

§

impl<C> Sync for PrimitiveStyleBuilder<C>
where C: Sync,

§

impl<C> Unpin for PrimitiveStyleBuilder<C>
where C: Unpin,

§

impl<C> UnwindSafe for PrimitiveStyleBuilder<C>
where C: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Az for T

source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

source§

fn cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> CheckedAs for T

source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> OverflowingAs for T

source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
source§

impl<T> SaturatingAs for T

source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> UnwrappedAs for T

source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> WrappingAs for T

source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.