Struct ws2812_esp32_rmt_driver::lib_embedded_graphics::LedPixelDrawTarget

source · [−]

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.

Expand description

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

source

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

source

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.

source

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.

source

pub fn brightness(&self) -> u8

Returns maximum brightness.

source

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

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

source

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

Write changes from a framebuffer to the LED pixels

Trait Implementations

source

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

source

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

Draw individual pixels to the display without a defined order. Read more

source

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

Fill the entire display with a solid color. 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

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

source

fn size(&self) -> Size

Returns the size of the bounding box.

Auto Trait Implementations

impl<CDraw, CDev, S> RefUnwindSafe for LedPixelDrawTarget<CDraw, CDev, S> where
 CDev: RefUnwindSafe,
 CDraw: RefUnwindSafe,
 S: RefUnwindSafe,

impl<CDraw, CDev, S> Send for LedPixelDrawTarget<CDraw, CDev, S> where
 CDev: Send,
 CDraw: Send,
 S: Send,

impl<CDraw, CDev, S> Sync for LedPixelDrawTarget<CDraw, CDev, S> where
 CDev: Sync,
 CDraw: Sync,
 S: Sync,

impl<CDraw, CDev, S> Unpin for LedPixelDrawTarget<CDraw, CDev, S> where
 CDev: Unpin,
 CDraw: Unpin,
 S: Unpin,

impl<CDraw, CDev, S> UnwindSafe for LedPixelDrawTarget<CDraw, CDev, S> where
 CDev: UnwindSafe,
 CDraw: UnwindSafe,
 S: 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 ws2812_esp32_rmt_driver::lib_embedded_graphics::LedPixelDrawTarget

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>

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

pub fn brightness(&self) -> u8

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

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

Trait Implementations

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

type Color = CDraw

type Error = Ws2812Esp32RmtDriverError

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

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

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

fn size(&self) -> Size

Auto Trait Implementations

impl<CDraw, CDev, S> RefUnwindSafe for LedPixelDrawTarget<CDraw, CDev, S> where CDev: RefUnwindSafe, CDraw: RefUnwindSafe, S: RefUnwindSafe,

impl<CDraw, CDev, S> Send for LedPixelDrawTarget<CDraw, CDev, S> where CDev: Send, CDraw: Send, S: Send,

impl<CDraw, CDev, S> Sync for LedPixelDrawTarget<CDraw, CDev, S> where CDev: Sync, CDraw: Sync, S: Sync,

impl<CDraw, CDev, S> Unpin for LedPixelDrawTarget<CDraw, CDev, S> where CDev: Unpin, CDraw: Unpin, S: Unpin,

impl<CDraw, CDev, S> UnwindSafe for LedPixelDrawTarget<CDraw, CDev, S> where CDev: UnwindSafe, CDraw: UnwindSafe, S: 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<T> WrappingAs for T

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

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

fn wrapping_cast_from(src: Src) -> Dst

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>

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

fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error> where
I: 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<CDraw, CDev, S> OriginDimensions for LedPixelDrawTarget<CDraw, CDev, S> where
CDraw: RgbColor,
CDev: LedPixelColor + From<CDraw>,
S: LedPixelShape,

impl<CDraw, CDev, S> RefUnwindSafe for LedPixelDrawTarget<CDraw, CDev, S> where
CDev: RefUnwindSafe,
CDraw: RefUnwindSafe,
S: RefUnwindSafe,

impl<CDraw, CDev, S> Send for LedPixelDrawTarget<CDraw, CDev, S> where
CDev: Send,
CDraw: Send,
S: Send,

impl<CDraw, CDev, S> Sync for LedPixelDrawTarget<CDraw, CDev, S> where
CDev: Sync,
CDraw: Sync,
S: Sync,

impl<CDraw, CDev, S> Unpin for LedPixelDrawTarget<CDraw, CDev, S> where
CDev: Unpin,
CDraw: Unpin,
S: Unpin,

impl<CDraw, CDev, S> UnwindSafe for LedPixelDrawTarget<CDraw, CDev, S> where
CDev: UnwindSafe,
CDraw: UnwindSafe,
S: 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>,