Struct SubLayer 

pub struct SubLayer { /* private fields */ }

A sublayer within a layer of a tilemap.

Implementations

impl SubLayer

pub fn resize(&mut self, width: u32, height: u32)

Resize the sublayer, filling empty tiles with the sublayer’s default value.

If the width is changed, this will reallocate the data buffer!

Sanity

The layer this is put into should be the same size as the new size.

Panics

Panics if the resulting area overflows a u32.

pub fn cell_size(&self) -> u8

Returns the size of one data cell.

pub fn width(&self) -> u32

Returns the width of the sublayer.

pub fn height(&self) -> u32

Returns the height of the sublayer.

pub fn set_default(&mut self, default: &[u8])

Set the default value of the sublayer, resizing all cells to its length.

The default value is truncated to 4 bytes if larger.

If the new default value is larger than the old one, all cells are zero padded to the new length.

If the new default is smaller, all cells are truncated to its length.

This will only not reallocate if the length of the new default is the same as the old one!

pub fn get(&self, (x, y): (u32, u32)) -> Option<&[u8]>

Get a cell by position. Returns None if out of bounds.

pub fn get_mut(&mut self, (x, y): (u32, u32)) -> Option<&mut [u8]>

Get a cell by position, mutably. Returns None if out of bounds

pub fn new() -> Self

Constructs a new instance from the default.

pub fn iter(&self) -> impl Iterator<Item = &[u8]>

Creates an iterator over each cell of the sublayer, returning a slice.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut [u8]>

Creates an iterator over each cell of the sublayer, returning a mutable slice.

Trait Implementations

impl Clone for SubLayer

fn clone(&self) -> SubLayer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubLayer

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

Formats the value using the given formatter.

impl Default for SubLayer

fn default() -> SubLayer

Returns the “default value” for a type.

impl Index<(u32, u32)> for SubLayer

fn index(&self, (x, y): (u32, u32)) -> &Self::Output

Index by position and return a reference.

Panics

Panics if index is out of bounds.

type Output = [u8]

The returned type after indexing.

impl IndexMut<(u32, u32)> for SubLayer

fn index_mut(&mut self, (x, y): (u32, u32)) -> &mut Self::Output

Index by position and return a mutable reference.

Panics

Panics if index is out of bounds.

impl PartialEq for SubLayer

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SubLayer

impl StructuralPartialEq for SubLayer