Struct embedded_graphics::primitives::circle::Circle

source ·
pub struct Circle {
    pub top_left: Point,
    pub diameter: u32,
}
Expand description

Circle primitive

§Examples

§Create some circles with different styles

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

// Circle with 1 pixel wide white stroke with top-left point at (10, 20) with a diameter of 30
Circle::new(Point::new(10, 20), 30)
    .into_styled(PrimitiveStyle::with_stroke(Rgb565::WHITE, 1))
    .draw(&mut display)?;

// Circle with styled stroke and fill with top-left point at (50, 20) with a diameter of 30
let style = PrimitiveStyleBuilder::new()
    .stroke_color(Rgb565::RED)
    .stroke_width(3)
    .fill_color(Rgb565::GREEN)
    .build();

Circle::new(Point::new(50, 20), 10)
    .into_styled(style)
    .draw(&mut display)?;

// Circle with blue fill and no stroke with a translation applied
Circle::new(Point::new(10, 20), 30)
    .translate(Point::new(20, 10))
    .into_styled(PrimitiveStyle::with_fill(Rgb565::BLUE))
    .draw(&mut display)?;

Fields§

§top_left: Point

Top-left point of circle’s bounding box

§diameter: u32

Diameter of the circle

Implementations§

source§

impl Circle

source

pub const fn new(top_left: Point, diameter: u32) -> Self

Create a new circle delimited with a top-left point with a specific diameter

source

pub const fn with_center(center: Point, diameter: u32) -> Self

Create a new circle centered around a given point with a specific diameter

source

pub fn center(&self) -> Point

Return the center point of the circle

Trait Implementations§

source§

impl Clone for Circle

source§

fn clone(&self) -> Circle

Returns a copy of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
source§

impl ContainsPoint for Circle

source§

fn contains(&self, point: Point) -> bool

Returns true if the given point is inside the shape.
source§

impl Debug for Circle

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Circle

source§

fn default() -> Circle

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

impl Dimensions for Circle

source§

fn bounding_box(&self) -> Rectangle

Returns the bounding box.
source§

impl Hash for Circle

source§

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

Feeds this value into the given [Hasher]. Read more
1.3.0§

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 OffsetOutline for Circle

source§

fn offset(&self, offset: i32) -> Self

Offsets the outline of the shape. Read more
source§

impl Ord for Circle

source§

fn cmp(&self, other: &Circle) -> Ordering

This method returns an [Ordering] between self and other. Read more
1.21.0§

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

Compares and returns the maximum of two values. Read more
1.21.0§

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

Compares and returns the minimum of two values. Read more
1.50.0§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

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

impl PartialEq for Circle

source§

fn eq(&self, other: &Circle) -> bool

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

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.
source§

impl PartialOrd for Circle

source§

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

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

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§

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
1.0.0§

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

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

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

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

impl PointsIter for Circle

§

type Iter = Points

Iterator over all points inside the primitive.
source§

fn points(&self) -> Self::Iter

Returns an iterator over all points inside the primitive.
source§

impl Primitive for Circle

source§

fn into_styled<S>(self, style: S) -> Styled<Self, S>
where Self: Sized,

Converts this primitive into a Styled.
source§

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

source§

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

Returns the bounding box using the given style.
source§

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

§

type Color = C

Color type.
§

type Output = ()

Output type.
source§

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.
source§

impl Transform for Circle

source§

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

Translate the circle from its current position to a new position by (x, y) pixels, returning a new Circle. For a mutating transform, see translate_mut.

let circle = Circle::new(Point::new(5, 10), 10);
let moved = circle.translate(Point::new(10, 10));

assert_eq!(moved.top_left, Point::new(15, 20));
source§

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

Translate the circle from its current position to a new position by (x, y) pixels.

let mut circle = Circle::new(Point::new(5, 10), 10);
circle.translate_mut(Point::new(10, 10));

assert_eq!(circle.top_left, Point::new(15, 20));
source§

impl Copy for Circle

source§

impl Eq for Circle

source§

impl StructuralPartialEq for Circle

Auto Trait Implementations§

§

impl Freeze for Circle

§

impl RefUnwindSafe for Circle

§

impl Send for Circle

§

impl Sync for Circle

§

impl Unpin for Circle

§

impl UnwindSafe for Circle

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Az for T

source§

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

Casts the value.
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

source§

fn cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> CheckedAs for T

source§

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

Casts the value.
source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

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> OverflowingAs for T

source§

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

Casts the value.
source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
source§

impl<T> SaturatingAs for T

source§

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

Casts the value.
source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
§

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

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.
§

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

Performs the conversion.
source§

impl<T> UnwrappedAs for T

source§

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

Casts the value.
source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> WrappingAs for T

source§

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

Casts the value.
source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.