molgfx-render 0.1.1

The render graph, passes and the engine that drives a frame.
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

//! Structure placement reconciliation against shared physical asset buffers.

use super::GpuScene;
use crate::RenderError;
use crate::scene_gpu::asset::{GpuAsset, GpuAssetIdentity};
use crate::scene_gpu::structure::GpuStructure;
use molgfx_core::Scene;
use molgfx_gpu::Device;
use std::sync::Arc;

#[cfg(test)]
pub(crate) struct TestAssetLayout {
    pub(crate) buffers: [u32; 3],
    pub(crate) offsets: [u64; 3],
    pub(crate) lengths: [u64; 3],
    pub(crate) model: u32,
}

impl<D: Device> GpuScene<D> {
    pub(super) fn reconcile_structures(
        &mut self,
        device: &D,
        queue: &D::Queue,
        scene: &Scene,
    ) -> Result<bool, RenderError> {
        let revision = scene.structure_revision();
        if self.structure_revision == Some(revision) {
            return Ok(false);
        }
        let mut old = std::mem::take(&mut self.structures);
        let mut uploaded = false;
        let arena_revision = self.asset_arena.revision();
        for (handle, placed) in scene.structures() {
            let identity = GpuAssetIdentity::from_placed(placed);
            self.validate_asset_identity(identity)?;
            let asset =
                if let Some(asset) = self.assets.iter().find(|asset| asset.identity == identity) {
                    Arc::clone(asset)
                } else {
                    let asset = Arc::new(GpuAsset::upload(
                        device,
                        queue,
                        &mut self.asset_arena,
                        placed,
                        identity,
                    )?);
                    self.assets.push(Arc::clone(&asset));
                    uploaded = true;
                    asset
                };
            if let Some(index) = old.iter().position(|gpu| gpu.handle == handle) {
                let mut structure = old.swap_remove(index);
                structure.replace_asset(asset);
                self.structures.push(structure);
            } else {
                self.structures.push(GpuStructure::new(handle, asset));
            }
        }
        drop(old);
        self.release_unused_assets()?;
        if self.asset_arena.revision() != arena_revision {
            for structure in &mut self.structures {
                structure.invalidate_asset_binding();
            }
        }
        self.structure_revision = Some(revision);
        Ok(uploaded)
    }

    fn release_unused_assets(&mut self) -> Result<(), RenderError> {
        let mut index = self.assets.len();
        while index > 0 {
            index -= 1;
            if Arc::strong_count(&self.assets[index]) == 1 {
                self.assets[index].release(&mut self.asset_arena)?;
                self.assets.swap_remove(index);
            }
        }
        Ok(())
    }

    pub(super) fn release_all_assets(&mut self) -> Result<(), RenderError> {
        for asset in &self.assets {
            asset.release(&mut self.asset_arena)?;
        }
        self.assets.clear();
        Ok(())
    }

    fn validate_asset_identity(&self, incoming: GpuAssetIdentity) -> Result<(), RenderError> {
        let conflict = self
            .assets
            .iter()
            .map(|asset| asset.identity)
            .find(|resident| resident.conflicts_with(incoming));
        match conflict {
            Some(resident) => Err(RenderError::AssetIdentityCollision {
                dataset: incoming.dataset,
                resident_fingerprint: resident.fingerprint,
                incoming_fingerprint: incoming.fingerprint,
            }),
            None => Ok(()),
        }
    }

    #[cfg(test)]
    pub(crate) fn asset_counts(&self) -> (usize, usize, u64) {
        (
            self.assets.len(),
            self.structures.len(),
            self.assets.iter().map(|asset| asset.resident_bytes()).sum(),
        )
    }

    #[cfg(test)]
    pub(crate) fn asset_layouts<F>(&self, mut identify: F) -> Vec<TestAssetLayout>
    where
        F: FnMut(&D::Buffer) -> u32,
    {
        let arena_id = identify(self.asset_arena.buffer());
        self.structures
            .iter()
            .map(|structure| {
                let ranges = structure.test_ranges();
                let ids = [arena_id; 3];
                let offsets = ranges.map(super::super::asset_arena::AssetRange::offset);
                let lengths = ranges.map(super::super::asset_arena::AssetRange::allocated_bytes);
                let model = match structure.test_model() {
                    Some(buffer) => identify(buffer),
                    None => arena_id,
                };
                TestAssetLayout {
                    buffers: ids,
                    offsets,
                    lengths,
                    model,
                }
            })
            .collect()
    }
}