Skip to main content

Tilemap

Struct Tilemap 

Source
pub struct Tilemap {
    pub width: u16,
    pub height: u16,
    pub entries: Vec<TilemapEntry>,
}
Expand description

A two-dimensional tilemap using TilemapEntry instead of raw byte indices.

Unlike the classic GB TileMap (a flat Vec<u8> of tile indices), this tilemap carries per-tile metadata and supports arbitrary widths and heights.

Fields§

§width: u16

Number of tiles horizontally.

§height: u16

Number of tiles vertically.

§entries: Vec<TilemapEntry>

Row-major tile entries. entries[y * width as usize + x].

Implementations§

Source§

impl Tilemap

Source

pub fn new(width: u16, height: u16) -> Self

Creates a new tilemap filled with default entries (tile_id = 0, no flips, no collision/animation overrides).

§Panics

Panics if width or height is 0.

Source

pub fn from_gb_tilemap(data: &[u8], width: u16, height: u16) -> Self

Converts a classic Game Boy tilemap (flat &[u8] of tile indices) into a Tilemap of TilemapEntrys.

Each byte in data becomes a TilemapEntry with that byte as tile_id and all other fields set to their defaults.

§Panics

Panics if data.len() is less than width * height.

Source

pub fn in_bounds(&self, x: u16, y: u16) -> bool

Returns true if (x, y) is within bounds.

Source

pub fn get(&self, x: u16, y: u16) -> Option<&TilemapEntry>

Returns a reference to the tile entry at (x, y), or None if out of bounds.

Source

pub fn get_mut(&mut self, x: u16, y: u16) -> Option<&mut TilemapEntry>

Returns a mutable reference to the tile entry at (x, y), or None if out of bounds.

Source

pub fn set(&mut self, x: u16, y: u16, entry: TilemapEntry)

Sets the tile entry at (x, y). Silently does nothing if out of bounds.

Source

pub fn fill_rect(&mut self, x: u16, y: u16, w: u16, h: u16, entry: TilemapEntry)

Fills a rectangular region with copies of entry.

Coordinates are clamped to the tilemap bounds; no-op if the region lies entirely outside.

Trait Implementations§

Source§

impl Clone for Tilemap

Source§

fn clone(&self) -> Tilemap

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 Debug for Tilemap

Source§

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

Formats the value using the given formatter. Read more

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> 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<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> 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 = Infallible

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.