re_viewer_context 0.35.0

Rerun viewer state that is shared with the viewer's code components.
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

use re_mutex::RwLock;

use crate::{Cache as _, ImageDecodeCache, ImageStatsCache};

/// App-level caches for data that is not tied to any particular store.
///
/// Unlike per-store caches ([`crate::StoreCache`]), these receive no store events
/// and are not dropped together with a store.
/// Therefore, only caches whose keys are globally unique (e.g. content-addressed by row id)
/// and whose entries expire on their own (see [`crate::Cache::begin_frame`]) belong here.
#[derive(Default)]
pub struct AppCaches {
    pub image_decode: RwLock<ImageDecodeCache>,
    pub image_stats: RwLock<ImageStatsCache>,
}

impl AppCaches {
    /// Call once per frame to potentially flush the caches.
    pub fn begin_frame(&self) {
        re_tracing::profile_function!();

        let Self {
            image_decode,
            image_stats,
        } = self;
        image_decode.write().begin_frame();
        image_stats.write().begin_frame();
    }

    /// Attempt to free up memory.
    ///
    /// Called BEFORE `begin_frame` (if at all).
    pub fn purge_memory(&mut self) {
        re_tracing::profile_function!();

        let Self {
            image_decode,
            image_stats,
        } = self;
        image_decode.get_mut().purge_memory();
        image_stats.get_mut().purge_memory();
    }
}