Struct FrameCounter

Source

pub struct FrameCounter { /* private fields */ }

Implementations§

Source §

impl FrameCounter

Source

pub fn new(frame_rate: f64) -> Self

Creates a new FrameCounter with the given starting framerate.

§Arguments

frame_rate - initial frame rate guess.

Source

pub fn tick(&mut self)

Updates the frame measurements

Examples found in repository ?

examples/counter.rs (line 11)

7pub fn main() {
8    let mut frame_counter = FrameCounter::default();
9
10    loop {
11        frame_counter.tick();
12
13        dummy_workload();
14
15        println!("fps stats - {}", frame_counter);
16    }
17}

More examples

Hide additional examples

examples/limiter.rs (line 11)

7pub fn main() {
8    let mut frame_counter = FrameCounter::default();
9
10    loop {
11        frame_counter.tick();
12
13        dummy_workload();
14
15        // hot loop, do not trigger scheduler
16        frame_counter.sleep_until_framerate(60f64);
17
18        println!("fps stats - {}", frame_counter);
19    }
20}

Source

pub fn wait_until_framerate(&self, framerate: f64)

Waits in a hot-loop until the desired frame rate is achieved. This function will not call std::thread:sleep to prevent the OS from scheduling this thread.

This means the function will consume an entire core on the CPU.

§Example:

use frame_counter::FrameCounter;

pub fn dummy_workload() {
    std::thread::sleep(std::time::Duration::from_millis(1));
}

pub fn main() {
    let mut frame_counter = FrameCounter::default();

    loop {
        frame_counter.tick();

        dummy_workload();

        frame_counter.wait_until_framerate(60f64);

        println!("fps stats - {}", frame_counter);
    }
}

Source

pub fn sleep_until_framerate(&self, framerate: f64)

Waits in a cold-loop until the desired frame rate is achieved. This function will call std::thread:sleep to prevent the process from consuming the entire CPU Core.

§Example:

use frame_counter::FrameCounter;

pub fn dummy_workload() {
    std::thread::sleep(std::time::Duration::from_millis(1));
}

pub fn main() {
    let mut frame_counter = FrameCounter::default();

    loop {
        frame_counter.tick();

        dummy_workload();

        frame_counter.sleep_until_framerate(60f64);

        println!("fps stats - {}", frame_counter);
    }
}

Examples found in repository ?

examples/limiter.rs (line 16)

7pub fn main() {
8    let mut frame_counter = FrameCounter::default();
9
10    loop {
11        frame_counter.tick();
12
13        dummy_workload();
14
15        // hot loop, do not trigger scheduler
16        frame_counter.sleep_until_framerate(60f64);
17
18        println!("fps stats - {}", frame_counter);
19    }
20}