Struct Builder

pub struct Builder<DI, MODEL, RST>
where
    DI: Interface,
    MODEL: Model,
{ /* private fields */ }

Builder for Display instances.

Exposes all possible display options.

Examples

use lcd_async::{Builder, options::ColorOrder, models::ILI9342CRgb565};

let mut display = Builder::new(ILI9342CRgb565, di)
    .reset_pin(rst)
    .color_order(ColorOrder::Bgr)
    .display_size(320, 240)
    .init(&mut delay).await.unwrap();

Implementations

impl<DI, MODEL> Builder<DI, MODEL, NoResetPin>

where DI: Interface, MODEL: Model,

pub fn new(model: MODEL, di: DI) -> Self

Constructs a new builder for given Model.

impl<DI, MODEL, RST> Builder<DI, MODEL, RST>

where DI: Interface, MODEL: Model, RST: OutputPin,

pub fn invert_colors(self, color_inversion: ColorInversion) -> Self

Sets the invert color flag

pub fn color_order(self, color_order: ColorOrder) -> Self

Sets the ColorOrder

pub fn orientation(self, orientation: Orientation) -> Self

Sets the Orientation

pub fn refresh_order(self, refresh_order: RefreshOrder) -> Self

Sets refresh order

pub fn display_size(self, width: u16, height: u16) -> Self

Sets the display size.

pub fn display_offset(self, x: u16, y: u16) -> Self

Sets the display offset

pub fn reset_pin<RST2: OutputPin>(self, rst: RST2) -> Builder<DI, MODEL, RST2>

Sets the reset pin.

WARNING

The reset pin needs to be in high state in order for the display to operate. If it wasn’t provided the user needs to ensure this is the case.

pub async fn init( self, delay_source: &mut impl DelayNs, ) -> Result<Display<DI, MODEL, RST>, InitError<DI::Error, RST::Error>>

Consumes the builder to create a new Display with an optional reset OutputPin. Blocks using the provided DelayNs delay_source to perform the display initialization. The display will be awake ready to use, no need to call Display::wake after init.

Returns InitError if the area defined by the display_size and display_offset settings is (partially) outside the framebuffer.