Struct Rectangle

pub struct Rectangle {
    pub top_left: Point,
    pub bottom_right: Point,
}

Rectangle primitive

Examples

The macro examples make for more concise code.

Create some rectangles with different styles

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

// Rectangle with red 3 pixel wide stroke and green fill from (50, 20) to (60, 35)
let style = PrimitiveStyleBuilder::new()
    .stroke_color(Rgb565::RED)
    .stroke_width(3)
    .fill_color(Rgb565::GREEN)
    .build();

Rectangle::new(Point::new(50, 20), Point::new(60, 35))
    .into_styled(style)
    .draw(&mut display)?;

// Rectangle with translation applied
Rectangle::new(Point::new(50, 20), Point::new(60, 35))
    .translate(Point::new(65, 35))
    .into_styled(style)
    .draw(&mut display)?;

Fields

top_left: Point

Top left point of the rect

bottom_right: Point

Bottom right point of the rect

Implementations

impl Rectangle

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

Create a new rectangle from the top left point to the bottom right point with a given style

Trait Implementations

impl Clone for Rectangle

fn clone(&self) -> Rectangle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rectangle

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

Formats the value using the given formatter.

impl Default for Rectangle

fn default() -> Rectangle

Returns the “default value” for a type.

impl Dimensions for Rectangle

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 Rectangle

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 Rectangle

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

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

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

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 Rectangle

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

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

let rect = Rectangle::new(Point::new(5, 10), Point::new(15, 20));
let moved = rect.translate(Point::new(10, 10));

assert_eq!(moved.top_left, Point::new(15, 20));
assert_eq!(moved.bottom_right, Point::new(25, 30));

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

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

let mut rect = Rectangle::new(Point::new(5, 10), Point::new(15, 20));
rect.translate_mut(Point::new(10, 10));

assert_eq!(rect.top_left, Point::new(15, 20));
assert_eq!(rect.bottom_right, Point::new(25, 30));

impl Copy for Rectangle

impl Eq for Rectangle

impl StructuralPartialEq for Rectangle

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: 16 bytes