Struct mipidsi::Display

source · [−]

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

Expand description

Display driver to connect to TFT displays.

Implementations

source

impl<DI, RST> Display<DI, RST, ILI9486Rgb565> where
DI: WriteOnlyDataCommand,
RST: OutputPin,

source

pub fn ili9486_rgb565(di: DI, rst: RST) -> Self

Creates a new Display instance with [ILI9486] as the Model WARNING Rgb565 only works on non-SPI setups with the ILI9486!

Arguments

di - a DisplayInterface for talking with the display
rst - display hard reset OutputPin
model - the display Model

source

impl<DI, RST> Display<DI, RST, ILI9486Rgb666> where
DI: WriteOnlyDataCommand,
RST: OutputPin,

source

pub fn ili9486_rgb666(di: DI, rst: RST) -> Self

Creates a new Display instance with [ILI9486] as the Model

Arguments

di - a DisplayInterface for talking with the display
rst - display hard reset OutputPin
model - the display Model

source

impl<DI, RST> Display<DI, RST, ST7735s> where
DI: WriteOnlyDataCommand,
RST: OutputPin,

source

pub fn st7735s(di: DI, rst: RST) -> Self

Creates a new Display instance with ST7735s as the Model with a hard reset Pin

Arguments

di - a DisplayInterface for talking with the display
rst - display hard reset OutputPin
model - the display Model

source

impl<DI> Display<DI, NoPin, ST7735s> where
DI: WriteOnlyDataCommand,

source

pub fn st7735s_without_rst(di: DI) -> Self

Creates a new Display instance with ST7735s as the Model without a hard reset Pin

Arguments

di - a DisplayInterface for talking with the display
model - the display Model

source

impl<DI, RST> Display<DI, RST, ST7789> where
DI: WriteOnlyDataCommand,
RST: OutputPin,

source

pub fn st7789(di: DI, rst: RST) -> Self

Creates a new Display instance with ST7789 as the Model with a hard reset Pin

Arguments

di - a DisplayInterface for talking with the display
rst - display hard reset OutputPin
model - the display Model

source

impl<DI> Display<DI, NoPin, ST7789> where
DI: WriteOnlyDataCommand,

source

pub fn st7789_without_rst(di: DI) -> Self

Creates a new Display instance with ST7789 as the Model without a hard reset Pin

Arguments

di - a DisplayInterface for talking with the display
model - the display Model

source

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

source

pub fn with_model(di: DI, rst: Option<RST>, model: M) -> Self

Creates a new Display driver instance with given Model

Arguments

di - a DisplayInterface for talking with the display
rst - display hard reset OutputPin
model - the display Model

source

pub fn init(
 &mut self,
 delay_source: &mut impl DelayUs<u32>,
 options: DisplayOptions
) -> Result<(), Error<RST::Error>>

Runs commands to initialize the display

Arguments

delay_source - mutable reference to a DelayUs provider

source

pub fn orientation(&self) -> Orientation

Returns currently set Orientation

source

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

Sets display Orientation

source

pub fn set_pixel(
 &mut self,
 x: u16,
 y: u16,
 color: M::ColorFormat
) -> Result<(), Error<RST::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

source

pub fn set_pixels<T>(
 &mut self,
 sx: u16,
 sy: u16,
 ex: u16,
 ey: u16,
 colors: T
) -> Result<(), Error<RST::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

source

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

Sets scroll region

Arguments

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

source

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

Sets scroll offset “shifting” the displayed picture

Arguments

offset - scroll offset in pixels

source

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

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

source

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

Configures the tearing effect output.

Trait Implementations

source

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

type Error = Error<<RST as OutputPin>::Error>

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

type Color = <M as Model>::ColorFormat

The pixel color type the targetted display supports.

source

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. Read more

source

fn fill_contiguous(
 &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<DI, RST, MODEL, PinE> OriginDimensions for Display<DI, RST, MODEL> where
 DI: WriteOnlyDataCommand,
 RST: OutputPin<Error = PinE>,
 MODEL: Model,

source

fn size(&self) -> Size

Returns the size of the bounding box.

Auto Trait Implementations

impl<DI, RST, MODEL> RefUnwindSafe for Display<DI, RST, MODEL> where
 DI: RefUnwindSafe,
 MODEL: RefUnwindSafe,
 RST: RefUnwindSafe,

impl<DI, RST, MODEL> Send for Display<DI, RST, MODEL> where
 DI: Send,
 MODEL: Send,
 RST: Send,

impl<DI, RST, MODEL> Sync for Display<DI, RST, MODEL> where
 DI: Sync,
 MODEL: Sync,
 RST: Sync,

impl<DI, RST, MODEL> Unpin for Display<DI, RST, MODEL> where
 DI: Unpin,
 MODEL: Unpin,
 RST: Unpin,

impl<DI, RST, MODEL> UnwindSafe for Display<DI, RST, MODEL> where
 DI: UnwindSafe,
 MODEL: UnwindSafe,
 RST: 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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · 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 where
T: OriginDimensions,

source

fn bounding_box(&self) -> Rectangle

Returns the bounding box.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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)

