Struct embedded_graphics::primitives::circle::Circle

pub struct Circle {
    pub top_left: Point,
    pub diameter: u32,
}

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

impl Circle

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

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

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

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

pub fn center(&self) -> Point

Return the center point of the circle

Trait Implementations

impl Clone for Circle

fn clone(&self) -> Circle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ContainsPoint for Circle

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

Returns true if the given point is inside the shape.

impl Copy for Circle

impl Debug for Circle

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

Formats the value using the given formatter.

impl Default for Circle

fn default() -> Circle

Returns the “default value” for a type.

impl Dimensions for Circle

fn bounding_box(&self) -> Rectangle

Returns the bounding box.

impl Eq for Circle

impl Hash for Circle

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl OffsetOutline for Circle

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

Offsets the outline of the shape.

impl Ord for Circle

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<Circle> for Circle

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

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

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

This method tests for !=.

impl PartialOrd<Circle> for Circle

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

pub 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 PointsIter for Circle

type Iter = Points

Iterator over all points inside the primitive.

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

Returns an iterator over all points inside the primitive.

impl Primitive for Circle

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

Converts this primitive into a Styled.

impl StructuralEq for Circle

impl StructuralPartialEq for Circle

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

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));

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));