Struct frame_counter::Frame

pub struct Frame<'a> { /* fields omitted */ }

Implementations

impl<'a> Frame<'a>

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 {
        {
            let frame = frame_counter.start_frame();

            dummy_workload();

            frame.wait_until_framerate(60f64);
        }

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

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 {
        {
            let frame = frame_counter.start_frame();

            dummy_workload();

            frame.sleep_until_framerate(60f64);
        }

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

Trait Implementations

impl<'a> Drop for Frame<'a>

fn drop(&mut self)

Executes the destructor for this type.