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
use std::time::Duration;

use bevy::{prelude::*, winit::{UpdateMode, WinitSettings}};
use bevy_framepace::{FramepacePlugin, FramepaceSettings, Limiter};

pub struct QuickResponsePlugin {
    mode: QuickResponseMode,
}

#[derive(Debug, Clone, PartialEq, Copy)]
pub enum QuickResponseMode {
    /// use Mailbox (FastVsync) for DX11/DX12, Vulkan, and use AutoNoVsync mode for Metal (flickering may occur)
    FastVsync (QuickResponseParameters),
    /// use immediate mode as much as possible (flickering may occur)
    /// NOTE: older DX12 and Wayland may not support this mode (may cause panic)
    Immediate (QuickResponseParameters),
    /// use auto no vsync for all platforms
    /// recommended if you want to work with multiple platforms, but may cause flickering
    AutoNoVsync (QuickResponseParameters),
    /// Power saving mode: choose FastVsync for presentation, and use desktop app settings for winit
    /// NOT recommended for games, but recommended for desktop apps.
    PowerSaving (QuickResponseParametersWithNoBaseFps),
    /// do nothing: use the app default behavior (VSync).
    /// if bool is true, add the default plugins (DefaultPlugins, and WindowPlugin in it).
    /// if bool is false, do nothing.
    None(bool)
}

impl Default for QuickResponseMode {
    fn default() -> Self {
        QuickResponseMode::FastVsync(QuickResponseParameters::default())
    }
}

#[derive(Debug, Clone, PartialEq, Copy)]
pub struct QuickResponseParameters {
    /// base fps, for example: when window is not focused.
    /// default: 60.0
    pub base_fps: f64,
    /// max fps, for example: when mouse moves over window.
    /// default: 120.0
    pub max_fps: f64,
    /// auto initialize default plugins (DefaultPlugins, and WindowPlugin in it).
    /// default: true
    pub auto_init_default_plugins: bool
}

#[derive(Debug, Clone, PartialEq, Copy)]
pub struct QuickResponseParametersWithNoBaseFps {
    /// max fps, for example: when mouse moves over window.
    /// default: 120.0
    pub max_fps: f64,
    /// auto initialize default plugins (DefaultPlugins, and WindowPlugin in it).
    /// default: true
    pub auto_init_default_plugins: bool
}

impl Default for QuickResponseParameters {
    fn default() -> Self {
        QuickResponseParameters {
            base_fps: 60.0,
            max_fps: 120.0,
            auto_init_default_plugins: true
        }
    }
}

impl QuickResponsePlugin {
    pub fn new(mode: QuickResponseMode) -> Self {
        QuickResponsePlugin {
            mode,
        }
    }

    pub fn power_saving(max_fps: f64) -> Self {
        QuickResponsePlugin::new(QuickResponseMode::PowerSaving(QuickResponseParametersWithNoBaseFps {
            max_fps,
            auto_init_default_plugins: true
        }))
    }

    pub fn none(is_default_plugins_enabled: bool) -> Self {
        QuickResponsePlugin::new(QuickResponseMode::None(true))
    }

    pub fn window_plugin(&self) -> WindowPlugin {
        match self.mode {
            QuickResponseMode::FastVsync(_) => {
                WindowPlugin {
                    primary_window: Some(Window {
                        #[cfg(target_os = "windows")]
                        present_mode: bevy::window::PresentMode::Mailbox,
                        #[cfg(target_os = "macos")]
                        present_mode: bevy::window::PresentMode::AutoNoVsync,
                        #[cfg(target_os = "linux")]
                        present_mode: bevy::window::PresentMode::Mailbox,
                        #[cfg(not(any(target_os = "windows", target_os = "macos", target_os = "linux")))]
                        present_mode: bevy::window::PresentMode::AutoNoVsync,
                        ..default()
                    }),
                    ..default()
                }
            },
            QuickResponseMode::Immediate(_) => {
                WindowPlugin {
                    primary_window: Some(Window {
                        present_mode: bevy::window::PresentMode::Immediate,
                        ..default()
                    }),
                    ..default()
                }
            },
            QuickResponseMode::AutoNoVsync(_) => {
                WindowPlugin {
                    primary_window: Some(Window {
                        present_mode: bevy::window::PresentMode::AutoNoVsync,
                        ..default()
                    }),
                    ..default()
                }
            },
            QuickResponseMode::PowerSaving(_) => {
                WindowPlugin {
                    primary_window: Some(Window {
                        #[cfg(target_os = "windows")]
                        present_mode: bevy::window::PresentMode::Mailbox,
                        #[cfg(target_os = "macos")]
                        present_mode: bevy::window::PresentMode::AutoNoVsync,
                        #[cfg(target_os = "linux")]
                        present_mode: bevy::window::PresentMode::Mailbox,
                        #[cfg(not(any(target_os = "windows", target_os = "macos", target_os = "linux")))]
                        present_mode: bevy::window::PresentMode::AutoNoVsync,
                        ..default()
                    }),
                    ..default()
                }
            },
            QuickResponseMode::None(_) => {
                WindowPlugin::default()
            }
        }
    }
}

