Struct bevy::sprite::TextureAtlas

pub struct TextureAtlas {
    pub texture: Handle<Image>,
    pub size: Vec2,
    pub textures: Vec<Rect, Global>,
    /* private fields */
}

An atlas containing multiple textures (like a spritesheet or a tilemap). Example usage animating sprite. Example usage loading sprite sheet.

Fields

texture: Handle<Image>

The handle to the texture in which the sprites are stored

size: Vec2

textures: Vec<Rect, Global>

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

Implementations

impl TextureAtlas

pub fn new_empty(texture: Handle<Image>, dimensions: Vec2) -> TextureAtlas

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

pub fn from_grid( texture: Handle<Image>, tile_size: Vec2, columns: usize, rows: usize, padding: Option<Vec2>, offset: Option<Vec2> ) -> TextureAtlas

Generate a TextureAtlas by splitting a texture into a grid where each tile_size by tile_size grid-cell is one of the textures in the atlas. Grid cells are separated by some padding, and the grid starts at offset pixels from the top left corner. The resulting TextureAtlas is indexed left to right, top to bottom.

pub fn add_texture(&mut self, rect: Rect) -> usize

Add a sprite to the list of textures in the TextureAtlas returns an index to the texture which can be used with TextureAtlasSprite

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

The number of textures in the TextureAtlas

pub fn is_empty(&self) -> bool

Returns true if there are no textures in the TextureAtlas

pub fn get_texture_index( &self, texture: impl Into<AssetId<Image>> ) -> Option<usize>

Returns the index of the texture corresponding to the given image handle in the TextureAtlas

Trait Implementations

impl Clone for TextureAtlas

fn clone(&self) -> TextureAtlas

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TextureAtlas

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

Formats the value using the given formatter.

impl FromReflect for TextureAtlaswhere Handle<Image>: FromReflect + TypePath, Vec2: FromReflect + TypePath, Vec<Rect, Global>: FromReflect + TypePath, Option<HashMap<AssetId<Image>, usize, BuildHasherDefault<AHasher>, Global>>: FromReflect + TypePath,

fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<TextureAtlas>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect, Global> ) -> Result<Self, Box<dyn Reflect, Global>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for TextureAtlaswhere Handle<Image>: FromReflect + TypePath, Vec2: FromReflect + TypePath, Vec<Rect, Global>: FromReflect + TypePath, Option<HashMap<AssetId<Image>, usize, BuildHasherDefault<AHasher>, Global>>: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Reflect for TextureAtlaswhere Handle<Image>: FromReflect + TypePath, Vec2: FromReflect + TypePath, Vec<Rect, Global>: FromReflect + TypePath, Option<HashMap<AssetId<Image>, usize, BuildHasherDefault<AHasher>, Global>>: FromReflect + TypePath,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<TextureAtlas, Global>) -> Box<dyn Any, Global>

Returns the value as a Box<dyn Any>.

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

Returns the value as a &dyn Any.

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

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<TextureAtlas, Global>) -> Box<dyn Reflect, Global>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect, Global>

Clones the value as a Reflect trait object.

fn set( &mut self, value: Box<dyn Reflect, Global> ) -> Result<(), Box<dyn Reflect, Global>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<TextureAtlas, Global>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for TextureAtlaswhere Handle<Image>: FromReflect + TypePath, Vec2: FromReflect + TypePath, Vec<Rect, Global>: FromReflect + TypePath, Option<HashMap<AssetId<Image>, usize, BuildHasherDefault<AHasher>, Global>>: FromReflect + TypePath,

fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

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

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for TextureAtlaswhere Handle<Image>: FromReflect + TypePath, Vec2: FromReflect + TypePath, Vec<Rect, Global>: FromReflect + TypePath, Option<HashMap<AssetId<Image>, usize, BuildHasherDefault<AHasher>, Global>>: FromReflect + TypePath,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for TextureAtlaswhere Handle<Image>: FromReflect + TypePath, Vec2: FromReflect + TypePath, Vec<Rect, Global>: FromReflect + TypePath, Option<HashMap<AssetId<Image>, usize, BuildHasherDefault<AHasher>, Global>>: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl VisitAssetDependencies for TextureAtlas

fn visit_dependencies(&self, visit: &mut impl FnMut(UntypedAssetId))

impl Asset for TextureAtlas