Struct embedded_graphics::primitives::PrimitiveStyle[−][src]

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

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, the with_stroke and with_fill methods can be used for styles that only require a stroke or fill respectively. For more complex styles, use the 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.

stroke_alignment: StrokeAlignment

Stroke alignment.

The stroke alignment sets if the stroke is drawn inside, outside or centered on the outline of a shape.

This property only applies to closed shapes (rectangle, circle, …) and is ignored for open shapes (line, …).

Implementations

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

pub fn new() -> Self[src]

Creates a primitive style without fill and stroke.

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

Creates a stroke primitive style.

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

pub fn with_fill(fill_color: C) -> Self[src]

Creates a fill primitive style.

pub fn is_transparent(&self) -> bool[src]

Returns if a primitive drawn with this style is completely transparent.

Trait Implementations

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

fn clone(&self) -> PrimitiveStyle<C>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0 [src]

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

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

fn default() -> Self[src]

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

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

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

Performs the conversion.

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

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

Feeds this value into the given Hasher. Read more

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

1.3.0 [src]

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

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

fn cmp(&self, other: &PrimitiveStyle<C>) -> Ordering[src]

This method returns an Ordering between self and other. Read more

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

1.21.0 [src]

Compares and returns the maximum of two values. Read more

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

1.21.0 [src]

Compares and returns the minimum of two values. Read more

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

1.50.0 [src]

Restrict a value to a certain interval. Read more

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

fn eq(&self, other: &PrimitiveStyle<C>) -> bool[src]

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

fn ne(&self, other: &PrimitiveStyle<C>) -> bool[src]

This method tests for !=.

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

fn partial_cmp(&self, other: &PrimitiveStyle<C>) -> Option<Ordering>[src]

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

#[must_use]
fn lt(&self, other: &Rhs) -> bool

1.0.0 [src]

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

#[must_use]
fn le(&self, other: &Rhs) -> bool

1.0.0 [src]

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

#[must_use]
fn gt(&self, other: &Rhs) -> bool

1.0.0 [src]

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

#[must_use]
fn ge(&self, other: &Rhs) -> bool

1.0.0 [src]

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

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for Arc[src]

fn styled_bounding_box(&self, style: &PrimitiveStyle<C>) -> Rectangle[src]

Returns the bounding box using the given style.

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for Circle[src]

fn styled_bounding_box(&self, style: &PrimitiveStyle<C>) -> Rectangle[src]

Returns the bounding box using the given style.

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for Ellipse[src]

fn styled_bounding_box(&self, style: &PrimitiveStyle<C>) -> Rectangle[src]

Returns the bounding box using the given style.

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for Line[src]

fn styled_bounding_box(&self, style: &PrimitiveStyle<C>) -> Rectangle[src]

Returns the bounding box using the given style.

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for Polyline<'_>[src]

fn styled_bounding_box(&self, style: &PrimitiveStyle<C>) -> Rectangle[src]

Returns the bounding box using the given style.

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for Rectangle[src]

fn styled_bounding_box(&self, style: &PrimitiveStyle<C>) -> Rectangle[src]

Returns the bounding box using the given style.

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for RoundedRectangle[src]

fn styled_bounding_box(&self, style: &PrimitiveStyle<C>) -> Rectangle[src]

Returns the bounding box using the given style.

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for Sector[src]

fn styled_bounding_box(&self, style: &PrimitiveStyle<C>) -> Rectangle[src]

Returns the bounding box using the given style.

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for Triangle[src]

fn styled_bounding_box(&self, style: &PrimitiveStyle<C>) -> Rectangle[src]

Returns the bounding box using the given style.

impl<C: PixelColor> StyledDrawable<PrimitiveStyle<C>> for Arc[src]

type Color = C

Color type.

type Output = ()

Output type.

fn draw_styled<D>(
    &self, 
    style: &PrimitiveStyle<C>, 
    target: &mut D
) -> Result<Self::Output, D::Error> where
    D: DrawTarget<Color = C>,

Draws the primitive using the given style.

impl<C: PixelColor> StyledDrawable<PrimitiveStyle<C>> for Circle[src]

type Color = C

Color type.

type Output = ()

Output type.

