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

Synchronize README.

Browse Source
This commit is contained in:
Dimitri Sabadie 2020-04-29 03:27:10 +02:00
parent 4a2f349954
commit 0afebc3319
No known key found for this signature in database
GPG Key ID: B313786A66884DCD
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -24,7 +24,7 @@ is picked from its lower control point.
# Quickly create splines # Quickly create splines
``` ```rust
use splines::{Interpolation, Key, Spline}; use splines::{Interpolation, Key, Spline};
let start = Key::new(0., 0., Interpolation::Linear); let start = Key::new(0., 0., Interpolation::Linear);
@ -46,7 +46,7 @@ value.
If you try to sample in out-of-bounds sampling parameter, you’ll get no value. If you try to sample in out-of-bounds sampling parameter, you’ll get no value.
``` ```rust
assert_eq!(spline.sample(0.), Some(0.)); assert_eq!(spline.sample(0.), Some(0.));
assert_eq!(spline.clamped_sample(1.), Some(10.)); assert_eq!(spline.clamped_sample(1.), Some(10.));
assert_eq!(spline.sample(1.1), None); assert_eq!(spline.sample(1.1), None);
@ -56,7 +56,7 @@ It’s possible that you want to get a value even if you’re out-of-bounds. Thi
important for simulations / animations. Feel free to use the `Spline::clamped_interpolation` for important for simulations / animations. Feel free to use the `Spline::clamped_interpolation` for
that purpose. that purpose.
``` ```rust
assert_eq!(spline.clamped_sample(-0.9), Some(0.)); // clamped to the first key assert_eq!(spline.clamped_sample(-0.9), Some(0.)); // clamped to the first key
assert_eq!(spline.clamped_sample(1.1), Some(10.)); // clamped to the last key assert_eq!(spline.clamped_sample(1.1), Some(10.)); // clamped to the last key
``` ```