Struct bevy_sprite::TextureAtlas

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

An atlas containing multiple textures (like a spritesheet or a tilemap)

Fields

texture: Handle<Texture>

The handle to the texture in which the sprites are stored

size: Vec2

textures: Vec<Rect>

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

texture_handles: Option<HashMap<Handle<Texture>, usize>>

Implementations

impl TextureAtlas

pub fn new_empty(texture: Handle<Texture>, dimensions: Vec2) -> Self

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

pub fn from_grid(
    texture: Handle<Texture>,
    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<Texture>,
    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)

Add a sprite to the list of textures in the TextureAtlas

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<Texture>) -> Option<usize>

Trait Implementations

impl Debug for TextureAtlas

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

Formats the value using the given formatter.

impl RenderResources for TextureAtlas

fn render_resources_len(&self) -> usize

fn get_render_resource(&self, index: usize) -> Option<&dyn RenderResource>

fn get_render_resource_name(&self, index: usize) -> Option<&str>

fn get_render_resource_hints(&self, index: usize) -> Option<RenderResourceHints>

fn iter(&self) -> RenderResourceIterator<'_>

impl TypeUuid for TextureAtlas

const TYPE_UUID: Uuid