Struct Sprite

pub struct Sprite { /* private fields */ }

Specs component representing a sprite that can be drawn.

use blit::{BlitBuffer, Color};
use specs::prelude::*;
use specs_blit::{load, Sprite};

const MASK_COLOR: u32 = 0xFF00FF;

// Setup the specs world
let mut world = World::new();

// Load the blit components into the world
world.register::<Sprite>();

let sprite_ref = {
    // Create a sprite of 4 pixels
    let sprite = BlitBuffer::from_buffer(&[0, MASK_COLOR, 0, 0], 2, MASK_COLOR);

    // Load the sprite and get a reference
    load(sprite)?
};

// Create a new sprite entity in the ECS system
world.create_entity()
    .with(Sprite::new(sprite_ref))
    .build();

Implementations

impl Sprite

pub fn new(sprite_reference: SpriteRef) -> Self

Instantiate a new sprite from a loaded sprite index.

use blit::{BlitBuffer, Color};
use specs_blit::{load, Sprite};

const MASK_COLOR: u32 = 0xFF00FF;

let sprite_ref = {
    // Create a sprite of 4 pixels
    let sprite = BlitBuffer::from_buffer(&[0, MASK_COLOR, 0, 0], 2, MASK_COLOR);

    // Load the sprite and get a reference
    load(sprite)?
};

// Create a specs sprite from the image
let sprite = Sprite::new(sprite_ref);

pub fn set_pos(&mut self, x: i32, y: i32)

Set the pixel position of where the sprite needs to be rendered.

pub fn pos(&self) -> (i32, i32)

Get the pixel position as an (x, y) tuple of where the sprite will be rendered.

pub fn set_rot(&mut self, rotation: i16)

Set the rotation in degrees of the sprite. The rotation will attempt to match the nearest degrees of rotation divisor.

pub fn rot(&self) -> i16

Get the pixel rotation as degrees.

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 Component for Sprite

type Storage = VecStorage<Sprite>

Associated storage type for this component.

impl Debug for Sprite

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

Formats the value using the given formatter.