Struct bones_framework::render::sprite::Atlas

#[repr(C)]
pub struct Atlas {
    pub image: Handle<Image>,
    pub tile_size: Vec2,
    pub rows: u32,
    pub columns: u32,
    pub padding: Vec2,
    pub offset: Vec2,
    pub tile_collision: SMap<String, AtlasCollisionTile>,
}

Atlas image component.

Fields

image: Handle<Image>

The image for the atlas.

tile_size: Vec2

The size of each tile in the atlas.

rows: u32

The number of rows in the atlas.

columns: u32

The number of columns in the atlas.

padding: Vec2

The amount of padding between tiles.

offset: Vec2

The offset of the first tile from the top-left of the image.

tile_collision: SMap<String, AtlasCollisionTile>

Map tile indices to extra collision metadata. This is optional and may not be specified for all tiles, or at all.

Implementations

impl Atlas

pub fn tile_pos(&self, idx: u32) -> Vec2

Get the position in pixels of the top-left corner of the atlas tile with the given index.

pub fn size(&self) -> Vec2

Get the size in pixels of the entire atlas image.

Trait Implementations

impl Clone for Atlas

fn clone(&self) -> Atlas

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Atlas

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

Formats the value using the given formatter.

impl Default for Atlas

fn default() -> Atlas

Returns the “default value” for a type.

impl HasSchema for Atlas

fn schema() -> &'static Schema

Get this type’s [Schema].

fn register_schema()

Register this schema with the global schema registry.

fn cast<T>(this: &Self) -> &T

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn try_cast<T>(this: &Self) -> Result<&T, SchemaMismatchError>

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn cast_mut<T>(this: &mut Self) -> &mut T

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn try_cast_mut<T>(this: &mut Self) -> Result<&mut T, SchemaMismatchError>

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn as_schema_ref(&self) -> SchemaRef<'_>

where Self: Sized,

Converts a reference of T to a SchemaRef

fn as_schema_mut(&mut self) -> SchemaRefMut<'_>

where Self: Sized,

Converts a reference of T to a SchemaRefMut