woodpecker_ui 0.1.1

A UI library for the Bevy game engine.
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
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

use web_time::Instant;

use bevy::prelude::*;

/// A bevy resource to track widget metrics.
#[derive(Resource, Default)]
pub struct WidgetMetrics {
    total_widgets_rendered: usize,
    total_widgets_rendered_last_frame: usize,
    rendered_avg_buffer: Vec<usize>,

    quads_displayed: usize,
    quads_displayed_since_last_frame: usize,
    quads_avg_buffer: Vec<usize>,
}

pub struct LastUpdated(Instant);
impl Default for LastUpdated {
    fn default() -> Self {
        Self(Instant::now())
    }
}

impl WidgetMetrics {
    /// Returns the total number of widgets rendered over the applications lifetime.
    pub fn get_widgets_rendered(&self) -> usize {
        self.total_widgets_rendered
    }

    /// Returns the total number of widgets rendered since the last frame.
    pub fn get_widgets_rendered_since_last_frame(&self) -> usize {
        self.total_widgets_rendered_last_frame
    }

    /// Returns the average number of widgets rendered each frame.
    pub fn get_average_widgets_rendered_per_frame(&self) -> f32 {
        self.rendered_avg_buffer
            .iter()
            .map(|v| *v as f32)
            .sum::<f32>()
            / self.rendered_avg_buffer.len() as f32
    }

    pub(crate) fn increase_counts(&mut self) {
        self.total_widgets_rendered += 1;
        self.total_widgets_rendered_last_frame += 1;
    }

    pub(crate) fn clear_last_frame(&mut self) {
        self.total_widgets_rendered_last_frame = 0;
    }

    pub(crate) fn commit_frame(&mut self) {
        if self.rendered_avg_buffer.len() > 100 {
            self.rendered_avg_buffer.remove(0);
        }
        self.rendered_avg_buffer
            .push(self.total_widgets_rendered_last_frame);
    }

    /// Returns the total number of quads displayed for the lifetime of the application.
    pub fn get_quads_displayed(&self) -> usize {
        self.quads_displayed
    }

    /// Returns the total number of quads displayed to the screen since the last frame.
    pub fn get_quads_displayed_since_last_frame(&self) -> usize {
        self.quads_displayed_since_last_frame
    }

    /// Returns the average number of quads displayed per frame.
    pub fn get_average_quads_displayed_per_frame(&self) -> f32 {
        self.quads_avg_buffer.iter().map(|v| *v as f32).sum::<f32>()
            / self.quads_avg_buffer.len() as f32
    }

    pub(crate) fn increase_quad_counts(&mut self) {
        self.quads_displayed += 1;
        self.quads_displayed_since_last_frame += 1;
    }

    pub(crate) fn clear_quad_last_frame(&mut self) {
        self.quads_displayed_since_last_frame = 0;
    }

    pub(crate) fn commit_quad_frame(&mut self) {
        if self.quads_avg_buffer.len() > 100 {
            self.quads_avg_buffer.remove(0);
        }
        self.quads_avg_buffer
            .push(self.quads_displayed_since_last_frame);
    }

    /// A system that prints widget metrics!
    pub fn print_metrics_x_seconds(
        metrics: Res<WidgetMetrics>,
        mut last_update: Local<LastUpdated>,
    ) {
        if last_update.0.elapsed().as_secs_f32() > 5.0 {
            last_update.0 = Instant::now();
            info!(
                r#"
========================Woodpecker UI Metrics========================
Total Widgets Rendered: {},
Widgets Rendered Last Frame: {},
Average Rendered over 100 frames: {},
Total Quads Displayed: {},
Quads Displayed Last Frame: {},
Average Quads Displayed over 100 frames: {},
Note: "Rendered" means that widget's render system was ran not that
it was visible on screen. "Displayed" means shown on screen.
=====================================================================
"#,
                metrics.get_widgets_rendered(),
                metrics.get_widgets_rendered_since_last_frame(),
                metrics.get_average_widgets_rendered_per_frame(),
                metrics.get_quads_displayed(),
                metrics.get_quads_displayed_since_last_frame(),
                metrics.get_average_quads_displayed_per_frame()
            );
        }
    }
}