game-loop 0.2.0

A Rust crate that implements a frame-rate-independent game loop.
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

## Game Loop

A Rust crate that implements a frame-rate-independent game loop. The code is
based on ["Fix Your Timestep!"](https://gafferongames.com/post/fix_your_timestep/)
and is extremely lightweight with no dependencies.

## Usage

```rust
use game_loop::game_loop;

fn main() {
  let game = YourGame::new();

  game_loop(game, 240, |g| {
    g.game.your_update_function();
  }, |g| {
    g.game.your_render_function();
  });
}
```

The value `240` is the number of updates per second. It is _not_ the frame rate.
Instead, the render function is called as quickly as possible, though you can
slow it down if you wish. This may be useful if vsync is enabled or to save
power on mobile devices. One way to slow it down is with
[`std::thread::sleep`](https://doc.rust-lang.org/std/thread/fn.sleep.html).

The `g` closure argument lets you access your `game` state which can be anything
you like. You can also access the game loop's running time, how many updates
there have been, etc. It also provides a `blending_factor` that you may use in
your render function to interpolate frames and produce smoother animations. See
the article above for more explanation.

## Example

There's a [Game of Life example](./examples/game_of_life.rs) that shows how to
use the crate. You can run it with:

```sh
cargo run --example game_of_life
```

![Game of Life](./examples/game_of_life.gif)

## License

MIT