bezier_easing 0.2.0

Rust port of gre/bezier-easing for cubic Bezier animation curves
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

# Bezier Easing for Rust

[![Crates.io](https://img.shields.io/crates/v/bezier_easing.svg)](https://crates.io/crates/bezier_easing)
[![Documentation](https://docs.rs/bezier_easing/badge.svg)](https://docs.rs/bezier_easing)

This is a Rust port of [gre/bezier-easing](https://github.com/gre/bezier-easing).

Bezier easing provides a way to create custom easing functions (ease-in, ease-out, ease-in-out...) for use in animations.

By providing the coordinates of the bezier curve's control points, you can create your own easing functions that follow the curve you've defined.

## Workspace

- `crates/bezier-easing`: the published Rust library.
- `examples/wasm-demo`: an HTML canvas demo powered by the Rust library compiled to WebAssembly.

## Installation

```toml
[dependencies]
bezier_easing = "0.2"
```

## Usage

```rust
use bezier_easing::bezier_easing;

let ease = bezier_easing(0.0_f64, 0.0, 1.0, 0.5).unwrap();
assert_eq!(ease(0.0), 0.0);
assert!((ease(0.5) - 0.3125).abs() < 0.000001);
assert_eq!(ease(1.0), 1.0);
```

The default floating point type is `f64`. Use suffixed arguments to create an `f32` easing function:

```rust
use bezier_easing::bezier_easing;

let ease = bezier_easing(0.0_f32, 0.0, 1.0, 0.5).unwrap();
assert!((ease(0.5) - 0.3125).abs() < 0.000001);
```

## WASM Example

Online demo: <https://hlhr202.github.io/bezier-easing-rs/>

```sh
wasm-pack build --target web --out-dir pkg examples/wasm-demo
npx serve examples/wasm-demo
```

Open the local URL printed by `serve` to view the canvas animation.

## Publishing

Run the release checks before publishing the library crate:

```sh
cargo fmt --check
cargo clippy -p bezier_easing --all-targets --all-features -- -D warnings
cargo test -p bezier_easing --all-features
cargo package -p bezier_easing
cargo publish -p bezier_easing --dry-run
```

Publish only after the dry run succeeds:

```sh
cargo publish -p bezier_easing
```

## License
MIT

## Acknowledgements

- [gre/bezier-easing](https://github.com/gre/bezier-easing)
- [implementations](https://greweb.me/2012/02/bezier-curve-based-easing-functions-from-concept-to-implementation)