pub struct PrimitiveStyleBuilder<C> where
C: PixelColor, { /* private fields */ }
Expand description
Primitive style builder.
Use this builder to create PrimitiveStyle
s. 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
sourceimpl<C> PrimitiveStyleBuilder<C> where
C: PixelColor,
impl<C> PrimitiveStyleBuilder<C> where
C: PixelColor,
sourcepub fn fill_color(self, fill_color: C) -> Self
pub fn fill_color(self, fill_color: C) -> Self
Sets the fill color.
sourcepub fn reset_fill_color(self) -> Self
pub fn reset_fill_color(self) -> Self
Resets the fill color to transparent.
sourcepub fn stroke_color(self, stroke_color: C) -> Self
pub fn stroke_color(self, stroke_color: C) -> Self
Sets the stroke color.
sourcepub fn reset_stroke_color(self) -> Self
pub fn reset_stroke_color(self) -> Self
Resets the stroke color to transparent.
sourcepub fn stroke_width(self, stroke_width: u32) -> Self
pub fn stroke_width(self, stroke_width: u32) -> Self
Sets the stroke width.
sourcepub fn stroke_alignment(self, stroke_alignment: StrokeAlignment) -> Self
pub fn stroke_alignment(self, stroke_alignment: StrokeAlignment) -> Self
Sets the stroke alignment.
sourcepub fn build(self) -> PrimitiveStyle<C>
pub fn build(self) -> PrimitiveStyle<C>
Builds the primitive style.
Trait Implementations
sourceimpl<C: Clone> Clone for PrimitiveStyleBuilder<C> where
C: PixelColor,
impl<C: Clone> Clone for PrimitiveStyleBuilder<C> where
C: PixelColor,
sourcefn clone(&self) -> PrimitiveStyleBuilder<C>
fn clone(&self) -> PrimitiveStyleBuilder<C>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<C: Debug> Debug for PrimitiveStyleBuilder<C> where
C: PixelColor,
impl<C: Debug> Debug for PrimitiveStyleBuilder<C> where
C: PixelColor,
sourceimpl<C: Default> Default for PrimitiveStyleBuilder<C> where
C: PixelColor,
impl<C: Default> Default for PrimitiveStyleBuilder<C> where
C: PixelColor,
sourcefn default() -> PrimitiveStyleBuilder<C>
fn default() -> PrimitiveStyleBuilder<C>
Returns the “default value” for a type. Read more
sourceimpl<C> From<&'_ PrimitiveStyle<C>> for PrimitiveStyleBuilder<C> where
C: PixelColor,
impl<C> From<&'_ PrimitiveStyle<C>> for PrimitiveStyleBuilder<C> where
C: PixelColor,
sourcefn from(style: &PrimitiveStyle<C>) -> Self
fn from(style: &PrimitiveStyle<C>) -> Self
Performs the conversion.
sourceimpl<C: Hash> Hash for PrimitiveStyleBuilder<C> where
C: PixelColor,
impl<C: Hash> Hash for PrimitiveStyleBuilder<C> where
C: PixelColor,
sourceimpl<C: Ord> Ord for PrimitiveStyleBuilder<C> where
C: PixelColor,
impl<C: Ord> Ord for PrimitiveStyleBuilder<C> where
C: PixelColor,
sourceimpl<C: PartialEq> PartialEq<PrimitiveStyleBuilder<C>> for PrimitiveStyleBuilder<C> where
C: PixelColor,
impl<C: PartialEq> PartialEq<PrimitiveStyleBuilder<C>> for PrimitiveStyleBuilder<C> where
C: PixelColor,
sourcefn eq(&self, other: &PrimitiveStyleBuilder<C>) -> bool
fn eq(&self, other: &PrimitiveStyleBuilder<C>) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &PrimitiveStyleBuilder<C>) -> bool
fn ne(&self, other: &PrimitiveStyleBuilder<C>) -> bool
This method tests for !=
.
sourceimpl<C: PartialOrd> PartialOrd<PrimitiveStyleBuilder<C>> for PrimitiveStyleBuilder<C> where
C: PixelColor,
impl<C: PartialOrd> PartialOrd<PrimitiveStyleBuilder<C>> for PrimitiveStyleBuilder<C> where
C: PixelColor,
sourcefn partial_cmp(&self, other: &PrimitiveStyleBuilder<C>) -> Option<Ordering>
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 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl<C: Copy> Copy for PrimitiveStyleBuilder<C> where
C: PixelColor,
impl<C: Eq> Eq for PrimitiveStyleBuilder<C> where
C: PixelColor,
impl<C> StructuralEq for PrimitiveStyleBuilder<C> where
C: PixelColor,
impl<C> StructuralPartialEq for PrimitiveStyleBuilder<C> where
C: PixelColor,
Auto Trait Implementations
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> CheckedAs for T
impl<T> CheckedAs for T
sourcepub fn checked_as<Dst>(self) -> Option<Dst> where
T: CheckedCast<Dst>,
pub fn checked_as<Dst>(self) -> Option<Dst> where
T: CheckedCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> CheckedCastFrom<Src> for Dst where
Src: CheckedCast<Dst>,
impl<Src, Dst> CheckedCastFrom<Src> for Dst where
Src: CheckedCast<Dst>,
sourcepub fn checked_cast_from(src: Src) -> Option<Dst>
pub fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.
sourceimpl<T> OverflowingAs for T
impl<T> OverflowingAs for T
sourcepub fn overflowing_as<Dst>(self) -> (Dst, bool) where
T: OverflowingCast<Dst>,
pub fn overflowing_as<Dst>(self) -> (Dst, bool) where
T: OverflowingCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> OverflowingCastFrom<Src> for Dst where
Src: OverflowingCast<Dst>,
impl<Src, Dst> OverflowingCastFrom<Src> for Dst where
Src: OverflowingCast<Dst>,
sourcepub fn overflowing_cast_from(src: Src) -> (Dst, bool)
pub fn overflowing_cast_from(src: Src) -> (Dst, bool)
OverflowingCasts the value.
sourceimpl<T> SaturatingAs for T
impl<T> SaturatingAs for T
sourcepub fn saturating_as<Dst>(self) -> Dst where
T: SaturatingCast<Dst>,
pub fn saturating_as<Dst>(self) -> Dst where
T: SaturatingCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> SaturatingCastFrom<Src> for Dst where
Src: SaturatingCast<Dst>,
impl<Src, Dst> SaturatingCastFrom<Src> for Dst where
Src: SaturatingCast<Dst>,
sourcepub fn saturating_cast_from(src: Src) -> Dst
pub fn saturating_cast_from(src: Src) -> Dst
Casts the value.
sourceimpl<T> UnwrappedAs for T
impl<T> UnwrappedAs for T
sourcepub fn unwrapped_as<Dst>(self) -> Dst where
T: UnwrappedCast<Dst>,
pub fn unwrapped_as<Dst>(self) -> Dst where
T: UnwrappedCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> UnwrappedCastFrom<Src> for Dst where
Src: UnwrappedCast<Dst>,
impl<Src, Dst> UnwrappedCastFrom<Src> for Dst where
Src: UnwrappedCast<Dst>,
sourcepub fn unwrapped_cast_from(src: Src) -> Dst
pub fn unwrapped_cast_from(src: Src) -> Dst
UnwrappedCasts the value.
sourceimpl<T> WrappingAs for T
impl<T> WrappingAs for T
sourcepub fn wrapping_as<Dst>(self) -> Dst where
T: WrappingCast<Dst>,
pub fn wrapping_as<Dst>(self) -> Dst where
T: WrappingCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> WrappingCastFrom<Src> for Dst where
Src: WrappingCast<Dst>,
impl<Src, Dst> WrappingCastFrom<Src> for Dst where
Src: WrappingCast<Dst>,
sourcepub fn wrapping_cast_from(src: Src) -> Dst
pub fn wrapping_cast_from(src: Src) -> Dst
WrappingCasts the value.