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

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

Implementations§

source§

impl<'a> TextureAtlasBuilder<'a>

source

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

Sets the initial size of the atlas in pixels.

source

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

Sets the max size of the atlas in pixels.

source

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

Sets the texture format for textures in the atlas.

source

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

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

source

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.

source

pub fn padding(self, padding: UVec2) -> TextureAtlasBuilder<'a>

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.

source

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§

source§

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

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for TextureAtlasBuilder<'_>

source§

fn default() -> TextureAtlasBuilder<'_>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

impl<T> Downcast for T
where T: Any,

source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

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

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<S> FromSample<S> for S

source§

fn from_sample_(s: S) -> S

source§

impl<T> FromWorld for T
where T: Default,

source§

fn from_world(_world: &mut World) -> T

Creates Self using data from the given World.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

source§

fn to_sample_(self) -> U

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> Upcast<T> for T

source§

fn upcast(&self) -> Option<&T>

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

source§

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

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSendSync for T

source§

impl<T> WasmNotSync for T
where T: Sync,