Struct Sprite 

pub struct Sprite {
    pub width: usize,
    pub height: usize,
    /* private fields */
}

A 2D sprite consisting of glyphs and color values.

Sprites can be drawn using ConsoleGameEngine methods like draw_sprite or draw_partial_sprite.

Fields

width: usize

Width of the sprite in characters.

height: usize

Height of the sprite in characters.

Implementations

impl Sprite

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

Creates a new sprite of the given width and height. All glyphs are initialized to PIXEL_EMPTY and all colors to FG_BLACK.

pub fn from_file(path: &str) -> Result<Self, Box<dyn Error>>

Loads a sprite from a file (by convention ending in .spr). The file must contain width and height (u32 little-endian) followed by colors and glyphs.

pub fn save_to_file(&self, path: &str) -> Result<(), Box<dyn Error>>

Saves the sprite to a .spr file in the same format as from_file.

pub fn set_glyph(&mut self, x: usize, y: usize, g: u16)

Sets the glyph at (x, y) to c.

pub fn set_color(&mut self, x: usize, y: usize, c: u16)

Sets the color at (x, y) to c.

pub fn get_glyph(&self, x: usize, y: usize) -> u16

Returns the glyph at (x, y), or PIXEL_EMPTY if out of bounds.

pub fn get_color(&self, x: usize, y: usize) -> u16

Returns the color at (x, y), or FG_BLACK if out of bounds.

pub fn sample_glyph(&self, x: f32, y: f32) -> u16

Samples the glyph at normalized coordinates (x, y) in [0.0, 1.0) space. Wrapping occurs for coordinates outside the [0,1) range.

pub fn sample_color(&self, x: f32, y: f32) -> u16

Samples the color at normalized coordinates (x, y) in [0.0, 1.0) space. Wrapping occurs for coordinates outside the [0,1) range.

Trait Implementations

impl Clone for Sprite

fn clone(&self) -> Sprite

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sprite

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

Formats the value using the given formatter.

impl Default for Sprite

fn default() -> Sprite

Returns the “default value” for a type.

impl PartialEq for Sprite

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