Struct bevy::sprite::prelude::SpriteSheetBundle

pub struct SpriteSheetBundle {
    pub sprite: Sprite,
    pub transform: Transform,
    pub global_transform: GlobalTransform,
    pub texture: Handle<Image>,
    pub atlas: TextureAtlas,
    pub visibility: Visibility,
    pub inherited_visibility: InheritedVisibility,
    pub view_visibility: ViewVisibility,
}

👎Deprecated since 0.14.0: Use TextureAtlas alongside a SpriteBundle instead

A Bundle of components for drawing a single sprite from a sprite sheet (also referred to as a TextureAtlas) or for animated sprites.

Note: This bundle is identical to SpriteBundle with an additional TextureAtlas component.

Check the following examples for usage:

• animated sprite sheet example
• sprite animation event example
• texture atlas example

Fields

sprite: Sprite

👎Deprecated since 0.14.0: Use TextureAtlas alongside a SpriteBundle instead

Specifies the rendering properties of the sprite, such as color tint and flip.

transform: Transform

👎Deprecated since 0.14.0: Use TextureAtlas alongside a SpriteBundle instead

The local transform of the sprite, relative to its parent.

global_transform: GlobalTransform

👎Deprecated since 0.14.0: Use TextureAtlas alongside a SpriteBundle instead

The absolute transform of the sprite. This should generally not be written to directly.

texture: Handle<Image>

👎Deprecated since 0.14.0: Use TextureAtlas alongside a SpriteBundle instead

The sprite sheet base texture

atlas: TextureAtlas

👎Deprecated since 0.14.0: Use TextureAtlas alongside a SpriteBundle instead

The sprite sheet texture atlas, allowing to draw a custom section of texture.

visibility: Visibility

👎Deprecated since 0.14.0: Use TextureAtlas alongside a SpriteBundle instead

User indication of whether an entity is visible

inherited_visibility: InheritedVisibility

👎Deprecated since 0.14.0: Use TextureAtlas alongside a SpriteBundle instead

Inherited visibility of an entity.

view_visibility: ViewVisibility

👎Deprecated since 0.14.0: Use TextureAtlas alongside a SpriteBundle instead

Algorithmically-computed indication of whether an entity is visible and should be extracted for rendering

Trait Implementations

impl Bundle for SpriteSheetBundle

fn get_component_ids( components: &Components, ids: &mut impl FnMut(Option<ComponentId>) )

Gets this Bundle’s component ids. This will be None if the component has not been registered.

impl Clone for SpriteSheetBundle

fn clone(&self) -> SpriteSheetBundle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpriteSheetBundle

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

Formats the value using the given formatter.

impl Default for SpriteSheetBundle

fn default() -> SpriteSheetBundle

Returns the “default value” for a type.

impl DynamicBundle for SpriteSheetBundle