Adding `fps_ticker` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add fps_ticker

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

fps_ticker = "1.0.0"

The fps_ticker library will be automatically available globally. Read the fps_ticker library documentation.

Back to the crate overview.

Readme

fps_ticker

A simple crate for measuring the average, minimum and maximum frame rate over a window of time.

Usage

Specify a window length over which the average, minimum and maximum values will be measured.

use fps_ticker::Fps;

fn main() {
    let fps = Fps::with_window_len(100);
}

Or create an instance with the default window length of 60.

let fps = Fps::default();

Call tick once per frame at the point at which you wish to measure the rate. This samples the duration since the last tick, adds it to the window, removes the oldest duration from the window if necessary and re-calculates the average, minimum and maximum rate over the resulting window.

fps.tick();

Now we can retrieve the average, minimum and maximum rate over the window of time.

fps.avg();
fps.min();
fps.max();

Adding fps_ticker library as a dependency

Adding `fps_ticker` library as a dependency