max/splines
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix some documentation.

Browse Source
This commit is contained in:
Dimitri Sabadie 2019-04-17 14:16:31 +02:00
parent b548566802
commit 48623701a7
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/lib.rs
View File

@ -154,19 +154,19 @@ impl<T, V> Key<T, V> {
#[cfg_attr(feature = "serialization", derive(Deserialize, Serialize))]
#[cfg_attr(feature = "serialization", serde(rename_all = "snake_case"))]
pub enum Interpolation<T> {
/// Hold a [`Key`] until the time passes the normalized step threshold, in which case the next
/// key is used.
/// Hold a [`Key`] until the interpolator value passes the normalized step threshold, in which
/// 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
/// 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
/// used.*
/// > 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
/// > first key will be kept until the next key. Set it to `0.` and the first key will never be
/// > used.
Step(T),
/// Linear interpolation between a key and the next one.
Linear,
/// Cosine interpolation between a key and the next one.
Cosine,
/// Catmull-Rom interpolation.
/// Catmull-Rom interpolation, performing a cubic Hermite interpolation using four keys.
CatmullRom
}