Display

Struct Display 

Source
pub struct Display<const WIDTH: u32, const HEIGHT: u32, const BWRBIT: bool, const BYTECOUNT: usize, COLOR: ColorType + PixelColor> { /* private fields */ }
Expand description

Display buffer used for drawing with embedded graphics This can be rendered on EPD using …

  • WIDTH: width in pixel when display is not rotated
  • HEIGHT: height in pixel when display is not rotated
  • BWRBIT: mandatory value of the B/W when chromatic bit is set, can be any value for non tricolor epd
  • COLOR: color type used by the target display
  • BYTECOUNT: This is redundant with previous data and should be removed when const generic expressions are stabilized

More on BWRBIT:

Different chromatic displays differently treat the bits in chromatic color planes. Some of them (crate::epd2in13bc) will render a color pixel if bit is set for that pixel, which is a BWRBIT = true mode.

Other displays, like crate::epd5in83b_v2 in opposite, will draw color pixel if bit is cleared for that pixel, which is a BWRBIT = false mode.

BWRBIT=true: chromatic doesn’t override white, white bit cleared for black, white bit set for white, both bits set for chromatic BWRBIT=false: chromatic does override white, both bits cleared for black, white bit set for white, red bit set for black

Implementations§

Source§

impl<const WIDTH: u32, const HEIGHT: u32, const BWRBIT: bool, const BYTECOUNT: usize, COLOR: ColorType + PixelColor> Display<WIDTH, HEIGHT, BWRBIT, BYTECOUNT, COLOR>

Source

pub fn buffer(&self) -> &[u8]

get internal buffer to use it (to draw in epd)

Source

pub fn set_rotation(&mut self, rotation: DisplayRotation)

Set the display rotation.

This only concerns future drawing made to it. Anything aready drawn stays as it is in the buffer.

Source

pub fn rotation(&self) -> DisplayRotation

Get current rotation

Source

pub fn set_pixel(&mut self, pixel: Pixel<COLOR>)

Set a specific pixel color on this display

Source§

impl<const WIDTH: u32, const HEIGHT: u32, const BWRBIT: bool, const BYTECOUNT: usize> Display<WIDTH, HEIGHT, BWRBIT, BYTECOUNT, TriColor>

Some Tricolor specifics

Source

pub fn bw_buffer(&self) -> &[u8]

get black/white internal buffer to use it (to draw in epd)

Source

pub fn chromatic_buffer(&self) -> &[u8]

get chromatic internal buffer to use it (to draw in epd)

Trait Implementations§

Source§

impl<const WIDTH: u32, const HEIGHT: u32, const BWRBIT: bool, const BYTECOUNT: usize, COLOR: ColorType + PixelColor> Default for Display<WIDTH, HEIGHT, BWRBIT, BYTECOUNT, COLOR>

Source§

fn default() -> Self

Initialize display with the color ‘0’, which may not be the same on all device. Many devices have a bit parameter polarity that should be changed if this is not the right one. However, every device driver should implement a DEFAULT_COLOR constant to indicate which color this represents (TODO)

If you want a specific default color, you can still call clear() to set one.

Source§

impl<const WIDTH: u32, const HEIGHT: u32, const BWRBIT: bool, const BYTECOUNT: usize, COLOR: ColorType + PixelColor> DrawTarget for Display<WIDTH, HEIGHT, BWRBIT, BYTECOUNT, COLOR>

For use with embedded_grahics

Source§

type Color = COLOR

The pixel color type the targetted display supports.
Source§

type Error = Infallible

Error type to return when a drawing operation fails. Read more
Source§

fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>
where I: IntoIterator<Item = Pixel<Self::Color>>,

Draw individual pixels to the display without a defined order. Read more
Source§

fn fill_contiguous<I>( &mut self, area: &Rectangle, colors: I, ) -> Result<(), Self::Error>
where I: IntoIterator<Item = Self::Color>,

Fill a given area with an iterator providing a contiguous stream of pixel colors. Read more
Source§

fn fill_solid( &mut self, area: &Rectangle, color: Self::Color, ) -> Result<(), Self::Error>

Fill a given area with a solid color. Read more
Source§

fn clear(&mut self, color: Self::Color) -> Result<(), Self::Error>

Fill the entire display with a solid color. Read more
Source§

impl<const WIDTH: u32, const HEIGHT: u32, const BWRBIT: bool, const BYTECOUNT: usize, COLOR: ColorType + PixelColor> OriginDimensions for Display<WIDTH, HEIGHT, BWRBIT, BYTECOUNT, COLOR>

For use with embedded_grahics

Source§

fn size(&self) -> Size

Returns the size of the bounding box.

Auto Trait Implementations§

§

impl<const WIDTH: u32, const HEIGHT: u32, const BWRBIT: bool, const BYTECOUNT: usize, COLOR> Freeze for Display<WIDTH, HEIGHT, BWRBIT, BYTECOUNT, COLOR>

§

impl<const WIDTH: u32, const HEIGHT: u32, const BWRBIT: bool, const BYTECOUNT: usize, COLOR> RefUnwindSafe for Display<WIDTH, HEIGHT, BWRBIT, BYTECOUNT, COLOR>
where COLOR: RefUnwindSafe,

§

impl<const WIDTH: u32, const HEIGHT: u32, const BWRBIT: bool, const BYTECOUNT: usize, COLOR> Send for Display<WIDTH, HEIGHT, BWRBIT, BYTECOUNT, COLOR>
where COLOR: Send,

§

impl<const WIDTH: u32, const HEIGHT: u32, const BWRBIT: bool, const BYTECOUNT: usize, COLOR> Sync for Display<WIDTH, HEIGHT, BWRBIT, BYTECOUNT, COLOR>
where COLOR: Sync,

§

impl<const WIDTH: u32, const HEIGHT: u32, const BWRBIT: bool, const BYTECOUNT: usize, COLOR> Unpin for Display<WIDTH, HEIGHT, BWRBIT, BYTECOUNT, COLOR>
where COLOR: Unpin,

§

impl<const WIDTH: u32, const HEIGHT: u32, const BWRBIT: bool, const BYTECOUNT: usize, COLOR> UnwindSafe for Display<WIDTH, HEIGHT, BWRBIT, BYTECOUNT, COLOR>
where COLOR: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> Dimensions for T

Source§

fn bounding_box(&self) -> Rectangle

Returns the bounding box.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

OverflowingCasts the value.
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

UnwrappedCasts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

WrappingCasts the value.