Struct LedPixelDrawTarget

pub struct LedPixelDrawTarget<'d, CDraw, CDev, S, Data = Vec<u8>>
where
    CDraw: RgbColor,
    CDev: LedPixelColor + From<CDraw>,
    S: LedPixelShape,
    Data: DerefMut<Target = [u8]> + FromIterator<u8> + IntoIterator<Item = u8>,
{ /* private fields */ }

Available on crate feature embedded-graphics-core only.

Target for embedded-graphics drawing operations of the LED pixels.

This is a generalization for the future extension. Use Ws2812DrawTarget for typical RGB LED (WS2812B/SK6812) consisting of 8-bit GRB (total 24-bit pixel).

• CDraw - color type for embedded-graphics drawing operations
• CDev - the LED pixel color type (device dependant). It shall be convertible from CDraw.
• S - the LED pixel shape
• Data - (optional) data storage type. It shall be Vec-like struct.

flush() operation shall be required to write changes from a framebuffer to the display.

For non-alloc no_std environment, Data should be explicitly set to some Vec-like struct: e.g., heapless::Vec<u8, PIXEL_LEN> where PIXEL_LEN equals to S::size() * CDev::BPP.

Implementations

impl<'d, CDraw, CDev, S, Data> LedPixelDrawTarget<'d, CDraw, CDev, S, Data>

where CDraw: RgbColor, CDev: LedPixelColor + From<CDraw>, S: LedPixelShape, Data: DerefMut<Target = [u8]> + FromIterator<u8> + IntoIterator<Item = u8>,

pub fn new<C: RmtChannel>( channel: impl Peripheral<P = C> + 'd, pin: impl Peripheral<P = impl OutputPin> + 'd, ) -> Result<Self, Ws2812Esp32RmtDriverError>

Create a new draw target.

channel shall be different between different pin.

pub fn new_with_rmt_driver( tx: TxRmtDriver<'d>, ) -> Result<Self, Ws2812Esp32RmtDriverError>

Create a new draw target.

pub fn set_brightness(&mut self, brightness: u8)

Set maximum brightness. Each channel values of the returned shall be scaled down to (brightness + 1) / 256.

pub fn brightness(&self) -> u8

Returns maximum brightness.

pub fn clear_with_black(&mut self) -> Result<(), Ws2812Esp32RmtDriverError>

Clear with black. Same operation as clear(black_color).

pub fn flush(&mut self) -> Result<(), Ws2812Esp32RmtDriverError>

Write changes from a framebuffer to the LED pixels

Trait Implementations

impl<'d, CDraw, CDev, S, Data> DrawTarget for LedPixelDrawTarget<'d, CDraw, CDev, S, Data>

where CDraw: RgbColor, CDev: LedPixelColor + From<CDraw>, S: LedPixelShape, Data: DerefMut<Target = [u8]> + FromIterator<u8> + IntoIterator<Item = u8>,

type Color = CDraw

The pixel color type the targetted display supports.

type Error = Ws2812Esp32RmtDriverError

Error type to return when a drawing operation fails.

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.

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

Fill the entire display with a solid color.

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.

impl<'d, CDraw, CDev, S, Data> OriginDimensions for LedPixelDrawTarget<'d, CDraw, CDev, S, Data>

where CDraw: RgbColor, CDev: LedPixelColor + From<CDraw>, S: LedPixelShape, Data: DerefMut<Target = [u8]> + FromIterator<u8> + IntoIterator<Item = u8>,

fn size(&self) -> Size

Returns the size of the bounding box.