Struct texel_types::Sprite

pub struct Sprite {
    pub frames: Vec<Texels>,
    pub index: usize,
    pub id: Option<u32>,
    pub labels: HashMap<String, String>,
}

Sprite represents a 2D ASCII art picture with frame animation

Fields

frames: Vec<Texels>

List of Frame data consisting of texels

index: usize

Current Frame Index

id: Option<u32>

Optional ID number to identify sprite in a scene

labels: HashMap<String, String>

Optional list of labels for grouping sprites in a scene, key value pair labels

Implementations

impl Sprite

pub fn frame_index(&self) -> usize

Current frame index for this sprite

pub fn frame_count(&self) -> usize

Sprite frame count

pub fn new_frame(&mut self)

Creates a new frame copying contents of current frame

pub fn delete_frame(&mut self) -> bool

Deletes current frame

pub fn apply_frame_change(&mut self, which: Which<usize>) -> usize

Applies given frame change according to the which argument

pub fn read_area(&self, area: Bounds) -> impl Iterator<Item = &Texel>

Gives a read-only iterator over Texels in given area of this Sprite

pub fn read_texel(&self, pos: Position2D) -> Option<&Texel>

pub fn copy_area(&self, area: Bounds) -> Texels

Copies an area of given frame in the area: Bounds as Vec

pub fn all_iter(&self) -> impl Iterator<Item = &Texel>

Iterator for list of Texel for all frames in the sprite

pub fn all_iter_mut(&mut self) -> impl Iterator<Item = &mut Texel>

Mutable iterator for list of Texel for all frames in the sprite

pub fn frame_iter(&self) -> impl Iterator<Item = &Texel>

Iterator over current frame's list of Texel

pub fn frame_iter_mut(&mut self) -> impl Iterator<Item = &mut Texel>

Mutable iterator over current frame's list of Texel

pub fn from_txt_file(abs_path: &Path) -> Result<Self, Error>

Creates a sprite from given text file with default styles and colors

pub fn from_texels(texels: Texels) -> Sprite

Creates a sprite from list of texels, single frame

pub fn fill_color(&mut self, cm: ColorMode, color: u8) -> bool

Fills entire frame with color according to the ColorMode

pub fn fill_style(&mut self, style: SymbolStyle) -> bool

Fills entire frame with given SymbolStyle

pub fn apply_symbol(
    &mut self,
    symbol: char,
    bg: u8,
    fg: u8,
    area: Bounds
) -> Bounds

Applies symbol with bg/fg color combination in given Bounds area

pub fn apply_texels(&mut self, texels: Texels, pos: Position2D) -> Bounds

Applies texels starting at given pos Position2D

pub fn apply_color(&mut self, cm: ColorMode, color: u8, area: Bounds) -> bool

Applies color according to ColorMode in the given Bounds area

pub fn apply_style(&mut self, style: SymbolStyle, area: Bounds) -> bool

Applies a single style for the given Bounds area

pub fn clear_symbol(&mut self, area: Bounds) -> Option<Bounds>

Removes texels in given Bounds area

pub fn is_empty(&self) -> bool

Empty check, true if all frames empty

Trait Implementations

impl Clone for Sprite

fn clone(&self) -> Sprite

Returns a copy 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() -> Self

Returns the "default value" for a type.

impl Eq for Sprite

impl From<SpriteV1> for Sprite

fn from(old: SpriteV1) -> Self

Performs the conversion.

impl IntoIterator for Sprite

type Item = Texel

The type of the elements being iterated over.

type IntoIter = IntoIter<Self::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Sprite> for Sprite

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

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

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

This method tests for !=.

impl StructuralEq for Sprite

impl StructuralPartialEq for Sprite