Struct bevy_sprite::TextureAtlasBuilder

pub struct TextureAtlasBuilder<'a> { /* private fields */ }

A builder which is used to create a texture atlas from many individual sprites.

Implementations

impl<'a> TextureAtlasBuilder<'a>

pub fn initial_size(self, size: Vec2) -> Self

Sets the initial size of the atlas in pixels.

pub fn max_size(self, size: Vec2) -> Self

Sets the max size of the atlas in pixels.

pub fn format(self, format: TextureFormat) -> Self

Sets the texture format for textures in the atlas.

pub fn auto_format_conversion(self, auto_format_conversion: bool) -> Self

Control whether the added texture should be converted to the atlas format, if different.

pub fn add_texture( &mut self, image_id: Option<AssetId<Image>>, texture: &'a Image )

Adds a texture to be copied to the texture atlas.

Optionally an asset id can be passed that can later be used with the texture layout to retrieve the index of this texture. The insertion order will reflect the index of the added texture in the finished texture atlas.

pub fn padding(self, padding: UVec2) -> Self

Sets the amount of padding in pixels to add between the textures in the texture atlas.

The x value provide will be added to the right edge, while the y value will be added to the bottom edge.

pub fn finish( self ) -> Result<(TextureAtlasLayout, Image), TextureAtlasBuilderError>

Consumes the builder, and returns the newly created texture atlas and the associated atlas layout.

Assigns indices to the textures based on the insertion order. Internally it copies all rectangles from the textures and copies them into a new texture.

Usage

fn my_system(mut commands: Commands, mut textures: ResMut<Assets<Image>>, mut layouts: ResMut<Assets<TextureAtlasLayout>>) {
    // Declare your builder
    let mut builder = TextureAtlasBuilder::default();
    // Customize it
    // ...
    // Build your texture and the atlas layout
    let (atlas_layout, texture) = builder.finish().unwrap();
    let texture = textures.add(texture);
    let layout = layouts.add(atlas_layout);
    // Spawn your sprite
    commands.spawn(SpriteSheetBundle {
       texture,
       atlas: TextureAtlas {
            layout,
            index: 0
        },
      ..Default::default()
    });
}

Errors

If there is not enough space in the atlas texture, an error will be returned. It is then recommended to make a larger sprite sheet.

Trait Implementations

impl<'a> Debug for TextureAtlasBuilder<'a>

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

Formats the value using the given formatter.

impl Default for TextureAtlasBuilder<'_>

fn default() -> Self

Returns the “default value” for a type.