[][src]Struct amethyst_rendy::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[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for SpriteSheetFormat[src]

impl Format<SpriteSheet> for SpriteSheetFormat[src]

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

Reads the given bytes and produces asset data. Read more

Auto Trait Implementations

impl Unpin for SpriteSheetFormat

impl Sync for SpriteSheetFormat

impl Send for SpriteSheetFormat

impl UnwindSafe for SpriteSheetFormat

impl RefUnwindSafe for SpriteSheetFormat

Blanket Implementations

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
    D: AdaptFrom<S, Swp, Dwp, T>,
    Dwp: WhitePoint,
    Swp: WhitePoint,
    T: Component + Float
[src]

fn adapt_into(self) -> D[src]

Convert the source color to the destination color using the bradford method by default Read more

impl<T> SetParameter for T[src]

fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
    T: Parameter<Self>, 
[src]

Sets value as a parameter of self.

impl<T> Supports<T> for T[src]

impl<T> Erased for T[src]

impl<T> Same<T> for T[src]

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 
[src]

impl<T> Resource for T where
    T: Any + Send + Sync
[src]

impl<T> Any for T where
    T: Any
[src]

impl<T> Event for T where
    T: Send + Sync + 'static, 
[src]

impl<T> Clone for T where
    T: Clone
[src]