Struct embedded_graphics::primitives::rectangle::Rectangle

pub struct Rectangle<C: PixelColor> {
    pub top_left: Coord,
    pub bottom_right: Coord,
    pub style: Style<C>,
}

Rectangle primitive

Examples

The macro examples make for more concise code.

Create some rectangles with different styles

use embedded_graphics::prelude::*;
use embedded_graphics::primitives::Rectangle;

// Default rect from (10, 20) to (30, 40)
let r1 = Rectangle::new(Coord::new(10, 20), Coord::new(30, 40));

// Rectangle with styled stroke and fill from (50, 20) to (60, 35)
let r2 = Rectangle::new(Coord::new(50, 20), Coord::new(60, 35))
    .stroke(Some(5u8))
    .stroke_width(3)
    .fill(Some(10u8));

// Rectangle with translation applied
let r3 = Rectangle::new(Coord::new(50, 20), Coord::new(60, 35))
    .translate(Coord::new(65, 35));

display.draw(r1);
display.draw(r2);
display.draw(r3);

Fields

top_left: Coord

Top left point of the rect

bottom_right: Coord

Bottom right point of the rect

style: Style<C>

Object style

Methods

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

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

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

Trait Implementations

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

fn clone(&self) -> Rectangle<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 Rectangle<C>

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

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

Formats the value using the given formatter.

impl<C> Dimensions for Rectangle<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 Rectangle<C> where
    C: PixelColor, 

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

type Item = Pixel<C>

The type of the elements being iterated over.

type IntoIter = RectangleIterator<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 Rectangle<C> where
    C: PixelColor, 

type Item = Pixel<C>

The type of the elements being iterated over.

type IntoIter = RectangleIterator<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 Rectangle<C> where
    C: PixelColor, 

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

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

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

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

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

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

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

impl<C> WithStyle<C> for Rectangle<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