spin_sleep
Accurate sleeping. Only use native sleep as far as it can be trusted, then spin.
The problem with thread::sleep is it isn't always very accurate, and this accuracy varies
on platform and state. Spinning is as accurate as we can get, but consumes the CPU
rather ungracefully.
This library adds a middle ground, using a configurable native accuracy setting allowing thread::sleep to wait the bulk of a sleep time, and spin the final section to guarantee accuracy.
Simplest usage with default native accuracy is a drop in replacement for thread::sleep.
rust
spin_sleep::sleep(Duration::new(1, 12_550_000));
More advanced usage, including setting a custom native accuracy, can be achieved by
constructing a SpinSleeper.
```rust
// Create a new sleeper that trusts native thread::sleep with 100μs accuracy
let spinsleeper = spinsleep::SpinSleeper::new(100_000);
// Sleep for 1.01255 seconds, this will: // - thread:sleep for 1.01245 seconds, ie 100μs less than the requested duration // - spin until total 1.01255 seconds have elapsed spinsleeper.sleep(Duration::new(1, 12550_000)); ```
Sleep can also requested in f64 seconds or u64 nanoseconds
(useful when used with time crate)
rust
spin_sleeper.sleep_s(1.01255);
spin_sleeper.sleep_ns(1_012_550_000);
OS-specific default accuracy settings should be good enough for most cases.
rust
let sleeper = SpinSleeper::default();
For controlling & report rates (e.g. game FPS) this crate provides LoopHelper. A SpinSleeper is used to maximise
sleeping accuracy.
```rust use spin_sleep::LoopHelper;
let mut loophelper = LoopHelper::builder() .reportintervals(0.5) // report every half a second .buildwithtargetrate(250.0); // limit to 250 FPS if possible
let mut current_fps = None;
loop { let delta = loophelper.loopstart(); // or .loopstarts() for f64 seconds
// compute_something(delta);
if let Some(fps) = loop_helper.report_rate() {
current_fps = Some(fps);
}
// render_fps(current_fps);
loop_helper.loop_sleep(); // sleeps to acheive a 250 FPS rate
} ```
Windows has particularly poor accuracy by default (~15ms), spin_sleep will automatically
select the best accuracy on windows generally achieving ~1ms native sleep accuracy (Since 0.3.3).
This crate is maintained with latest stable rust.