Skip to main content

Keyframe

Struct Keyframe 

Source
pub struct Keyframe<T: Lerp> {
    pub timestamp: Duration,
    pub value: T,
    pub easing: Easing,
}
Expand description

A single keyframe in an animation track.

The easing field controls the interpolation from this keyframe to the next one. The last keyframe’s easing is never used (there is no subsequent keyframe to interpolate toward).

§Ordering

Keyframes are ordered and compared by timestamp only. Two keyframes at the same timestamp are considered equal regardless of their values or easing — this keeps binary-search by timestamp correct inside AnimationTrack (added in issue #350).

Fields§

§timestamp: Duration

Position of this keyframe on the timeline.

§value: T

Value held at (and interpolated from) this keyframe.

§easing: Easing

Easing applied for the transition from this keyframe to the next.

Implementations§

Source§

impl<T: Lerp> Keyframe<T>

Source

pub fn new(timestamp: Duration, value: T, easing: Easing) -> Self

Creates a new keyframe.

Trait Implementations§

Source§

impl<T: Clone + Lerp> Clone for Keyframe<T>

Source§

fn clone(&self) -> Keyframe<T>

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<T: Debug + Lerp> Debug for Keyframe<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Lerp> Ord for Keyframe<T>

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<T: Lerp> PartialEq for Keyframe<T>

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: Lerp> PartialOrd for Keyframe<T>

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<T: Lerp> Eq for Keyframe<T>

Auto Trait Implementations§

§

impl<T> Freeze for Keyframe<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Keyframe<T>
where T: RefUnwindSafe,

§

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

§

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

§

impl<T> Unpin for Keyframe<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Keyframe<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Keyframe<T>
where T: UnwindSafe,

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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.