Struct embedded_graphics::primitives::circle::Circle

pub struct Circle {
    pub center: Point,
    pub radius: u32,
}

Circle primitive

Examples

The macro examples make for more concise code.

Create some circles with different styles

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

// Circle with 1 pixel wide white stroke centered around (10, 20) with a radius 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 centered around (50, 20) with a radius of 30
let style = PrimitiveStyleBuilder::new()
    .stroke_color(Rgb565::RED)
    .stroke_width(3)
    .fill_color(Rgb565::GREEN)
    .build();

Circle::new(Point::new(50, 20), 30)
    .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(65, 35))
    .into_styled(PrimitiveStyle::with_fill(Rgb565::BLUE))
    .draw(&mut display)?;

Fields

center: Point

Center point of circle

radius: u32

Radius of the circle

Implementations

impl Circle

pub const fn new(center: Point, radius: u32) -> Self

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

Trait Implementations

impl Clone for Circle

fn clone(&self) -> Circle

Returns a copy of the value.

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

Performs copy-assignment from source.

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 top_left(&self) -> Point

Get the top left corner of the bounding box for an object

fn bottom_right(&self) -> Point

Get the bottom right corner of the bounding box for an object

fn size(&self) -> Size

Get the width and height for an object

impl Hash for Circle

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

fn cmp(&self, other: &Circle) -> 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,

Restrict a value to a certain interval.

impl PartialEq for Circle

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Circle

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Primitive for Circle

fn into_styled<C>( self, style: PrimitiveStyle<C>, ) -> Styled<Self, PrimitiveStyle<C>>

where C: PixelColor, Self: Sized,

Converts this primitive into a Styled.

impl Transform for Circle

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

Translate the circle center 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.center, Point::new(15, 20));

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

Translate the circle center 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.center, Point::new(15, 20));

impl Copy for Circle

impl Eq for Circle

impl StructuralPartialEq for Circle

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 12 bytes