Struct tesserae::TileSet

pub struct TileSet { /* fields omitted */ }

A set of 512 8x8 pixel monochrome tiles, along with a map for the basic 256 ASCII characters to tile indices. Most tile sets only include character mappings for the typable characters on a conventional keyboard.

If indexed with usize, gives the 64 bit integer corresponding to the tile data for that tile index. Can also be mutated by assigning to a particular usize index.

Can also be indexed by char, which gives the tile index (a usize) corresponding to that particular character. The character map can be changed by assigning to a particular char index.

Methods

impl TileSet

pub fn blank() -> TileSet

Create a blank tile set with 512 tiles (all pixels off) and the default character map.

pub fn load_file<P: AsRef<Path>>(path: P) -> Result<TileSet>

Load a tile set from the file with the given path. Sugar for load_from with File::open.

pub fn load_from<R: Read>(input: R) -> TileSet

Load a tile set from a Read instance such as a file. Commonly used with include_bin! like so:

let ts = include_bytes!("tile_set");
TileSet::load_from(Cursor::new(&ts[..]))

pub fn default() -> TileSet

A built-in tile set used in, among other things, the tesseraed editor.

pub fn cga_ascii() -> TileSet

A built-in tile set containing the 256 CGA standard ASCII characters using the font used in Hercules graphics cards.

pub fn petscii() -> TileSet

The regular, all-uppercase shifted PETscii tile set used in Commodore PET and Commodore 64 machines.

pub fn petscii_unshifted() -> TileSet

The unshifted PETscii tile set which includes lower case letters used in Commodore PET and Commodore 64 machines.

pub fn store<P: AsRef<Path>>(&self, path: P) -> Result<()>

Save the tileset to a file at the provided path.

pub fn len(&self) -> usize

Should always return 512, but using this gives you future-proofing in case the tile set size changes in future.

Trait Implementations

impl Clone for TileSet

fn clone(&self) -> TileSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Index<char> for TileSet

type Output = usize

The returned type after indexing.

fn index(&self, index: char) -> &usize

Performs the indexing (container[index]) operation.

impl Index<usize> for TileSet

type Output = u64

The returned type after indexing.

fn index(&self, index: usize) -> &u64

Performs the indexing (container[index]) operation.

impl IndexMut<char> for TileSet

fn index_mut(&mut self, index: char) -> &mut usize

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for TileSet

fn index_mut(&mut self, index: usize) -> &mut u64

Performs the mutable indexing (container[index]) operation.