fn draw_styled<D>(
    &self, 
    style: &PrimitiveStyle<C>, 
    target: &mut D
) -> Result<Self::Output, D::Error> where
    D: DrawTarget<Color = C>,

Draws the primitive using the given style.

impl<C: PixelColor> StyledDrawable<PrimitiveStyle<C>> for Ellipse[src]

type Color = C

Color type.

type Output = ()

Output type.

fn draw_styled<D>(
    &self, 
    style: &PrimitiveStyle<C>, 
    target: &mut D
) -> Result<Self::Output, D::Error> where
    D: DrawTarget<Color = C>,

Draws the primitive using the given style.

impl<C: PixelColor> StyledDrawable<PrimitiveStyle<C>> for Line[src]

type Color = C

Color type.

type Output = ()

Output type.

fn draw_styled<D>(
    &self, 
    style: &PrimitiveStyle<C>, 
    target: &mut D
) -> Result<Self::Output, D::Error> where
    D: DrawTarget<Color = C>,

Draws the primitive using the given style.

impl<C: PixelColor> StyledDrawable<PrimitiveStyle<C>> for Polyline<'_>[src]

type Color = C

Color type.

type Output = ()

Output type.

fn draw_styled<D>(
    &self, 
    style: &PrimitiveStyle<C>, 
    target: &mut D
) -> Result<Self::Output, D::Error> where
    D: DrawTarget<Color = C>,

Draws the primitive using the given style.

impl<C: PixelColor> StyledDrawable<PrimitiveStyle<C>> for Rectangle[src]

type Color = C

Color type.

type Output = ()

Output type.

fn draw_styled<D>(
    &self, 
    style: &PrimitiveStyle<C>, 
    target: &mut D
) -> Result<Self::Output, D::Error> where
    D: DrawTarget<Color = C>,

Draws the primitive using the given style.

impl<C: PixelColor> StyledDrawable<PrimitiveStyle<C>> for RoundedRectangle[src]

type Color = C

Color type.

type Output = ()

Output type.

fn draw_styled<D>(
    &self, 
    style: &PrimitiveStyle<C>, 
    target: &mut D
) -> Result<Self::Output, D::Error> where
    D: DrawTarget<Color = C>,

Draws the primitive using the given style.

impl<C: PixelColor> StyledDrawable<PrimitiveStyle<C>> for Sector[src]

type Color = C

Color type.

type Output = ()

Output type.

fn draw_styled<D>(
    &self, 
    style: &PrimitiveStyle<C>, 
    target: &mut D
) -> Result<Self::Output, D::Error> where
    D: DrawTarget<Color = C>,

Draws the primitive using the given style.

impl<C: PixelColor> StyledDrawable<PrimitiveStyle<C>> for Triangle[src]

type Color = C

Color type.

type Output = ()

Output type.

fn draw_styled<D>(
    &self, 
    style: &PrimitiveStyle<C>, 
    target: &mut D
) -> Result<Self::Output, D::Error> where
    D: DrawTarget<Color = C>,

Draws the primitive using the given style.

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

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

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

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

Auto Trait Implementations

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

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Az for T[src]

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

Casts the value.

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

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> CheckedAs for T[src]

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

Casts the value.

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

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

pub fn into(self) -> U[src]

Performs the conversion.

impl<Src, Dst> LosslessTryInto<Dst> for Src where
    Dst: LosslessTryFrom<Src>,

pub fn lossless_try_into(self) -> Option<Dst>[src]

Performs the conversion.

impl<Src, Dst> LossyInto<Dst> for Src where
    Dst: LossyFrom<Src>,

pub fn lossy_into(self) -> Dst[src]

Performs the conversion.

impl<T> OverflowingAs for T[src]

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

Casts the value.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> SaturatingAs for T[src]

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

Casts the value.

impl<T> Scalar for T where
    T: Copy + PartialEq<T> + Debug + Any,

pub fn inlined_clone(&self) -> T[src]

Performance hack: Clone doesn’t get inlined for Copy types in debug mode, so make it inline anyway.

fn is<T>() -> bool where
    T: Scalar,

Tests if Self the same as the type T Read more

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>,

pub fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

pub fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

pub fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

pub fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

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

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

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

Performs the conversion.

impl<T> UnwrappedAs for T[src]

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

Casts the value.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> WrappingAs for T[src]

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

Casts the value.