[]Struct bevy::sprite::TextureAtlasBuilder

pub struct TextureAtlasBuilder { /* fields omitted */ }

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 add_texture(
    &mut self,
    texture_handle: Handle<Texture>,
    texture: &Texture
)

Adds a texture to be copied to the texture atlas.

pub fn finish(
    self,
    textures: &mut Assets<Texture>
) -> 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

impl Default for TextureAtlasBuilder

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Any for T where
    T: Any

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Component for T where
    T: 'static + Send + Sync

impl<T> Downcast for T where
    T: Any

impl<T> DowncastSync for T where
    T: Send + Sync + Any

impl<T> From<T> for T[src]

impl<T> FromResources for T where
    T: Default

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Resource for T where
    T: 'static + Send + Sync

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,