Struct radiant_rs::Sprite

pub struct Sprite {
    pub anchor: Point2,
    // some fields omitted
}

A sprite used for drawing on a Layer.

Sprites are created from spritesheets containing one or more frames. To determine frame dimensions, Sprite::from_file() expects sprite sheet file names to follow a specific pattern. (Future versions will add more configurable means to load sprites.)

Fields

anchor: Point2

Defines the sprite origin. Defaults to (0.5, 0.5), meaning that the center of the sprite would be drawn at the coordinates given to Sprite::draw(). Likewise, (0.0, 0.0) would mean that the sprite's top left corner would be drawn at the given coordinates.

Methods

impl<'a> Sprite

fn from_file(context: &RenderContext, file: &str) -> Result<Sprite>

Creates a new sprite texture. Given filename is expected to end on _xx., e.g. asteroid_64x64x24.png.

fn from_data(context: &RenderContext,
             data: &[u8],
             parameters: &SpriteParameters)
             -> Result<Sprite>

Creates a new sprite texture.

fn draw<T>(&self,
           layer: &Layer,
           frame_id: u32,
           position: T,
           color: Color)
           -> &Self where Vec2<f32>: From<T>

Draws a sprite onto the given layer.

fn draw_transformed<T, U>(&self,
                          layer: &Layer,
                          frame_id: u32,
                          position: T,
                          color: Color,
                          rotation: f32,
                          scale: U)
                          -> &Self where Vec2<f32>: From<T> + From<U>

Draws a sprite onto the given layer and applies given color, rotation and scaling.

fn width(&self) -> f32

Returns the width of the sprite.

fn height(&self) -> f32

Returns the height of the sprite.

fn num_frames(&self) -> u32

Returns the number of frames of the sprite.

fn arc(self) -> Arc<Self>

Returns the sprite wrapped in an std::Arc

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.