Struct bevy_sprite::TextureAtlasLayout

pub struct TextureAtlasLayout {
    pub size: Vec2,
    pub textures: Vec<Rect>,
    /* private fields */
}

Stores a map used to lookup the position of a texture in a TextureAtlas. This can be used to either use and look up a specific section of a texture, or animate frame-by-frame as a sprite sheet.

Optionally it can store a mapping from sub texture handles to the related area index (see TextureAtlasBuilder).

Example usage animating sprite. Example usage loading sprite sheet.

Fields

size: Vec2

textures: Vec<Rect>

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

Implementations

impl TextureAtlasLayout

pub fn new_empty(dimensions: Vec2) -> Self

Create a new empty layout with custom dimensions

pub fn from_grid( tile_size: Vec2, columns: usize, rows: usize, padding: Option<Vec2>, offset: Option<Vec2> ) -> Self

Generate a TextureAtlasLayout as a grid where each tile_size by tile_size grid-cell is one of the section in the atlas. Grid cells are separated by some padding, and the grid starts at offset pixels from the top left corner. Resulting layout is indexed left to right, top to bottom.

Arguments

• tile_size - Each layout grid cell size
• columns - Grid column count
• rows - Grid row count
• padding - Optional padding between cells
• offset - Optional global grid offset

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

Add a section to the list in the layout and returns its index which can be used with TextureAtlas

Arguments

• rect - The section of the texture to be added

pub fn len(&self) -> usize

The number of textures in the TextureAtlasLayout

pub fn is_empty(&self) -> bool

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

Retrieves the texture section index of the given texture handle.

This requires the layout to have been built using a TextureAtlasBuilder

Trait Implementations

impl Clone for TextureAtlasLayout

fn clone(&self) -> TextureAtlasLayout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextureAtlasLayout

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

Formats the value using the given formatter.

impl FromReflect for TextureAtlasLayout

where Self: Any + Send + Sync, Vec2: FromReflect + TypePath, Vec<Rect>: FromReflect + TypePath, Option<HashMap<AssetId<Image>, usize>>: FromReflect + TypePath,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for TextureAtlasLayout

where Self: Any + Send + Sync, Vec2: FromReflect + TypePath, Vec<Rect>: FromReflect + TypePath, Option<HashMap<AssetId<Image>, usize>>: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Reflect for TextureAtlasLayout

where Self: Any + Send + Sync, Vec2: FromReflect + TypePath, Vec<Rect>: FromReflect + TypePath, Option<HashMap<AssetId<Image>, usize>>: 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<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

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

Clones the value as a Reflect trait object.

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

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

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

Applies a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

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

Returns an immutable enumeration of “kinds” of type.

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

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

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

Returns a “partial equality” comparison result.

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

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 TextureAtlasLayout

where Self: Any + Send + Sync, Vec2: FromReflect + TypePath, Vec<Rect>: FromReflect + TypePath, Option<HashMap<AssetId<Image>, usize>>: FromReflect + TypePath,

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

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>

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>

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>

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 TextureAtlasLayout

where Self: Any + Send + Sync,

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 TextureAtlasLayout

where Self: Any + Send + Sync, Vec2: FromReflect + TypePath, Vec<Rect>: FromReflect + TypePath, Option<HashMap<AssetId<Image>, usize>>: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl VisitAssetDependencies for TextureAtlasLayout

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

impl Asset for TextureAtlasLayout