Skip to main content

TileGrid

Struct TileGrid 

Source
pub struct TileGrid { /* private fields */ }
Expand description

A display region divided into tiles for low-memory drawing.

CydDisplay::for_each_tile redraws the same logical-display-coordinate scene into each tile, clipping drawing to that tile before flushing it.

The tiled region may cover the full display or only a subregion. Some tiles may be smaller when the region does not divide evenly.

§Example

use device_envoy_core::{
    UnwrapInfallible,
    cyd::{
        CydDisplay,
        display::{CydFrame, tiling::TileGrid},
    },
};
use embedded_graphics::{
    Drawable,
    pixelcolor::Rgb565,
    prelude::{Point, Primitive, RgbColor, Size},
    primitives::{Circle, Line, PrimitiveStyle, Rectangle},
};

// Tile the entire 320 × 240 display. The grid could instead cover a subregion.
const GRID: TileGrid = TileGrid::new(
    Rectangle::new(Point::zero(), Size::new(320, 240)),
    4, // columns
    3, // rows
);
async fn draw<D: CydDisplay>(display: &mut D) -> Result<(), D::Error> {
    display
        .for_each_tile(GRID, |frame| {
            frame.fill(Rgb565::BLACK);
            Circle::new(Point::new(85, 45), 150)
                .into_styled(PrimitiveStyle::with_fill(Rgb565::BLUE))
                .draw(frame)
                .unwrap_infallible();
            Line::new(Point::new(20, 210), Point::new(300, 30))
                .into_styled(PrimitiveStyle::with_stroke(Rgb565::YELLOW, 5))
                .draw(frame)
                .unwrap_infallible();
            // Outline the current tile's frame rectangle so the tiling is visible.
            frame
                .rectangle()
                .into_styled(PrimitiveStyle::with_stroke(Rgb565::WHITE, 1))
                .draw(frame)
                .unwrap_infallible();
        })
        .await
}

assert_eq!(GRID.max_tile_pixel_count(), 80 * 80);

A 320 × 240 region split into 4 × 3 tiles uses one 80 × 80 frame buffer. The white outlines show the individual frames; the scene remains continuous across their boundaries.

Implementations§

Source§

impl TileGrid

Source

pub const fn new(rectangle: Rectangle, columns: usize, rows: usize) -> Self

Creates a grid splitting rectangle into columns × rows tiles.

rectangle.top_left determines where the tiled region is drawn and flushed on the display.

Panics if either count is zero or exceeds the corresponding rectangle dimension. See the TileGrid example for construction, buffer sizing, and tiled drawing.

Source

pub const fn rectangle(&self) -> Rectangle

Returns the display region covered by this grid.

Source

pub const fn columns(&self) -> usize

Number of tile columns the rectangle is split into.

Source

pub const fn rows(&self) -> usize

Number of tile rows the rectangle is split into.

Source

pub const fn tile_width(&self) -> usize

Nominal tile width: the rectangle width divided by the column count, rounded up.

Source

pub const fn tile_height(&self) -> usize

Nominal tile height: the rectangle height divided by the row count, rounded up.

Source

pub const fn max_tile_pixel_count(&self) -> usize

Largest pixel count any single tile can have.

Use this as the reusable frame-buffer capacity for CydDisplay::for_each_tile. Edge tiles may be smaller when the region does not divide evenly.

See the TileGrid example.

Trait Implementations§

Source§

impl Clone for TileGrid

Source§

fn clone(&self) -> TileGrid

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for TileGrid

Source§

impl Debug for TileGrid

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for TileGrid

Source§

impl PartialEq for TileGrid

Source§

fn eq(&self, other: &TileGrid) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TileGrid

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> StrictAs for T

Source§

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

Source§

fn strict_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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, <T as TryFrom<U>>::Error>

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.