impl Default for QuickResponsePlugin {
    fn default() -> Self {
        QuickResponsePlugin::new(QuickResponseMode::default())
    }
}

fn setup_fps(max_fps: f64) -> impl Fn(ResMut<FramepaceSettings>) {
    move |mut framepace_settings: ResMut<FramepaceSettings>| {
        framepace_settings.limiter = Limiter::from_framerate(max_fps);
    }
}

fn is_base_fps_enabled(mode: QuickResponseMode) -> bool {
    match mode {
        QuickResponseMode::FastVsync(_) => true,
        QuickResponseMode::Immediate(_) => true,
        QuickResponseMode::AutoNoVsync(_) => true,
        QuickResponseMode::PowerSaving(_) => false,
        QuickResponseMode::None(_) => false,
    }
}

fn is_power_saving_enabled(mode: QuickResponseMode) -> bool {
    match mode {
        QuickResponseMode::FastVsync(_) => false,
        QuickResponseMode::Immediate(_) => false,
        QuickResponseMode::AutoNoVsync(_) => false,
        QuickResponseMode::PowerSaving(_) => true,
        QuickResponseMode::None(_) => false,
    }
}

impl Plugin for QuickResponsePlugin {
    fn build(&self, app: &mut App) {
        if self.mode == QuickResponseMode::None(false) {
            // do nothing
            return;
        } else if self.mode == QuickResponseMode::None(true) {
            // just add the default plugins
            app.add_plugins(DefaultPlugins);
            return;
        }

        if is_base_fps_enabled(self.mode) {
            let base_fps = match self.mode {
                QuickResponseMode::FastVsync(params) => params.base_fps,
                QuickResponseMode::AutoNoVsync(params) => params.base_fps,
                QuickResponseMode::Immediate(params) => params.base_fps,
                QuickResponseMode::PowerSaving(_) => unreachable!(),
                QuickResponseMode::None(_) => unreachable!(),
            };

            app
                .insert_resource(WinitSettings {
                    focused_mode: UpdateMode::ReactiveLowPower { wait: Duration::from_secs_f64(1.0 / base_fps) },
                    unfocused_mode: UpdateMode::ReactiveLowPower { wait: Duration::from_secs_f64(1.0 / base_fps) },
                    ..default()
                })
                ;
        } else if is_power_saving_enabled(self.mode) {
            app
                .insert_resource(WinitSettings::desktop_app())
                ;
        }

        let max_fps = match self.mode {
            QuickResponseMode::FastVsync(params) => params.max_fps,
            QuickResponseMode::AutoNoVsync(params) => params.max_fps,
            QuickResponseMode::Immediate(params) => params.max_fps,
            QuickResponseMode::PowerSaving(params) => params.max_fps,
            QuickResponseMode::None(_) => unreachable!(),
        };

        let auto_init_default_plugins = match self.mode {
            QuickResponseMode::FastVsync(params) => params.auto_init_default_plugins,
            QuickResponseMode::AutoNoVsync(params) => params.auto_init_default_plugins,
            QuickResponseMode::Immediate(params) => params.auto_init_default_plugins,
            QuickResponseMode::PowerSaving(params) => params.auto_init_default_plugins,
            QuickResponseMode::None(_) => unreachable!(),
        };

        app
            .add_plugins(())
            ;

        if auto_init_default_plugins {
            app.add_plugins(DefaultPlugins.set(
                self.window_plugin()
            ));
        }

        app.add_plugins(FramepacePlugin);
        app.add_systems(Startup, setup_fps(max_fps));
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_plugin() {
        App::new()
            // .add_plugins(MinimalPlugins)
            .add_plugins(QuickResponsePlugin::default())
            .update();
    }
}