Struct bevy::sprite::TextureAtlasBuilder

pub struct TextureAtlasBuilder { /* private fields */ }

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

Implementations

impl TextureAtlasBuilder

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

Sets the initial size of the atlas in pixels.

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

Sets the max size of the atlas in pixels.

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

Sets the texture format for textures in the atlas.

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

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

pub fn add_texture(&mut self, texture_handle: Handle<Image>, texture: &Image)

Adds a texture to be copied to the texture atlas.

pub fn finish(
    self,
    textures: &mut Assets<Image>
) -> Result<TextureAtlas, TextureAtlasBuilderError>

Consumes the builder and returns a result with a new texture atlas.

Internally it copies all rectangles from the textures and copies them into a new texture which the texture atlas will use. It is not useful to hold a strong handle to the texture afterwards else it will exist twice in memory.

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 Debug for TextureAtlasBuilder

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

Formats the value using the given formatter.

impl Default for TextureAtlasBuilder

fn default() -> TextureAtlasBuilder

Returns the “default value” for a type.