Struct radiant_rs::Sprite

pub struct Sprite { /* 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.)

Methods

impl<'a> Sprite

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

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

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

Creates a new sprite texture.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

Draws a sprite onto the given layer.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

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

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn set_anchor(&mut self, anchor: (f32, f32)) -> &Self

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.

pub fn width(&self) -> u32

Returns the width of the sprite.

pub fn height(&self) -> u32

Returns the height of the sprite.

pub fn num_frames(&self) -> u32

Returns the number of frames of the sprite.

pub 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.

impl Debug for Sprite

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.