Struct Layer 

pub struct Layer {
    pub tileset: u8,
    pub collision: u8,
    pub offset: (i32, i32),
    pub scroll: (f32, f32),
    pub wrap: (bool, bool),
    pub visible: bool,
    pub opacity: f32,
    pub tile_dimensions: (u16, u16),
    pub sublayers: Vec<SubLayer>,
    pub sublayer_link: SubLayerLink,
    /* private fields */
}

A single layer of a tilemap.

Fields

tileset: u8

Index of the tileset of this layer.

collision: u8

Index of the collision of this layer.

offset: (i32, i32)

The XY position offset of this layer.

scroll: (f32, f32)

The XY scroll of this layer.

wrap: (bool, bool)

Which axes among XY this layer wraps on.

visible: bool

Whether the layer is visible.

opacity: f32

Opacity of this layer.

tile_dimensions: (u16, u16)

Dimensions of the tiles in this layer.

sublayers: Vec<SubLayer>

The sublayers of this layer. Any more than 255 sublayers will not be saved.

sublayer_link: SubLayerLink

The sublayer link of this layer.

Implementations

impl Layer

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

Resize the layer, filling empty tiles with the tile default (0xFFFF).

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

pub fn add_sublayer(&mut self, default_value: &[u8]) -> &mut SubLayer

Add a new sublayer to the layer, returning a mutable reference to it.

pub fn width(&self) -> u32

Returns the width of the layer.

pub fn height(&self) -> u32

Returns the height of the layer.

pub fn get(&self, (x, y): (usize, usize)) -> Option<&Tile>

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

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

Get a tile 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 = &Tile>

Creates an iterator over each tile of the layer, returning a reference.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut Tile>

Creates an iterator over each tile of the layer, returning a mutable reference.

Trait Implementations

impl Clone for Layer

fn clone(&self) -> Layer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Layer

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

Formats the value using the given formatter.

impl Default for Layer

fn default() -> Self

Returns the “default value” for a type.

impl Index<(usize, usize)> for Layer

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

Index by position and return a reference.

Panics

Panics if index is out of bounds.

type Output = Tile

The returned type after indexing.

impl IndexMut<(usize, usize)> for Layer

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

Index by position and return a mutable reference.

Panics

Panics if index is out of bounds.

impl IntoIterator for Layer

type Item = Tile

The type of the elements being iterated over.

type IntoIter = IntoIter<Tile>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Layer

fn eq(&self, other: &Layer) -> 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 StructuralPartialEq for Layer