Struct SpriteSheet 

pub struct SpriteSheet {
    pub path: String,
    pub timer: Timer,
    pub tile_width: f32,
    pub tile_height: f32,
    pub rows: u32,
    pub columns: u32,
    pub indices: Vec<u32>,
    pub current_index: u32,
    pub animation_state: AnimationState,
    pub looping_state: LoopingState,
}

Struct to represent a sprite sheet.

Fields

path: String

timer: Timer

tile_width: f32

tile_height: f32

rows: u32

columns: u32

indices: Vec<u32>

current_index: u32

animation_state: AnimationState

looping_state: LoopingState

Implementations

impl SpriteSheet

pub fn new( path: String, looping_state: LoopingState, tile_size: (f32, f32), time_between_tiles: f32, rows: u32, columns: u32, indices: Vec<u32>, ) -> Self

Creates a new sprite sheet struct.

Examples found in repository

examples/simple_animation.rs (lines 17-25)

fn setup(context: &mut Context) {
    let dummy: Sprite = Sprite::new("textures/lotus_pink_128x128.png".to_string());
    let scarfy_sprite_sheet: SpriteSheet = SpriteSheet::new(
        "textures/animations/scarfy.png".to_string(),
        LoopingState::Once,
        (124.0, 124.0),
        0.5,
        1,
        6,
        vec![0, 1, 2, 3, 4, 5]
    );

    let mut animation: Animation = Animation::default();
    animation.add_sprite_sheet("run".to_string(), scarfy_sprite_sheet);
    context.commands.spawn(vec![Box::new(dummy), Box::new(animation)]);
}

examples/player_animation.rs (lines 21-29)

fn setup(context: &mut Context) {
    context.game_loop_listener.fps_cap(120);

    let idle: SpriteSheet = SpriteSheet::new(
        "textures/animations/player/idle.png".to_string(),
        LoopingState::Repeat,
        (512.0, 512.0),
        0.1,
        1,
        10,
        (0..=9).collect()
    );
    let attack: SpriteSheet = SpriteSheet::new(
        "textures/animations/player/attack.png".to_string(),
        LoopingState::Repeat,
        (512.0, 512.0),
        0.1,
        1,
        7,
        (0..=6).collect()
    );
    let walk: SpriteSheet = SpriteSheet::new(
        "textures/animations/player/walk.png".to_string(),
        LoopingState::Repeat,
        (512.0, 512.0),
        0.1,
        1,
        16,
        (0..=15).collect()
    );

    let mut my_animations: HashMap<String, SpriteSheet> = HashMap::new();
    my_animations.insert("idle".to_string(), idle);
    my_animations.insert("attack".to_string(), attack);
    my_animations.insert("walk".to_string(), walk);

    let mut animation: Animation = Animation::new(my_animations);
    animation.play("idle".to_string());

    context.commands.spawn(vec![
        Box::new(animation),
        Box::new(Velocity::new(Vector2::new(0.5, 0.5)))
    ]);
}

Trait Implementations

impl Clone for SpriteSheet

fn clone(&self) -> SpriteSheet

Returns a duplicate of the value.

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

Performs copy-assignment from source.