Skip to main content

DirtySprite

Struct DirtySprite 

Source
pub struct DirtySprite<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize>
where C: PixelColor + Copy + Default,
{ /* private fields */ }
Expand description

Off-screen framebuffer that tracks the rectangles touched by draw calls.

Use a full-screen sprite (W=320, H=240) when RAM is available, or create smaller sprites per widget. N must be at least W * H; it is separate from W/H to stay on stable Rust without generic-const arithmetic.

Implementations§

Source§

impl<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize> DirtySprite<C, W, H, N, MAX_REGIONS>
where C: PixelColor + Copy + Default,

Source

pub fn new(clear: C) -> Result<Self, DirtySpriteError>

Source

pub fn dirty_regions(&self) -> impl Iterator<Item = Rectangle> + '_

Source

pub fn clear_dirty(&mut self)

Source

pub fn invalidate(&mut self, area: Rectangle) -> Result<(), DirtySpriteError>

Marks the portion of area inside the sprite as dirty.

Source

pub fn invalidate_all(&mut self) -> Result<(), DirtySpriteError>

Marks the entire sprite as dirty.

Source

pub fn pixel(&self, point: Point) -> Option<C>

Source

pub fn region_pixels(&self, area: Rectangle) -> SpriteRegionPixels<'_, C>

Returns pixels from a clipped sprite-local region in row-major order.

Source

pub fn draw_region_at<T>( &self, target: &mut T, source_area: Rectangle, dest_top_left: Point, ) -> Result<(), T::Error>
where T: DrawTarget<Color = C>,

Draws a clipped sprite-local region into another draw target.

Source

pub fn set_pixel( &mut self, point: Point, color: C, ) -> Result<(), DirtySpriteError>

Source

pub fn flush_dirty<T>(&mut self, target: &mut T) -> Result<(), T::Error>
where T: DrawTarget<Color = C>,

Repaint only dirty rectangles into a concrete display draw target.

Source

pub fn flush_dirty_at<T>( &mut self, target: &mut T, origin: Point, ) -> Result<(), T::Error>
where T: DrawTarget<Color = C>,

Repaint only dirty rectangles into a concrete display draw target at origin.

Trait Implementations§

Source§

impl<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize> DrawTarget for DirtySprite<C, W, H, N, MAX_REGIONS>
where C: PixelColor + Copy + Default,

Source§

type Color = C

The pixel color type the targetted display supports.
Source§

type Error = !

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

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. 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<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. 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<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize> OriginDimensions for DirtySprite<C, W, H, N, MAX_REGIONS>
where C: PixelColor + Copy + Default,

Source§

fn size(&self) -> Size

Returns the size of the bounding box.

Auto Trait Implementations§

§

impl<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize> Freeze for DirtySprite<C, W, H, N, MAX_REGIONS>
where [C; N]: Freeze, RegionSet<MAX_REGIONS>: Freeze,

§

impl<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize> RefUnwindSafe for DirtySprite<C, W, H, N, MAX_REGIONS>

§

impl<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize> Send for DirtySprite<C, W, H, N, MAX_REGIONS>
where [C; N]: Send, RegionSet<MAX_REGIONS>: Send,

§

impl<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize> Sync for DirtySprite<C, W, H, N, MAX_REGIONS>
where [C; N]: Sync, RegionSet<MAX_REGIONS>: Sync,

§

impl<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize> Unpin for DirtySprite<C, W, H, N, MAX_REGIONS>
where [C; N]: Unpin, RegionSet<MAX_REGIONS>: Unpin,

§

impl<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize> UnsafeUnpin for DirtySprite<C, W, H, N, MAX_REGIONS>
where [C; N]: UnsafeUnpin, RegionSet<MAX_REGIONS>: UnsafeUnpin,

§

impl<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize> UnwindSafe for DirtySprite<C, W, H, N, MAX_REGIONS>
where [C; N]: UnwindSafe, RegionSet<MAX_REGIONS>: 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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

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

Source§

fn bounding_box(&self) -> Rectangle

Returns the bounding box.
Source§

impl<T> DrawTargetExt for T
where T: DrawTarget,

Source§

fn translated(&mut self, offset: Point) -> Translated<'_, T>

Creates a translated draw target based on this draw target. Read more
Source§

fn cropped(&mut self, area: &Rectangle) -> Cropped<'_, T>

Creates a cropped draw target based on this draw target. Read more
Source§

fn clipped(&mut self, area: &Rectangle) -> Clipped<'_, T>

Creates a clipped draw target based on this draw target. Read more
Source§

fn color_converted<C>(&mut self) -> ColorConverted<'_, T, C>
where C: PixelColor + Into<<T as DrawTarget>::Color>,

Creates a color conversion draw target. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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