nightshade-renderer 0.53.0

GPU-driven wgpu renderer with a built-in frame graph.
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202

//! Per-frame mesh dirty-tracking state shared between the caller and the
//! mesh passes: dirty sets, add/remove queues, and rebuild flags.

use std::collections::{HashMap, HashSet};

use crate::entity::RenderEntity;

#[derive(Debug, Default)]
pub struct MeshRenderState {
    pub inner: MeshRenderStateInner,
}

#[derive(Debug, Default)]
pub struct MeshRenderStateInner {
    pub transform_dirty: HashSet<RenderEntity>,
    pub material_dirty: HashSet<RenderEntity>,
    pub instanced_local_matrices_dirty: HashSet<RenderEntity>,
    pub custom_data_overrides: HashMap<RenderEntity, [f32; 4]>,
    pub custom_data_dirty: HashSet<RenderEntity>,
    /// Entities whose non-structural per-object state (visibility, morph
    /// weights) changed this frame. The pass refreshes exactly these slots
    /// instead of scanning every registered object.
    pub object_state_dirty: HashSet<RenderEntity>,
    pub instanced_compute_dispatch_needed: bool,
    pub instanced_meshes_changed: bool,
    pub entities_added: Vec<RenderEntity>,
    pub entities_removed: Vec<RenderEntity>,
    pub batches_invalidated: bool,
    pub full_rebuild_needed: bool,
    pub frame_initialized: bool,
}

impl MeshRenderState {
    pub fn new() -> Self {
        Self {
            inner: MeshRenderStateInner {
                transform_dirty: HashSet::new(),
                material_dirty: HashSet::new(),
                instanced_local_matrices_dirty: HashSet::new(),
                custom_data_overrides: HashMap::new(),
                custom_data_dirty: HashSet::new(),
                object_state_dirty: HashSet::new(),
                instanced_compute_dispatch_needed: false,
                instanced_meshes_changed: false,
                entities_added: Vec::new(),
                entities_removed: Vec::new(),
                batches_invalidated: false,
                full_rebuild_needed: true,
                frame_initialized: false,
            },
        }
    }

    pub fn mark_transform_dirty(&mut self, entity: RenderEntity) {
        self.inner.transform_dirty.insert(entity);
    }

    pub fn mark_object_state_dirty(&mut self, entity: RenderEntity) {
        self.inner.object_state_dirty.insert(entity);
    }

    pub fn mark_instanced_local_matrices_dirty(&mut self, entity: RenderEntity) {
        self.inner.instanced_local_matrices_dirty.insert(entity);
    }

    pub fn mark_instanced_compute_dispatch_needed(&mut self) {
        self.inner.instanced_compute_dispatch_needed = true;
    }

    pub fn mark_instanced_meshes_changed(&mut self) {
        self.inner.instanced_meshes_changed = true;
    }

    pub fn set_entity_custom_data(&mut self, entity: RenderEntity, data: [f32; 4]) {
        let old_alpha = self
            .inner
            .custom_data_overrides
            .get(&entity)
            .map_or(1.0, |d| d[3]);
        if (old_alpha < 1.0) != (data[3] < 1.0) {
            self.inner.batches_invalidated = true;
        }
        self.inner.custom_data_overrides.insert(entity, data);
        self.inner.custom_data_dirty.insert(entity);
    }

    pub fn mark_entity_fade_complete(&mut self, entity: RenderEntity) {
        self.inner
            .custom_data_overrides
            .insert(entity, [1.0, 1.0, 1.0, 1.0]);
        self.inner.custom_data_dirty.insert(entity);
        self.inner.batches_invalidated = true;
    }

    pub fn request_full_rebuild(&mut self) {
        self.inner.full_rebuild_needed = true;
    }

    pub fn mark_material_dirty(&mut self, entity: RenderEntity) {
        self.inner.material_dirty.insert(entity);
        self.inner.batches_invalidated = true;
    }

