Struct amethyst_rendy::sprite::SpriteGrid

pub struct SpriteGrid {
    pub texture_width: u32,
    pub texture_height: u32,
    pub columns: u32,
    pub rows: Option<u32>,
    pub sprite_count: Option<u32>,
    pub cell_size: Option<(u32, u32)>,
    pub position: Option<(u32, u32)>,
}

SpriteGrid controls how a sprite grid is generated when using Sprites::Grid in a SpriteSheetPrefab.

The number of columns in the grid must always be provided, and one of the other fields must also be provided. The grid will be layout row major, starting with the sprite in the upper left corner, and ending with the sprite in the lower right corner. For example a grid with 2 rows and 4 columns will have the order below for the sprites.

|---|---|---|---|
| 0 | 1 | 2 | 3 |
|---|---|---|---|
| 4 | 5 | 6 | 7 |
|---|---|---|---|

Fields

texture_width: u32

Width of the texture in pixels.

texture_height: u32

Height of the texture in pixels.

columns: u32

Specifies the number of columns in the spritesheet, this value must always be given.

rows: Option<u32>

Specifies the number of rows in the spritesheet. If this is not given it will be calculated using either sprite_count (sprite_count / columns), or cell_size (sheet_size / cell_size).

sprite_count: Option<u32>

Specifies the number of sprites in the spritesheet. If this is not given it will be calculated using rows (columns * rows).

cell_size: Option<(u32, u32)>

Specifies the size of the individual sprites in the spritesheet in pixels. If this is not given it will be calculated using the spritesheet size, columns and rows. Tuple order is (width, height).

position: Option<(u32, u32)>

Specifies the position of the grid on a texture. If this is not given it will be set to (0, 0). Positions originate in the top-left corner (bitmap image convention).

Methods

impl SpriteGrid

pub fn build_sprites(&self) -> Vec<Sprite>

Creates a Vec<Sprite> from SpriteGrid.

Trait Implementations

impl Default for SpriteGrid

fn default() -> SpriteGrid

Returns the "default value" for a type.

impl Clone for SpriteGrid

fn clone(&self) -> SpriteGrid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpriteGrid

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

Formats the value using the given formatter.

impl Serialize for SpriteGrid

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for SpriteGrid

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.