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

pub struct Styled<T, S> {
    pub primitive: T,
    pub style: S,
}

Expand description

Styled.

Fields

primitive: T

Primitive.

style: S

Style.

Implementations

impl<T, S> Styled<T, S>[src]

pub fn new(primitive: T, style: S) -> Self[src]

Creates a styled.

impl<T: OffsetOutline, C: PixelColor> Styled<T, PrimitiveStyle<C>>[src]

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

Returns the fill area.

The returned primitive coincides with the area that would be filled by calling draw on this styled primitive.

Examples

use embedded_graphics::{
    pixelcolor::Rgb888,
    prelude::*,
    primitives::{Circle, PrimitiveStyleBuilder},
};

let style = PrimitiveStyleBuilder::new()
    .fill_color(Rgb888::RED)
    .stroke_color(Rgb888::GREEN)
    .stroke_width(6)
    .build();

let center = Point::new(10, 20);
let diameter = 10;

let circle = Circle::with_center(center, diameter).into_styled(style);

assert_eq!(circle.fill_area(), Circle::with_center(center, diameter - style.stroke_width));

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

Returns the stroke area.

The outer edge of the returned primitive coincides with the outer edge of the stroke that would be drawn by calling draw on this styled primitive.

Examples

This example tests if a point lies on the stroke. Because the stoke area surrounds the stoke and fill an additional test is required to check that the point is not inside the fill area.

use embedded_graphics::{
    pixelcolor::Rgb888,
    prelude::*,
    primitives::{Circle, PrimitiveStyle},
};

let style = PrimitiveStyle::with_stroke(Rgb888::RED, 6);

let center = Point::new(10, 20);
let diameter = 10;

let circle = Circle::with_center(center, diameter).into_styled(style);

// A point lies on the stroke if it is inside the stroke area but not in the fill area.
let is_on_stroke = |p| circle.stroke_area().contains(p) && !circle.fill_area().contains(p);

assert!(is_on_stroke(center + Size::new(0, diameter / 2)));
assert!(!is_on_stroke(center));

impl<T: StyledPixels<S>, S> Styled<T, S>[src]

pub fn pixels(&self) -> T::Iter[src]

Returns an iterator over the pixels in this styled primitive.

Trait Implementations

impl<T: Clone, S: Clone> Clone for Styled<T, S>[src]

fn clone(&self) -> Styled<T, S>[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<T: Debug, S: Debug> Debug for Styled<T, S>[src]

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

Formats the value using the given formatter. Read more

impl<T: Default, S: Default> Default for Styled<T, S>[src]

fn default() -> Styled<T, S>[src]

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

impl<T: StyledDimensions<S>, S> Dimensions for Styled<T, S>[src]

fn bounding_box(&self) -> Rectangle[src]

Returns the bounding box.

impl<T: StyledDrawable<S>, S> Drawable for Styled<T, S>[src]

type Color = T::Color

The pixel color type.

type Output = T::Output

The return type of the draw method. Read more

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

[src]

Draw the graphics object using the supplied DrawTarget.

impl<T: Hash, S: Hash> Hash for Styled<T, S>[src]

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<T: Ord, S: Ord> Ord for Styled<T, S>[src]

fn cmp(&self, other: &Styled<T, S>) -> 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<T: PartialEq, S: PartialEq> PartialEq<Styled<T, S>> for Styled<T, S>[src]

fn eq(&self, other: &Styled<T, S>) -> bool[src]

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

fn ne(&self, other: &Styled<T, S>) -> bool[src]

This method tests for !=.

impl<T: PartialOrd, S: PartialOrd> PartialOrd<Styled<T, S>> for Styled<T, S>[src]

fn partial_cmp(&self, other: &Styled<T, S>) -> 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<T: Transform, S: Clone> Transform for Styled<T, S>[src]

fn translate(&self, by: Point) -> Self[src]

Move the origin of an object by a given number of (x, y) pixels, returning a new object

fn translate_mut(&mut self, by: Point) -> &mut Self[src]

Move the origin of an object by a given number of (x, y) pixels, mutating the object in place Read more

impl<T: Copy, S: Copy> Copy for Styled<T, S>[src]

impl<T: Eq, S: Eq> Eq for Styled<T, S>[src]

impl<T, S> StructuralEq for Styled<T, S>[src]

impl<T, S> StructuralPartialEq for Styled<T, S>[src]

Auto Trait Implementations

impl<T, S> RefUnwindSafe for Styled<T, S> where
    S: RefUnwindSafe,
    T: RefUnwindSafe,

impl<T, S> Send for Styled<T, S> where
    S: Send,
    T: Send,

impl<T, S> Sync for Styled<T, S> where
    S: Sync,
    T: Sync,

impl<T, S> Unpin for Styled<T, S> where
    S: Unpin,
    T: Unpin,

impl<T, S> UnwindSafe for Styled<T, S> where
    S: UnwindSafe,
    T: UnwindSafe,

Blanket Implementations

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

[src]

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

[src]

Casts the value.

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

[src]

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

Immutably borrows from an owned value. Read more

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

[src]

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

[src]

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

[src]

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

Performs the conversion.

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

[src]

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

Performs the conversion.

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

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

[src]

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

[src]

Casts the value.

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

[src]

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,

[src]

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,

[src]

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

[src]

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

[src]

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

[src]

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

[src]

Casts the value.