pub struct DirtySprite<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize>{ /* 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>
impl<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize> DirtySprite<C, W, H, N, MAX_REGIONS>
pub fn new(clear: C) -> Result<Self, DirtySpriteError>
pub fn dirty_regions(&self) -> impl Iterator<Item = Rectangle> + '_
pub fn clear_dirty(&mut self)
Sourcepub fn invalidate(&mut self, area: Rectangle) -> Result<(), DirtySpriteError>
pub fn invalidate(&mut self, area: Rectangle) -> Result<(), DirtySpriteError>
Marks the portion of area inside the sprite as dirty.
Sourcepub fn invalidate_all(&mut self) -> Result<(), DirtySpriteError>
pub fn invalidate_all(&mut self) -> Result<(), DirtySpriteError>
Marks the entire sprite as dirty.
pub fn pixel(&self, point: Point) -> Option<C>
Sourcepub fn region_pixels(&self, area: Rectangle) -> SpriteRegionPixels<'_, C>
pub fn region_pixels(&self, area: Rectangle) -> SpriteRegionPixels<'_, C>
Returns pixels from a clipped sprite-local region in row-major order.
Sourcepub fn draw_region_at<T>(
&self,
target: &mut T,
source_area: Rectangle,
dest_top_left: Point,
) -> Result<(), T::Error>where
T: DrawTarget<Color = C>,
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.
pub fn set_pixel( &mut self, point: Point, color: C, ) -> Result<(), DirtySpriteError>
Sourcepub fn flush_dirty<T>(&mut self, target: &mut T) -> Result<(), T::Error>where
T: DrawTarget<Color = C>,
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.
Sourcepub fn flush_dirty_at<T>(
&mut self,
target: &mut T,
origin: Point,
) -> Result<(), T::Error>where
T: DrawTarget<Color = C>,
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>
impl<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize> DrawTarget for DirtySprite<C, W, H, N, MAX_REGIONS>
Source§fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>
fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>
Draw individual pixels to the display without a defined order. Read more
Source§fn clear(&mut self, color: Self::Color) -> Result<(), Self::Error>
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>,
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§impl<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize> OriginDimensions for DirtySprite<C, W, H, N, MAX_REGIONS>
impl<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize> OriginDimensions for DirtySprite<C, W, H, N, MAX_REGIONS>
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>
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>
impl<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize> Sync for DirtySprite<C, W, H, N, MAX_REGIONS>
impl<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize> Unpin for DirtySprite<C, W, H, N, MAX_REGIONS>
impl<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize> UnsafeUnpin for DirtySprite<C, W, H, N, MAX_REGIONS>
impl<C, const W: u16, const H: u16, const N: usize, const MAX_REGIONS: usize> UnwindSafe for DirtySprite<C, W, H, N, MAX_REGIONS>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CheckedAs for T
impl<T> CheckedAs for T
Source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.
Source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
Source§fn checked_cast_from(src: Src) -> Option<Dst>
fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.
Source§impl<T> Dimensions for Twhere
T: OriginDimensions,
impl<T> Dimensions for Twhere
T: OriginDimensions,
Source§fn bounding_box(&self) -> Rectangle
fn bounding_box(&self) -> Rectangle
Returns the bounding box.
Source§impl<T> DrawTargetExt for Twhere
T: DrawTarget,
impl<T> DrawTargetExt for Twhere
T: DrawTarget,
Source§fn translated(&mut self, offset: Point) -> Translated<'_, T>
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>
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>
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>
fn color_converted<C>(&mut self) -> ColorConverted<'_, T, C>
Creates a color conversion draw target. Read more
Source§impl<T> OverflowingAs for T
impl<T> OverflowingAs for T
Source§fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
Casts the value.
Source§impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
Source§fn overflowing_cast_from(src: Src) -> (Dst, bool)
fn overflowing_cast_from(src: Src) -> (Dst, bool)
Casts the value.
Source§impl<T> SaturatingAs for T
impl<T> SaturatingAs for T
Source§fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
Casts the value.
Source§impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
Source§fn saturating_cast_from(src: Src) -> Dst
fn saturating_cast_from(src: Src) -> Dst
Casts the value.
Source§impl<T> UnwrappedAs for T
impl<T> UnwrappedAs for T
Source§fn unwrapped_as<Dst>(self) -> Dstwhere
T: UnwrappedCast<Dst>,
fn unwrapped_as<Dst>(self) -> Dstwhere
T: UnwrappedCast<Dst>,
Casts the value.
Source§impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere
Src: UnwrappedCast<Dst>,
impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere
Src: UnwrappedCast<Dst>,
Source§fn unwrapped_cast_from(src: Src) -> Dst
fn unwrapped_cast_from(src: Src) -> Dst
Casts the value.
Source§impl<T> WrappingAs for T
impl<T> WrappingAs for T
Source§fn wrapping_as<Dst>(self) -> Dstwhere
T: WrappingCast<Dst>,
fn wrapping_as<Dst>(self) -> Dstwhere
T: WrappingCast<Dst>,
Casts the value.
Source§impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere
Src: WrappingCast<Dst>,
impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere
Src: WrappingCast<Dst>,
Source§fn wrapping_cast_from(src: Src) -> Dst
fn wrapping_cast_from(src: Src) -> Dst
Casts the value.