embedded_graphics::style

Struct PrimitiveStyle

Source
#[non_exhaustive]
pub struct PrimitiveStyle<C>
where C: PixelColor,
{ pub fill_color: Option<C>, pub stroke_color: Option<C>, pub stroke_width: u32, }
Expand description

Style properties for primitives.

PrimitiveStyle can be applied to a primitive to define how the primitive is drawn.

Because PrimitiveStyle has the non_exhaustive attribute, it cannot be created using a struct literal. To create a PrimitiveStyle, use the primitive_style! macro or PrimitiveStyleBuilder.

Fields (Non-exhaustive)§

This struct is marked as 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.
§fill_color: Option<C>

Fill color of the primitive.

If fill_color is set to None no fill will be drawn.

§stroke_color: Option<C>

Stroke color of the primitive.

If stroke_color is set to None or the stroke_width is set to 0 no stroke will be drawn.

§stroke_width: u32

Stroke width in pixels.

Implementations§

Source§

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

Source

pub fn new() -> Self

Creates a primitive style without fill and stroke.

Source

pub fn with_stroke(stroke_color: C, stroke_width: u32) -> Self

Creates a stroke primitive style.

If the stroke_width is 0 the resulting style won’t draw a stroke.

Source

pub fn with_fill(fill_color: C) -> Self

Creates a fill primitive style.

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> PrimitiveStyle<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 PrimitiveStyle<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 PrimitiveStyle<C>
where C: PixelColor,

Source§

fn default() -> Self

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

impl<C> Hash for PrimitiveStyle<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 PrimitiveStyle<C>
where C: PixelColor + Ord,

Source§

fn cmp(&self, other: &PrimitiveStyle<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,

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

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

Source§

fn eq(&self, other: &PrimitiveStyle<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 PrimitiveStyle<C>

Source§

fn partial_cmp(&self, other: &PrimitiveStyle<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 PrimitiveStyle<C>
where C: PixelColor + Copy,

Source§

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

Source§

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

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

impl<C> UnwindSafe for PrimitiveStyle<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> 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<T> CloneToUninit for T
where T: Clone,

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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.

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.