SpriteSheetBundle

Struct SpriteSheetBundle 

Source
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
Expand description

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:

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ยง

Sourceยง

impl Bundle for SpriteSheetBundle

Sourceยง

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.
Sourceยง

impl Clone for SpriteSheetBundle

Sourceยง

fn clone(&self) -> SpriteSheetBundle

Returns a duplicate of the value. Read more
1.0.0 ยท Sourceยง

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

Performs copy-assignment from source. Read more
Sourceยง

impl Debug for SpriteSheetBundle

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl Default for SpriteSheetBundle

Sourceยง

fn default() -> SpriteSheetBundle

Returns the โ€œdefault valueโ€ for a type. Read more
Sourceยง

impl DynamicBundle for SpriteSheetBundle

Auto Trait Implementationsยง

Blanket Implementationsยง

Sourceยง

impl<T> Any for T
where T: 'static + ?Sized,

Sourceยง

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Sourceยง

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

Sourceยง

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
Sourceยง

impl<T> Borrow<T> for T
where T: ?Sized,

Sourceยง

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Sourceยง

impl<T> BorrowMut<T> for T
where T: ?Sized,

Sourceยง

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Sourceยง

impl<T> CloneToUninit for T
where T: Clone,

Sourceยง

unsafe fn clone_to_uninit(&self, dest: *mut u8)

๐Ÿ”ฌThis is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Sourceยง

impl<T> Downcast<T> for T

Sourceยง

impl<T> Downcast for T
where T: Any,

Sourceยง

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Sourceยง

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Sourceยง

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Anyโ€™s vtable from &Traitโ€™s.
Sourceยง

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

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Anyโ€™s vtable from &mut Traitโ€™s.
Sourceยง

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Sourceยง

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Sourceยง

impl<T> From<T> for T

Sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

Sourceยง

impl<S> FromSample<S> for S

Sourceยง

impl<T> FromWorld for T
where T: Default,

Sourceยง

fn from_world(_world: &mut World) -> T

Creates Self using data from the given World.
Sourceยง

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Sourceยง

const WITNESS: W = W::MAKE

A constant of the type witness
Sourceยง

impl<T> Identity for T
where T: ?Sized,

Sourceยง

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Sourceยง

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Sourceยง

impl<T> Instrument for T

Sourceยง

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Sourceยง

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Sourceยง

impl<T, U> Into<U> for T
where U: From<T>,

Sourceยง

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Sourceยง

impl<T> ToOwned for T
where T: Clone,

Sourceยง

type Owned = T

The resulting type after obtaining ownership.
Sourceยง

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Sourceยง

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Sourceยง

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Sourceยง

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Sourceยง

type Error = Infallible

The type returned in the event of a conversion error.
Sourceยง

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Sourceยง

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Sourceยง

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Sourceยง

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Sourceยง

impl<T> TypeData for T
where T: 'static + Send + Sync + Clone,

Sourceยง

impl<T> Upcast<T> for T

Sourceยง

impl<T> WithSubscriber for T

Sourceยง

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Sourceยง

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Sourceยง

impl<T> ConditionalSend for T
where T: Send,

Sourceยง

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Sourceยง

impl<T> Settings for T
where T: 'static + Send + Sync,

Sourceยง

impl<T> WasmNotSend for T
where T: Send,

Sourceยง

impl<T> WasmNotSendSync for T

Sourceยง

impl<T> WasmNotSync for T
where T: Sync,