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

Enhance the documentation.

Browse Source
This commit is contained in:
Dimitri Sabadie 2018-08-05 01:17:17 +02:00
parent c4a6d702fa
commit 8afc967ae9
No known key found for this signature in database
GPG Key ID: DE58C386A8DB2883
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/lib.rs
View File

@ -36,7 +36,7 @@ use std::ops::{Add, Div, Mul, Sub};
/// determine how to interpolate values on the segment defined by this key and the next one. /// determine how to interpolate values on the segment defined by this key and the next one.
#[derive(Copy, Clone, Debug)] #[derive(Copy, Clone, Debug)]
pub struct Key<T> { pub struct Key<T> {
/// f32 at which the `Key` should be reached. /// f32 at which the [`Key`] should be reached.
pub t: f32, pub t: f32,
/// Actual value. /// Actual value.
pub value: T, pub value: T,
@ -58,12 +58,13 @@ impl<T> Key<T> {
/// Interpolation mode. /// Interpolation mode.
#[derive(Copy, Clone, Debug)] #[derive(Copy, Clone, Debug)]
pub enum Interpolation { pub enum Interpolation {
/// Hold a `Key` until the time passes the normalized step threshold, in which case the next /// Hold a [`Key`] until the time passes the normalized step threshold, in which case the next
/// key is used. /// 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 the time is half
/// 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.* /// first key will be kept until the next key. Set it to `0.` and the first key will never be
/// used.*
Step(f32), Step(f32),
/// Linear interpolation between a key and the next one. /// Linear interpolation between a key and the next one.
Linear, Linear,