Struct ws2812_esp32_rmt_driver::lib_embedded_graphics::LedPixelDrawTarget

pub struct LedPixelDrawTarget<CDraw, CDev, S>where
    CDraw: RgbColor,
    CDev: LedPixelColor + From<CDraw>,
    S: LedPixelShape,{ /* private fields */ }

Available on crate features embedded-graphics-core and unstable only.

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

• 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

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

Implementations

impl<CDraw, CDev, S> LedPixelDrawTarget<CDraw, CDev, S>where
    CDraw: RgbColor,
    CDev: LedPixelColor + From<CDraw>,
    S: LedPixelShape,

pub fn new(
    channel_num: u8,
    gpio_num: u32
) -> Result<Self, Ws2812Esp32RmtDriverError>

Create a new draw target.

channel_num shall be different between different gpio_num.

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<CDraw, CDev, S> DrawTarget for LedPixelDrawTarget<CDraw, CDev, S>where
    CDraw: RgbColor,
    CDev: LedPixelColor + From<CDraw>,
    S: LedPixelShape,

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<CDraw, CDev, S> OriginDimensions for LedPixelDrawTarget<CDraw, CDev, S>where
    CDraw: RgbColor,
    CDev: LedPixelColor + From<CDraw>,
    S: LedPixelShape,

fn size(&self) -> Size

Returns the size of the bounding box.