Struct embedded_graphics::primitives::ellipse::Ellipse

pub struct Ellipse {
    pub top_left: Point,
    pub size: Size,
}

Ellipse primitive

Examples

Create some ellipses with different styles

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

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

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

Ellipse::new(Point::new(20, 30), Size::new(40, 30))
    .into_styled(style)
    .draw(&mut display)?;

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

Fields

top_left: Point

Top-left point of ellipse's bounding box

size: Size

Size of the ellipse

Implementations

impl Ellipse

pub const fn new(top_left: Point, size: Size) -> Self

Create a new ellipse delimited with a top-left point with a specific size

pub fn with_center(center: Point, size: Size) -> Self

Create a new ellipse centered around a given point with a specific size

pub fn center(&self) -> Point

Return the center point of the ellipse

Trait Implementations

impl Clone for Ellipse

fn clone(&self) -> Ellipse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ContainsPoint for Ellipse

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

Returns true if the given point is inside the shape.

impl Copy for Ellipse

impl Debug for Ellipse

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

Formats the value using the given formatter.

impl Default for Ellipse

fn default() -> Ellipse

Returns the "default value" for a type.

impl Dimensions for Ellipse

fn bounding_box(&self) -> Rectangle

Returns the bounding box.

impl Eq for Ellipse

impl Hash for Ellipse

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, 

Feeds a slice of this type into the given Hasher.

impl OffsetOutline for Ellipse

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

Offsets the outline of the shape.

impl Ord for Ellipse

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Ellipse> for Ellipse

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

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

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

This method tests for !=.

impl PartialOrd<Ellipse> for Ellipse

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

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

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

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

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

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

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

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

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

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

impl Primitive for Ellipse

type PointsIter = Points

Iterator over all points inside the primitive.

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

Returns an iterator over all points inside the primitive.

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

Converts this primitive into a Styled.

impl StructuralEq for Ellipse

impl StructuralPartialEq for Ellipse

impl Transform for Ellipse

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

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

let ellipse = Ellipse::new(Point::new(5, 10), Size::new(10, 15));
let moved = ellipse.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 ellipse from its current position to a new position by (x, y) pixels.

let mut ellipse = Ellipse::new(Point::new(5, 10), Size::new(10, 15));
ellipse.translate_mut(Point::new(10, 10));

assert_eq!(ellipse.top_left, Point::new(15, 20));