Struct bones_framework::render::sprite::AtlasSprite

#[repr(C)]
pub struct AtlasSprite {
    pub color: Color,
    pub index: u32,
    pub atlas: Handle<Atlas>,
    pub flip_x: bool,
    pub flip_y: bool,
}

An animated sprite component.

Represents one or more Atlass stacked on top of each other, and possibly animated through a range of frames out of the atlas.

Fields

color: Color

The sprite’s color tint

index: u32

This is the current index in the animation, with an idx of 0 meaning that the index in the sprite sheet will be start.

If the idx is greater than end - start, then the animation will loop around.

atlas: Handle<Atlas>

The atlas handle.

flip_x: bool

Whether or not the flip the sprite horizontally.

flip_y: bool

Whether or not the flip the sprite vertically.

Implementations

impl AtlasSprite

pub fn new(atlas: Handle<Atlas>) -> Self

Create a new AtlasSprite from the given atlas handle.

Trait Implementations

impl Clone for AtlasSprite

fn clone(&self) -> AtlasSprite

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AtlasSprite

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

Formats the value using the given formatter.

impl Default for AtlasSprite

fn default() -> AtlasSprite

Returns the “default value” for a type.

impl HasSchema for AtlasSprite

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