Struct simple_tilemap::Tile

pub struct Tile<U = ()> {
    pub id: TileId,
    pub color: Color,
    pub opts: BlitOptions,
    pub data: U,
}

Tile in a Tilemap.

Fields

id: TileId

Id of the tile.

color: Color

Color of the tile. Will be multiplied by the tile’s ‘original’ color (the one in the tileset).

opts: BlitOptions

Blit options.

data: U

Custom user data.

Implementations

impl<U> Tile<U>

where U: Default,

pub fn new(id: TileId) -> Self

Contruct a new tile.

impl<U> Tile<U>

pub fn with_color(self, color: Color) -> Self

Set tile color.

Allows for chaining tile creation like Tile::new(4).with_color(Color::new(255, 0, 255, 255)).solid() etc.

pub fn set_color(&mut self, color: Color) -> &mut Self

Set tile color.

Allows for chaining tile modifying like tilemap.get_mut_tile(1, 1).unwrap().set_color(Color::new(255, 0, 255, 255)) etc.

pub fn with_user_data(self, data: U) -> Self

Set tile user data.

Allows for chaining tile creation like Tile::new(4).with_color(Color::new(255, 0, 255, 255)) etc.

pub fn set_user_data(&mut self, data: U) -> &mut Self

Set tile user data.

Allows for chaining tile modifying like tilemap.get_mut_tile(1, 1).unwrap().set_color(Color::new(255, 0, 255, 255)) etc.

pub fn with_blit_options(self, opts: BlitOptions) -> Self

Specify the blit options.

Allows for chaining tile creation like Tile::new(4).with_color(Color::new(255, 0, 255, 255)) etc.

pub fn set_blit_options(&mut self, opts: BlitOptions) -> &mut Self

Set the tile’s blit options.

Allows for chaining tile modifying like tilemap.get_mut_tile(1, 1).unwrap().set_color(Color::new(255, 0, 255, 255)) etc.

Trait Implementations

impl<C> Buffer<Tile> for Tilemap<C>

fn width(&self) -> u32

Buffer width

fn height(&self) -> u32

Buffer height

fn get(&self, x: u32, y: u32) -> &Tile

Get a value at (x, y). This function must not panic when x < self.width() && y < self.height() (unless you want blit functions to panic). It will not be called with values outside of that range.

impl<C> BufferMut<Tile> for Tilemap<C>

fn get_mut(&mut self, x: u32, y: u32) -> &mut Tile

Get a mutable value at (x, y). This function must not panic when x < self.width() && y < self.height() (unless you want blit functions to panic). It will not be called with values outside of that range.

impl<U: Clone> Clone for Tile<U>

fn clone(&self) -> Tile<U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<U: Debug> Debug for Tile<U>

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

Formats the value using the given formatter.

impl<U: Default> Default for Tile<U>

fn default() -> Tile<U>

Returns the “default value” for a type.

impl<U: PartialEq> PartialEq for Tile<U>

fn eq(&self, other: &Tile<U>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<U: Copy> Copy for Tile<U>

impl<U: Eq> Eq for Tile<U>

impl<U> StructuralEq for Tile<U>

impl<U> StructuralPartialEq for Tile<U>