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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
#![deny(missing_docs)]
#[cfg(not(target_arch = "wasm32"))]
use bevy::winit::WinitWindows;
use bevy::{prelude::*, render::pipelined_rendering::RenderExtractApp, utils::Instant};
use std::{
sync::{Arc, Mutex},
time::Duration,
};
#[cfg(feature = "framepace_debug")]
pub mod debug;
#[derive(Debug, Clone, Component)]
pub struct FramepacePlugin;
impl Plugin for FramepacePlugin {
fn build(&self, app: &mut App) {
app.register_type::<FramepaceSettings>();
let limit = FrametimeLimit::default();
let settings = FramepaceSettings::default();
let settings_proxy = FramepaceSettingsProxy::default();
let stats = FramePaceStats::default();
app.insert_resource(settings)
.insert_resource(settings_proxy.clone())
.insert_resource(limit.clone())
.insert_resource(stats.clone())
.add_system(update_proxy_resources);
#[cfg(not(target_arch = "wasm32"))]
app.add_system(get_display_refresh_rate);
app.sub_app_mut(RenderExtractApp)
.insert_resource(FrameTimer::default())
.insert_resource(settings_proxy)
.insert_resource(limit)
.insert_resource(stats)
.add_system(
framerate_limiter
.run_if(|settings: Res<FramepaceSettingsProxy>| settings.is_enabled()),
);
}
}
#[derive(Debug, Clone, Resource, Reflect, FromReflect)]
#[reflect(Resource)]
pub struct FramepaceSettings {
pub limiter: Limiter,
}
impl FramepaceSettings {
pub fn with_limiter(mut self, limiter: Limiter) -> Self {
self.limiter = limiter;
self
}
}
impl Default for FramepaceSettings {
fn default() -> FramepaceSettings {
FramepaceSettings {
limiter: Limiter::Auto,
}
}
}
#[derive(Default, Debug, Clone, Resource)]
struct FramepaceSettingsProxy {
limiter: Arc<Mutex<Limiter>>,
}
impl FramepaceSettingsProxy {
fn is_enabled(&self) -> bool {
self.limiter.try_lock().iter().any(|l| l.is_enabled())
}
}
fn update_proxy_resources(settings: Res<FramepaceSettings>, proxy: Res<FramepaceSettingsProxy>) {
if settings.is_changed() {
if let Ok(mut limiter) = proxy.limiter.try_lock() {
*limiter = settings.limiter.clone();
}
}
}
#[derive(Debug, Default, Clone, Reflect, FromReflect)]
pub enum Limiter {
#[default]
Auto,
Manual(Duration),
Off,
}
impl Limiter {
pub fn is_enabled(&self) -> bool {
!matches!(self, Limiter::Off)
}
pub fn from_framerate(framerate: f64) -> Self {
Limiter::Manual(Duration::from_secs_f64(1.0 / framerate))
}
}
impl std::fmt::Display for Limiter {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let output = match self {
Limiter::Auto => "Auto".into(),
Limiter::Manual(t) => format!("{:.2} fps", 1.0 / t.as_secs_f32()),
Limiter::Off => "Off".into(),
};
write!(f, "{}", output)
}
}
#[derive(Debug, Default, Clone, Resource)]
struct FrametimeLimit(Arc<Mutex<Duration>>);
#[derive(Debug, Resource, Reflect)]
pub struct FrameTimer {
sleep_end: Instant,
}
impl Default for FrameTimer {
fn default() -> Self {
FrameTimer {
sleep_end: Instant::now(),
}
}
}
#[cfg(not(target_arch = "wasm32"))]
fn get_display_refresh_rate(
settings: Res<FramepaceSettings>,
winit: NonSend<WinitWindows>,
windows: Query<Entity, With<Window>>,
frame_limit: Res<FrametimeLimit>,
) {
if !(settings.is_changed() || winit.is_changed()) {
return;
}
let new_frametime = match settings.limiter {
Limiter::Auto => match detect_frametime(winit, windows.iter()) {
Some(frametime) => frametime,
None => return,
},
Limiter::Manual(frametime) => frametime,
Limiter::Off => {
info!("Frame limiter disabled");
return;
}
};
if let Ok(mut limit) = frame_limit.0.try_lock() {
if new_frametime != *limit {
info!("Frametime limit changed to: {:?}", new_frametime);
*limit = new_frametime;
}
}
}
#[cfg(not(target_arch = "wasm32"))]
fn detect_frametime(
winit: NonSend<WinitWindows>,
windows: impl Iterator<Item = Entity>,
) -> Option<Duration> {
let best_framerate = {
windows
.filter_map(|e| winit.get_window(e))
.filter_map(|w| w.current_monitor())
.map(|monitor| bevy::winit::get_best_videomode(&monitor).refresh_rate_millihertz())
.min()? as f64
/ 1000.0
- 0.5 };
let best_frametime = Duration::from_secs_f64(1.0 / best_framerate);
Some(best_frametime)
}
#[derive(Clone, Debug, Default, Resource)]
pub struct FramePaceStats {
frametime: Arc<Mutex<Duration>>,
oversleep: Arc<Mutex<Duration>>,
}
fn framerate_limiter(
mut timer: ResMut<FrameTimer>,
target_frametime: Res<FrametimeLimit>,
stats: Res<FramePaceStats>,
) {
#[cfg(not(target_arch = "wasm32"))]
if let Ok(limit) = target_frametime.0.try_lock() {
let oversleep = stats
.oversleep
.try_lock()
.as_deref()
.cloned()
.unwrap_or_default();
let sleep_time = limit.saturating_sub(timer.sleep_end.elapsed() + oversleep);
spin_sleep::sleep(sleep_time);
let frame_time_actual = timer.sleep_end.elapsed();
timer.sleep_end = Instant::now();
if let Ok(mut frametime) = stats.frametime.try_lock() {
*frametime = frame_time_actual;
}
if let Ok(mut oversleep) = stats.oversleep.try_lock() {
*oversleep = frame_time_actual.saturating_sub(*limit);
}
};
}