concinnity-asset 0.18.66

User-facing asset schema for the Concinnity 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

// FpsCounter component schema.

use crate::{AssetId, de_opt_asset_ref};

/// Requests a frames-per-second counter; optionally writes it to a
/// [TextLabel](#textlabel).
///
/// Declaring an `FpsCounter` updates the named [TextLabel](#textlabel) with the
/// current rate once per second. Omit `label` to suppress on-screen display.
///
/// To display an FPS overlay, declare a [Font](#font), a
/// [TextLabel](#textlabel), and an `FpsCounter` that references the label:
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
#[serde(default)]
#[derive(Default)]
pub struct FpsCounter {
    /// A [TextLabel](#textlabel) to update with the current FPS each second.
    /// Leave unset to suppress on-screen display.
    #[serde(deserialize_with = "de_opt_asset_ref")]
    pub label: Option<AssetId>,
}

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

    #[test]
    fn an_unset_label_suppresses_the_on_screen_readout() {
        assert!(FpsCounter::default().label.is_none());
        assert!(
            serde_json::from_str::<FpsCounter>(r#"{"label":""}"#)
                .unwrap()
                .label
                .is_none()
        );
    }

    #[test]
    fn a_named_label_parses_and_round_trips_through_postcard() {
        crate::test_support::install_resolvers();
        let c: FpsCounter = serde_json::from_str(r#"{"label":"fps_chip"}"#).unwrap();
        assert_eq!(c.label, Some(AssetId(8)));

        let bytes = postcard::to_allocvec(&c).unwrap();
        let back: FpsCounter = postcard::from_bytes(&bytes).unwrap();
        assert_eq!(back.label, Some(AssetId(8)));
    }
}