Struct embedded_graphics::primitives::circle::Circle

pub struct Circle<C: PixelColor> {
    pub center: Coord,
    pub radius: u32,
    pub style: Style<C>,
}

Circle primitive

Examples

The macro examples make for more concise code.

Create some circles with different styles

use embedded_graphics::prelude::*;
use embedded_graphics::primitives::Circle;

// Default circle with only a stroke centered around (10, 20) with a radius of 30
let c1 = Circle::new(Coord::new(10, 20), 30);

// Circle with styled stroke and fill centered around (50, 20) with a radius of 30
let c2 = Circle::new(Coord::new(50, 20), 30)
    .stroke(Some(5u8))
    .stroke_width(3)
    .fill(Some(10u8));

// Circle with no stroke and a translation applied
let c3 = Circle::new(Coord::new(10, 20), 30)
    .stroke(None)
    .fill(Some(10u8))
    .translate(Coord::new(65, 35));

display.draw(c1);
display.draw(c2);
display.draw(c3);

Fields

center: Coord

Center point of circle

radius: u32

Radius of the circle

style: Style<C>

Style of the circle

Methods

impl<C> Circle<C> where
    C: PixelColor, 

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

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

Trait Implementations

impl<C: Clone + PixelColor> Clone for Circle<C>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Copy + PixelColor> Copy for Circle<C>

impl<C: Debug + PixelColor> Debug for Circle<C>

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

Formats the value using the given formatter.

impl<C> Dimensions for Circle<C> where
    C: PixelColor, 

fn top_left(&self) -> Coord

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

fn bottom_right(&self) -> Coord

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

fn size(&self) -> UnsignedCoord

Get the width and height for an object

impl<C> Drawable for Circle<C> where
    C: PixelColor, 

impl<C> IntoIterator for Circle<C> where
    C: PixelColor, 

type Item = Pixel<C>

The type of the elements being iterated over.

type IntoIter = CircleIterator<C>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, C> IntoIterator for &'a Circle<C> where
    C: PixelColor, 

type Item = Pixel<C>

The type of the elements being iterated over.

type IntoIter = CircleIterator<C>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<C> Primitive for Circle<C> where
    C: PixelColor, 

impl<C> Transform for Circle<C> where
    C: PixelColor, 

fn translate(&self, by: Coord) -> 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(Coord::new(5, 10), 10)
let moved = circle.translate(Coord::new(10, 10));

assert_eq!(moved.center, Coord::new(15, 20));

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

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

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

assert_eq!(circle.center, Coord::new(15, 20));

impl<C> WithStyle<C> for Circle<C> where
    C: PixelColor, 

fn style(self, style: Style<C>) -> Self

Add a complete style to the object

fn stroke(self, color: Option<C>) -> Self

Set the stroke colour for the object

fn stroke_width(self, width: u8) -> Self

Set the stroke width for the object

fn fill(self, color: Option<C>) -> Self

Set the fill property of the object's style