Casts 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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::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

Casts 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

Casts the value.

Struct mipidsi::Display

Implementations

impl<DI, RST> Display<DI, RST, ILI9486Rgb565> where DI: WriteOnlyDataCommand, RST: OutputPin,

pub fn ili9486_rgb565(di: DI, rst: RST) -> Self

impl<DI, RST> Display<DI, RST, ILI9486Rgb666> where DI: WriteOnlyDataCommand, RST: OutputPin,

pub fn ili9486_rgb666(di: DI, rst: RST) -> Self

impl<DI, RST> Display<DI, RST, ST7735s> where DI: WriteOnlyDataCommand, RST: OutputPin,

pub fn st7735s(di: DI, rst: RST) -> Self

impl<DI> Display<DI, NoPin, ST7735s> where DI: WriteOnlyDataCommand,

pub fn st7735s_without_rst(di: DI) -> Self

impl<DI, RST> Display<DI, RST, ST7789> where DI: WriteOnlyDataCommand, RST: OutputPin,

pub fn st7789(di: DI, rst: RST) -> Self

impl<DI> Display<DI, NoPin, ST7789> where DI: WriteOnlyDataCommand,

pub fn st7789_without_rst(di: DI) -> Self

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

pub fn with_model(di: DI, rst: Option<RST>, model: M) -> Self

pub fn init( &mut self, delay_source: &mut impl DelayUs<u32>, options: DisplayOptions) -> Result<(), Error<RST::Error>>

pub fn orientation(&self) -> Orientation

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

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

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

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

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

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

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

Trait Implementations

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

type Error = Error<<RST as OutputPin>::Error>

type Color = <M as Model>::ColorFormat

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

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

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

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

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

fn size(&self) -> Size

Auto Trait Implementations

impl<DI, RST, MODEL> RefUnwindSafe for Display<DI, RST, MODEL> where DI: RefUnwindSafe, MODEL: RefUnwindSafe, RST: RefUnwindSafe,

impl<DI, RST, MODEL> Send for Display<DI, RST, MODEL> where DI: Send, MODEL: Send, RST: Send,

impl<DI, RST, MODEL> Sync for Display<DI, RST, MODEL> where DI: Sync, MODEL: Sync, RST: Sync,

impl<DI, RST, MODEL> Unpin for Display<DI, RST, MODEL> where DI: Unpin, MODEL: Unpin, RST: Unpin,

impl<DI, RST, MODEL> UnwindSafe for Display<DI, RST, MODEL> where DI: UnwindSafe, MODEL: UnwindSafe, RST: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T> Az for T

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

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

fn borrow(&self) -> &T

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

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

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

fn cast_from(src: Src) -> Dst

impl<T> CheckedAs for T

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

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

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

impl<T> Dimensions for T where T: OriginDimensions,

fn bounding_box(&self) -> Rectangle

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> OverflowingAs for T

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

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

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

impl<T> SaturatingAs for T

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

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

fn saturating_cast_from(src: Src) -> Dst

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

type Error = Infallible

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

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

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

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

impl<T> UnwrappedAs for T

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

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

fn unwrapped_cast_from(src: Src) -> Dst

impl<DI, RST> Display<DI, RST, ILI9486Rgb565> where
DI: WriteOnlyDataCommand,
RST: OutputPin,

impl<DI, RST> Display<DI, RST, ILI9486Rgb666> where
DI: WriteOnlyDataCommand,
RST: OutputPin,

impl<DI, RST> Display<DI, RST, ST7735s> where
DI: WriteOnlyDataCommand,
RST: OutputPin,

impl<DI> Display<DI, NoPin, ST7735s> where
DI: WriteOnlyDataCommand,

impl<DI, RST> Display<DI, RST, ST7789> where
DI: WriteOnlyDataCommand,
RST: OutputPin,

impl<DI> Display<DI, NoPin, ST7789> where
DI: WriteOnlyDataCommand,

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

pub fn init(
&mut self,
delay_source: &mut impl DelayUs<u32>,
options: DisplayOptions
) -> Result<(), Error<RST::Error>>

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

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

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

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

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

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

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

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

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

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

impl<DI, RST, MODEL> RefUnwindSafe for Display<DI, RST, MODEL> where
DI: RefUnwindSafe,
MODEL: RefUnwindSafe,
RST: RefUnwindSafe,

impl<DI, RST, MODEL> Send for Display<DI, RST, MODEL> where
DI: Send,
MODEL: Send,
RST: Send,

impl<DI, RST, MODEL> Sync for Display<DI, RST, MODEL> where
DI: Sync,
MODEL: Sync,
RST: Sync,

impl<DI, RST, MODEL> Unpin for Display<DI, RST, MODEL> where
DI: Unpin,
MODEL: Unpin,
RST: Unpin,

impl<DI, RST, MODEL> UnwindSafe for Display<DI, RST, MODEL> where
DI: UnwindSafe,
MODEL: UnwindSafe,
RST: UnwindSafe,

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

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

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

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

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

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

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

impl<T> Dimensions for T where
T: OriginDimensions,

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

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

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

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

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

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

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

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

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

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

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