frame-tick 0.1.3

Tick-based, quasi-fixed-point time measurement for working with frames/animation/video
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

# `frame-tick`

[![Documentation](https://docs.rs/frame-tick/badge.svg)](https://docs.rs/frame-tick)
[![Crate](https://img.shields.io/crates/v/frame-tick.svg)](https://crates.io/crates/frame-tick)

<!-- cargo-rdme start -->

Fixed-point representation of time where each second is divided into
3,603,600 `Tick`s (or 25,200, if the `cargo` feature `low_res` is set).

This crate was inspired by [this article](https://iquilezles.org/articles/ticks/)
from [Inigo Quilez](https://iquilezles.org/). Please refer to this for a
more detailed explanation.
> *Note that the default for `TICKS_PER_SECOND`, 3,603,600, is the Least
> Common Multiple of all numbers in the list given in the article as well as
> 11 and 13, which are needed for NTSC.*

This makes it 'compatible' with lots of frame- and refresh rates without
ever mapping outside of or repeating a frame. That is: without strobing.

In particular, a `Tick` can represent exactly:

- 24hz and 48hz, great for movie playback.

- 6hz, 8hz and 12hz, great for animating on 4s, 3s and 2s.

- 29.97hz, 59.94hz NTSC found in Japan, South Korea and the USA.

- 30hz, 60hz, for internet video and TV in the USA.

- 25hz and 50hz, for TV in the EU.

- 72hz, for Oculus Quest 1.

- 90hz for Quest 2, Rift and other headsets.

- 120hz, 144hz and 240hz, for newer VR headesets and high frequency
  monitors.

- And many more.

## Examples

```rust
use frame_tick::{FrameRateConversion, FramesPerSec, Tick};

let tick = Tick::from_secs(1.0);

/// A round trip is lossless.
assert_eq!(1.0, tick.to_secs());
/// One second at 120hz == frame № 120.
assert_eq!(120, tick.to_frame(FramesPerSec::new(120).unwrap()));
```

## Cargo features

- **`facet`** — Add support for reflection via [`facet`](https://docs.rs/facet/).
- **`float_frame_rate`** — Add support for non-integer frame rates. This pulls in the [`typed_floats`](https://docs.rs/typed_floats/) crate.
- **`low_res`** — [`TICKS_PER_SECOND`] will be `25_600`. Which is just fine if you do not need to work with NTSC frame rates.
- **`serde`** — Add support for serialization via `serde`.
- **`std`** — Use `std`; this implements `Display` as well as `From<Tick>`/`Into<Tick>` for [`std::time::Duration`].

<!-- cargo-rdme end -->

## License

Apache-2.0 _or_ BSD-3-Clause _or_ MIT _or_ Zlib at your discretion.