bevy_pf 0.2.0

A XAML / WPF-like UI framework for Bevy: XAML in macros or files, styling with resources, and the common WPF control set.
Documentation 
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

//! Performance tuning for GUI-first applications.

use bevy::app::{App, First, Last, PostUpdate, PreUpdate, RunFixedMainLoop, SpawnScene, Update};
use bevy::ecs::schedule::{Schedule, SingleThreadedExecutor};

/// Switch the per-frame schedules (main app + render app) to the
/// single-threaded executor.
///
/// GUI scenes produce sub-millisecond frames, where Bevy's default
/// multithreaded executor spends more time dispatching (~2us for each of the
/// ~400 mostly-empty systems DefaultPlugins registers) than the systems spend
/// working. On an M4 Pro this takes an empty bevy_pf scene from ~1,000 FPS to
/// ~3,800 FPS offscreen.
///
/// Call it after `DefaultPlugins`:
///
/// ```ignore
/// let mut app = App::new();
/// app.add_plugins(DefaultPlugins).add_plugins(PfUiPlugin);
/// bevy_pf::perf::tune_schedules_for_gui(&mut app);
/// ```
///
/// Skip this if your app also runs heavy per-frame simulation systems that
/// benefit from parallelism — it trades parallel dispatch for lower fixed
/// overhead, which is the right trade only when frames are dominated by
/// scheduling, not work.
pub fn tune_schedules_for_gui(app: &mut App) {
    fn st(s: &mut Schedule) {
        s.set_executor(SingleThreadedExecutor::new());
    }
    app.edit_schedule(First, st);
    app.edit_schedule(PreUpdate, st);
    app.edit_schedule(Update, st);
    app.edit_schedule(PostUpdate, st);
    app.edit_schedule(Last, st);
    app.edit_schedule(SpawnScene, st);
    app.edit_schedule(RunFixedMainLoop, st);
}

/// [`tune_schedules_for_gui`] plus the render app's `Render`/`Extract`
/// schedules.
///
/// **Headless/offscreen apps only.** With a real window on macOS, swapping
/// the render schedule's executor changes which thread configures the
/// surface, and `raw-window-metal` panics with "can only access NSView on
/// the main thread". Offscreen (`RenderTarget::Image`, no window) there is
/// no surface, and this buys another large cut of dispatch overhead.
pub fn tune_schedules_for_gui_headless(app: &mut App) {
    fn st(s: &mut Schedule) {
        s.set_executor(SingleThreadedExecutor::new());
    }
    tune_schedules_for_gui(app);
    if let Some(render_app) = app.get_sub_app_mut(bevy::render::RenderApp) {
        render_app.edit_schedule(bevy::render::Render, st);
        render_app.edit_schedule(bevy::render::ExtractSchedule, st);
    }
}