Struct bevy::sprite::TextureAtlas

pub struct TextureAtlas {
    pub texture: Handle<Image>,
    pub size: Vec2,
    pub textures: Vec<Rect, Global>,
    pub texture_handles: Option<HashMap<Handle<Image>, usize, RandomState, Global>>,
}

An atlas containing multiple textures (like a spritesheet or a tilemap). Example usage animating sprite. Example usage loading sprite sheet.

Fields

texture: Handle<Image>

The handle to the texture in which the sprites are stored

size: Vec2

textures: Vec<Rect, Global>

The specific areas of the atlas where each texture can be found

texture_handles: Option<HashMap<Handle<Image>, usize, RandomState, Global>>

Implementations

impl TextureAtlas

pub fn new_empty(texture: Handle<Image>, dimensions: Vec2) -> TextureAtlas

Create a new TextureAtlas that has a texture, but does not have any individual sprites specified

pub fn from_grid(
    texture: Handle<Image>,
    tile_size: Vec2,
    columns: usize,
    rows: usize
) -> TextureAtlas

Generate a TextureAtlas by splitting a texture into a grid where each cell of the grid of tile_size is one of the textures in the atlas

pub fn from_grid_with_padding(
    texture: Handle<Image>,
    tile_size: Vec2,
    columns: usize,
    rows: usize,
    padding: Vec2
) -> TextureAtlas

Generate a TextureAtlas by splitting a texture into a grid where each cell of the grid of tile_size is one of the textures in the atlas and is separated by some padding in the texture

pub fn add_texture(&mut self, rect: Rect) -> usize

Add a sprite to the list of textures in the TextureAtlas returns an index to the texture which can be used with TextureAtlasSprite

Arguments

• rect - The section of the atlas that contains the texture to be added, from the top-left corner of the texture to the bottom-right corner

pub fn len(&self) -> usize

How many textures are in the TextureAtlas

pub fn is_empty(&self) -> bool

pub fn get_texture_index(&self, texture: &Handle<Image>) -> Option<usize>

Trait Implementations

impl Clone for TextureAtlas

fn clone(&self) -> TextureAtlas

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextureAtlas

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl TypeUuid for TextureAtlas

const TYPE_UUID: Uuid = bevy_reflect::Uuid::from_bytes([114, 51, 197, 151, 204, 250, 65, 31, 189, 89, 154, 243, 73, 67, 42, 218])