Struct amethyst_rendy::sprite::SpriteSheetFormat

pub struct SpriteSheetFormat(pub Handle<Texture>);

Allows loading of sprite sheets in RON format.

This format allows to conveniently load a sprite sheet from a RON file.

Example:

#![enable(implicit_some)]
(
    // Width of the texture
    texture_width: 48,
    // Height of the texture
    texture_height: 16,
    // List of sprites the sheet holds
    sprites: [
        (
            // Horizontal position of the sprite in the sprite sheet
            x: 0,
            // Vertical position of the sprite in the sprite sheet
            y: 0,
            // Width of the sprite
            width: 16,
            // Height of the sprite
            height: 16,
            // Number of pixels to shift the sprite to the left and down relative to the entity holding it when rendering
            offsets: (0.0, 0.0), // This is optional and defaults to (0.0, 0.0)
        ),
        (
            x: 16,
            y: 0,
            width: 32,
            height: 16,
        ),
    ],
)

Such a spritesheet description can be loaded using a Loader by passing it the handle of the corresponding loaded texture.

let texture_handle = loader.load(
    "my_texture.png",
    ImageFormat(Default::default()),
    (),
    &texture_storage,
);
let spritesheet_handle = loader.load(
    "my_spritesheet.ron",
    SpriteSheetFormat(texture_handle),
    (),
    &spritesheet_storage,
);

Trait Implementations

impl Clone for SpriteSheetFormat

fn clone(&self) -> SpriteSheetFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpriteSheetFormat

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

Formats the value using the given formatter.

impl Format<SpriteSheet> for SpriteSheetFormat

fn name(&self) -> &'static str

A unique identifier for this format.

fn import_simple(&self, bytes: Vec<u8>) -> Result<SpriteSheet, Error>

Produces asset data from given bytes. This method is a simplified version of format. This format assumes that the asset name is the full path and the asset is only contained in one file.

fn import(
    &self,
    name: String,
    source: Arc<dyn Source + 'static>,
    create_reload: Option<Box<dyn Format<D> + 'static>>
) -> Result<FormatValue<D>, Error>

Reads the given bytes and produces asset data.