Fix some documentation.
This commit is contained in:
parent
b548566802
commit
48623701a7
14
src/lib.rs
14
src/lib.rs
@ -154,19 +154,19 @@ impl<T, V> Key<T, V> {
|
|||||||
#[cfg_attr(feature = "serialization", derive(Deserialize, Serialize))]
|
#[cfg_attr(feature = "serialization", derive(Deserialize, Serialize))]
|
||||||
#[cfg_attr(feature = "serialization", serde(rename_all = "snake_case"))]
|
#[cfg_attr(feature = "serialization", serde(rename_all = "snake_case"))]
|
||||||
pub enum Interpolation<T> {
|
pub enum Interpolation<T> {
|
||||||
/// Hold a [`Key`] until the time passes the normalized step threshold, in which case the next
|
/// Hold a [`Key`] until the interpolator value passes the normalized step threshold, in which
|
||||||
/// key is used.
|
/// case the next key is used.
|
||||||
///
|
///
|
||||||
/// *Note: if you set the threshold to `0.5`, the first key will be used until the time is half
|
/// > Note: if you set the threshold to `0.5`, the first key will be used until half the time
|
||||||
/// between the two keys; the second key will be in used afterwards. If you set it to `1.0`, the
|
/// > between the two keys; the second key will be in used afterwards. If you set it to `1.0`, the
|
||||||
/// first key will be kept until the next key. Set it to `0.` and the first key will never be
|
/// > first key will be kept until the next key. Set it to `0.` and the first key will never be
|
||||||
/// used.*
|
/// > used.
|
||||||
Step(T),
|
Step(T),
|
||||||
/// Linear interpolation between a key and the next one.
|
/// Linear interpolation between a key and the next one.
|
||||||
Linear,
|
Linear,
|
||||||
/// Cosine interpolation between a key and the next one.
|
/// Cosine interpolation between a key and the next one.
|
||||||
Cosine,
|
Cosine,
|
||||||
/// Catmull-Rom interpolation.
|
/// Catmull-Rom interpolation, performing a cubic Hermite interpolation using four keys.
|
||||||
CatmullRom
|
CatmullRom
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user