Struct mipidsi::Display

pub struct Display<DI, MODEL, RST>where
    DI: WriteOnlyDataCommand,
    MODEL: Model,
    RST: OutputPin,{ /* private fields */ }

Display driver to connect to TFT displays.

Implementations

impl<DI, M, RST> Display<DI, M, RST>where
    DI: WriteOnlyDataCommand,
    M: Model,
    RST: OutputPin,

pub fn orientation(&self) -> Orientation

Returns currently set Orientation

pub fn set_orientation(&mut self, orientation: Orientation) -> Result<(), Error>

Sets display Orientation

pub fn set_pixel(
    &mut self,
    x: u16,
    y: u16,
    color: M::ColorFormat
) -> Result<(), Error>

Sets a pixel color at the given coords.

Arguments

• x - x coordinate
• y - y coordinate
• color - the color value in pixel format of the display Model

pub fn set_pixels<T>(
    &mut self,
    sx: u16,
    sy: u16,
    ex: u16,
    ey: u16,
    colors: T
) -> Result<(), Error>where
    T: IntoIterator<Item = M::ColorFormat>,

Sets pixel colors in given rectangle bounds.

Arguments

• sx - x coordinate start
• sy - y coordinate start
• ex - x coordinate end
• ey - y coordinate end
• colors - anything that can provide IntoIterator<Item = u16> to iterate over pixel data

pub fn set_scroll_region(
    &mut self,
    tfa: u16,
    vsa: u16,
    bfa: u16
) -> Result<(), Error>

Sets scroll region

Arguments

• tfa - Top fixed area
• vsa - Vertical scrolling area
• bfa - Bottom fixed area

pub fn set_scroll_offset(&mut self, offset: u16) -> Result<(), Error>

Sets scroll offset “shifting” the displayed picture

Arguments

• offset - scroll offset in pixels

pub fn release(self) -> (DI, M, Option<RST>)

Release resources allocated to this driver back. This returns the display interface, reset pin and and the model deconstructing the driver.

pub fn set_tearing_effect(
    &mut self,
    tearing_effect: TearingEffect
) -> Result<(), Error>

Configures the tearing effect output.

Trait Implementations

impl<DI, M, RST> DrawTarget for Display<DI, M, RST>where
    DI: WriteOnlyDataCommand,
    M: Model,
    RST: OutputPin,

type Error = DisplayError

Error type to return when a drawing operation fails.

type Color = <M as Model>::ColorFormat

The pixel color type the targetted display supports.

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

Draw individual pixels to the display without a defined order.

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.

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

Fill a given area with a solid color.

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

Fill the entire display with a solid color.

impl<DI, MODEL, RST> OriginDimensions for Display<DI, MODEL, RST>where
    DI: WriteOnlyDataCommand,
    MODEL: Model,
    RST: OutputPin,

fn size(&self) -> Size

Returns the size of the bounding box.