    pub fn mark_entity_added(&mut self, entity: RenderEntity) {
        self.inner.entities_added.push(entity);
        self.inner.batches_invalidated = true;
    }

    pub fn mark_entity_removed(&mut self, entity: RenderEntity) {
        self.inner.entities_removed.push(entity);
        self.inner.batches_invalidated = true;
        self.inner.transform_dirty.remove(&entity);
        self.inner.material_dirty.remove(&entity);
    }

    pub fn has_any_changes(&self) -> bool {
        !self.inner.transform_dirty.is_empty()
            || !self.inner.material_dirty.is_empty()
            || !self.inner.entities_added.is_empty()
            || !self.inner.entities_removed.is_empty()
            || self.inner.batches_invalidated
            || self.inner.full_rebuild_needed
    }

    /// Returns entities whose transforms, materials, or per-object state
    /// (visibility, morph weights) changed this frame. Used by the
    /// per-camera dirty-tracking path to decide which viewports need to
    /// re-render based on frustum overlap with the changed entities'
    /// bounding spheres.
    pub fn dirty_entities_for_culling(&self) -> impl Iterator<Item = RenderEntity> + '_ {
        self.inner
            .transform_dirty
            .iter()
            .chain(self.inner.material_dirty.iter())
            .chain(self.inner.entities_added.iter())
            .chain(self.inner.object_state_dirty.iter())
            .copied()
    }

    /// Returns true when the renderer cannot localize dirty work to a
    /// single viewport's frustum (e.g. a full rebuild, batches were
    /// invalidated, or entities were removed). Cached viewports must
    /// re-render when this is true.
    pub fn requires_full_invalidation(&self) -> bool {
        self.inner.full_rebuild_needed
            || self.inner.batches_invalidated
            || !self.inner.entities_removed.is_empty()
    }

    pub fn frame_initialized(&self) -> bool {
        self.inner.frame_initialized
    }

    pub fn full_rebuild_needed(&self) -> bool {
        self.inner.full_rebuild_needed
    }

    pub fn batches_invalidated(&self) -> bool {
        self.inner.batches_invalidated
    }

    pub fn take_frame_state(&mut self) -> MeshRenderStateInner {
        std::mem::replace(
            &mut self.inner,
            MeshRenderStateInner {
                frame_initialized: true,
                ..Default::default()
            },
        )
    }

    /// Merges a taken-but-never-consumed frame state back in, so dirty
    /// marks captured for a frame that skipped rendering survive into the
    /// next frame instead of being dropped.
    pub fn restore_unconsumed(&mut self, unconsumed: MeshRenderStateInner) {
        let newer = std::mem::replace(&mut self.inner, unconsumed);
        self.inner.merge_newer(newer);
    }
}

impl MeshRenderStateInner {
    /// Folds a newer frame's dirty state into this one: sets union, flags
    /// combine, and add/remove orders keep this state's entries first so
    /// chronology is preserved.
    pub fn merge_newer(&mut self, newer: MeshRenderStateInner) {
        self.transform_dirty.extend(newer.transform_dirty);
        self.material_dirty.extend(newer.material_dirty);
        self.instanced_local_matrices_dirty
            .extend(newer.instanced_local_matrices_dirty);
        self.custom_data_overrides
            .extend(newer.custom_data_overrides);
        self.custom_data_dirty.extend(newer.custom_data_dirty);
        self.object_state_dirty.extend(newer.object_state_dirty);
        self.instanced_compute_dispatch_needed |= newer.instanced_compute_dispatch_needed;
        self.instanced_meshes_changed |= newer.instanced_meshes_changed;
        self.entities_added.extend(newer.entities_added);
        self.entities_removed.extend(newer.entities_removed);
        self.batches_invalidated |= newer.batches_invalidated;
        self.full_rebuild_needed |= newer.full_rebuild_needed;
        self.frame_initialized |= newer.frame_initialized;
    }
}