Struct embedded_graphics::primitives::PrimitiveStyle

#[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,
}

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)

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 const fn new() -> Self

Creates a primitive style without fill and stroke.

pub const 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.

pub const fn with_fill(fill_color: C) -> Self

Creates a fill primitive style.

pub const fn is_transparent(&self) -> bool

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

Trait Implementations

impl<C> Clone for PrimitiveStyle<C>

where C: PixelColor + Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> Debug for PrimitiveStyle<C>

where C: PixelColor + Debug,

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

Formats the value using the given formatter.

impl<C> Default for PrimitiveStyle<C>

where C: PixelColor,

fn default() -> Self

Returns the “default value” for a type.

impl<C> From<&PrimitiveStyle<C>> for PrimitiveStyleBuilder<C>

where C: PixelColor,

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

Converts to this type from the input type.

impl<C> Hash for PrimitiveStyle<C>

where C: PixelColor + Hash,

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, Self: Sized,

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

impl<C> Ord for PrimitiveStyle<C>

where C: PixelColor + Ord,

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

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

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<C> PartialEq for PrimitiveStyle<C>

where C: PixelColor + PartialEq,

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<C> PartialOrd for PrimitiveStyle<C>

where C: PixelColor + PartialOrd,

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

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

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

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

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

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

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

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

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

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

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for Arc

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

Returns the bounding box using the given style.

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for Circle

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

Returns the bounding box using the given style.

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for Ellipse

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

Returns the bounding box using the given style.

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for Line

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

Returns the bounding box using the given style.

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

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

Returns the bounding box using the given style.

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for Rectangle

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

Returns the bounding box using the given style.

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for RoundedRectangle

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

Returns the bounding box using the given style.

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for Sector

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

Returns the bounding box using the given style.

impl<C: PixelColor> StyledDimensions<PrimitiveStyle<C>> for Triangle

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

Returns the bounding box using the given style.

impl<C: PixelColor> StyledDrawable<PrimitiveStyle<C>> for Arc

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

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

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

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<'_>

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

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

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

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

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 for PrimitiveStyle<C>

where C: PixelColor + Copy,

impl<C> Eq for PrimitiveStyle<C>

where C: PixelColor + Eq,

impl<C> StructuralPartialEq for PrimitiveStyle<C>

where C: PixelColor,