Struct benimator::SpriteSheetAnimation
source · [−]pub struct SpriteSheetAnimation { /* private fields */ }
Expand description
Asset that define an animation of TextureAtlasSprite
See crate level documentation for usage
Implementations
sourceimpl SpriteSheetAnimation
impl SpriteSheetAnimation
sourcepub fn from_frames(frames: Vec<Frame>) -> Self
pub fn from_frames(frames: Vec<Frame>) -> Self
Create a new animation from frames
sourcepub fn from_range(
index_range: RangeInclusive<usize>,
frame_duration: Duration
) -> Self
pub fn from_range(
index_range: RangeInclusive<usize>,
frame_duration: Duration
) -> Self
Create a new animation from index-range, using the same frame duration for each frame.
For more granular configuration, see from_frames
Panics
Panics if the duration is zero
sourcepub fn from_iter(
indices: impl IntoIterator<Item = usize>,
frame_duration: Duration
) -> Self
pub fn from_iter(
indices: impl IntoIterator<Item = usize>,
frame_duration: Duration
) -> Self
Create a new animation from an index iterator, using the same frame duration for each frame.
Example
You may use this to create a reversed animation:
let animation = SpriteSheetAnimation::from_iter((0..5).rev(), Duration::from_millis(100));
For more granular configuration, see from_frames
Panics
Panics if the duration is zero
sourcepub fn repeat_from(self, frame_index: usize) -> Self
pub fn repeat_from(self, frame_index: usize) -> Self
Repeat the animation forever, from a given frame index (loop back to it at the end of the animation)
Trait Implementations
sourceimpl Clone for SpriteSheetAnimation
impl Clone for SpriteSheetAnimation
sourcefn clone(&self) -> SpriteSheetAnimation
fn clone(&self) -> SpriteSheetAnimation
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for SpriteSheetAnimation
impl Debug for SpriteSheetAnimation
sourceimpl Default for SpriteSheetAnimation
impl Default for SpriteSheetAnimation
sourcefn default() -> SpriteSheetAnimation
fn default() -> SpriteSheetAnimation
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for SpriteSheetAnimation
impl<'de> Deserialize<'de> for SpriteSheetAnimation
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl FromIterator<Frame> for SpriteSheetAnimation
impl FromIterator<Frame> for SpriteSheetAnimation
sourcefn from_iter<T: IntoIterator<Item = Frame>>(iter: T) -> Self
fn from_iter<T: IntoIterator<Item = Frame>>(iter: T) -> Self
Creates a value from an iterator. Read more
Auto Trait Implementations
impl RefUnwindSafe for SpriteSheetAnimation
impl Send for SpriteSheetAnimation
impl Sync for SpriteSheetAnimation
impl Unpin for SpriteSheetAnimation
impl UnwindSafe for SpriteSheetAnimation
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
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
. Read more
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
fn as_any(&self) -> &(dyn Any + 'static)
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. Read more
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
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. Read more
sourceimpl<T> FromWorld for T where
T: Default,
impl<T> FromWorld for T where
T: Default,
sourcefn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates Self
using data from the given World
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>
sourceimpl<T> TypeUuidDynamic for T where
T: TypeUuid,
impl<T> TypeUuidDynamic for T where
T: TypeUuid,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more