nightshade 0.13.3

A cross-platform data-oriented 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
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
use super::AcquiredSurface;
use super::PassMode;
use super::SavedUiState;
use super::font_atlas;
use super::passes;
use super::rendergraph;

impl super::WgpuRenderer {
    pub(super) fn cleanup_unused_camera_viewports(&mut self, required_cameras: &[freecs::Entity]) {
        self.camera_viewports
            .retain(|entity, _| required_cameras.contains(entity));
    }

    pub(super) fn extract_frame_dirty_state(&mut self, world: &mut crate::ecs::world::World) {
        use crate::ecs::prefab::resources::{mesh_cache_take_dirty, mesh_cache_take_dirty_skinned};

        let frame_state = world.resources.mesh_render_state.take_frame_state();
        let dirty_meshes = mesh_cache_take_dirty(&mut world.resources.mesh_cache);
        let dirty_skinned = mesh_cache_take_dirty_skinned(&mut world.resources.mesh_cache);

        if let Some(mesh_pass) = self.graph.get_pass_mut("mesh_pass")
            && let Some(pass) =
                (mesh_pass as &mut dyn std::any::Any).downcast_mut::<passes::MeshPass>()
        {
            pass.frame_dirty = Some(frame_state);
            pass.dirty_mesh_names = dirty_meshes;
        }

        if let Some(skinned_pass) = self.graph.get_pass_mut("skinned_mesh_pass")
            && let Some(pass) = (skinned_pass as &mut dyn std::any::Any)
                .downcast_mut::<passes::geometry::SkinnedMeshPass>()
        {
            pass.dirty_skinned_mesh_names = dirty_skinned;
        }
    }

    pub(super) fn resize_render_buffers(&mut self, width: u32, height: u32) {
        if self.render_buffer_size == (width, height) {
            return;
        }

        let width = width.max(1);
        let height = height.max(1);

        let (old_width, old_height) = self.render_buffer_size;
        let _ = self
            .graph
            .resize_all_transient_proportional(old_width, old_height, width, height);

        if let Some(mesh_pass) = self.graph.get_pass_mut("mesh_pass")
            && let Some(mesh_pass) =
                (mesh_pass as &mut dyn std::any::Any).downcast_mut::<passes::MeshPass>()
        {
            mesh_pass.resize(&self.device, width, height);
        }

        if let Some(bloom_pass) = self.graph.get_pass_mut("bloom_pass")
            && let Some(bloom_pass) =
                (bloom_pass as &mut dyn std::any::Any).downcast_mut::<passes::BloomPass>()
        {
            bloom_pass.resize(&self.device, &self.queue, width, height);
        }

        if let Some(outline_pass) = self.graph.get_pass_mut("outline_pass")
            && let Some(outline_pass) =
                (outline_pass as &mut dyn std::any::Any).downcast_mut::<passes::OutlinePass>()
        {
            outline_pass.resize(width, height);
        }

        self.render_buffer_size = (width, height);
    }

    pub(super) fn acquire_secondary_surface_texture(
        &self,
        id: usize,
    ) -> Result<Option<AcquiredSurface>, Box<dyn std::error::Error>> {
        let Some(secondary) = self.secondary_surfaces.get(&id) else {
            return Ok(None);
        };
        let width = secondary.width;
        let height = secondary.height;

        let surface_texture = match secondary.surface.get_current_texture() {
            wgpu::CurrentSurfaceTexture::Success(frame)
            | wgpu::CurrentSurfaceTexture::Suboptimal(frame) => frame,
            wgpu::CurrentSurfaceTexture::Outdated => {
                secondary.surface.configure(&self.device, &secondary.config);
                match secondary.surface.get_current_texture() {
                    wgpu::CurrentSurfaceTexture::Success(frame)
                    | wgpu::CurrentSurfaceTexture::Suboptimal(frame) => frame,
                    other => {
                        panic!("Failed to get surface texture after reconfiguration: {other:?}")
                    }
                }
            }
            _ => {
                return Ok(None);
            }
        };

        let view = surface_texture
            .texture
            .create_view(&wgpu::TextureViewDescriptor::default());

        Ok(Some((surface_texture, view, width, height)))
    }

    pub(super) fn swap_secondary_ui_buffers(
        &self,
        world: &mut crate::ecs::world::World,
        id: usize,
        width: u32,
        height: u32,
    ) -> SavedUiState {
        let cached_viewport_size = world.resources.window.cached_viewport_size;
        let render_buffer_size = self.render_buffer_size;
        world.resources.window.cached_viewport_size = Some((width, height));

        if let Some(buffers) = world.resources.retained_ui.secondary_buffers.get_mut(&id) {
            let frame_rects = std::mem::replace(
                &mut world.resources.retained_ui.frame_rects,
                std::mem::take(&mut buffers.frame_rects),
            );
            let frame_ui_images = std::mem::replace(
                &mut world.resources.retained_ui.frame_ui_images,
                std::mem::take(&mut buffers.frame_ui_images),
            );
            let frame_text_meshes = std::mem::replace(
                &mut world.resources.retained_ui.frame_text_meshes,
                std::mem::take(&mut buffers.frame_text_meshes),
            );
            SavedUiState {
                did_swap: true,
                frame_rects,
                frame_ui_images,
                frame_text_meshes,
                cached_viewport_size,
                render_buffer_size,
            }
        } else {
            SavedUiState {
                did_swap: false,
                frame_rects: Vec::new(),
                frame_ui_images: Vec::new(),
                frame_text_meshes: Vec::new(),
                cached_viewport_size,
                render_buffer_size,
            }
        }
    }

    pub(super) fn restore_secondary_ui_buffers(
        &mut self,
        world: &mut crate::ecs::world::World,
        saved: SavedUiState,
    ) {
        if saved.did_swap {
            world.resources.retained_ui.frame_rects = saved.frame_rects;
            world.resources.retained_ui.frame_ui_images = saved.frame_ui_images;
            world.resources.retained_ui.frame_text_meshes = saved.frame_text_meshes;
        }
        world.resources.window.cached_viewport_size = saved.cached_viewport_size;
        self.resize_render_buffers(saved.render_buffer_size.0, saved.render_buffer_size.1);
    }

    pub(super) fn execute_to_external_target(
        &mut self,
        world: &mut crate::ecs::world::World,
        target_texture: Option<&wgpu::Texture>,
        target_view: &wgpu::TextureView,
        width: u32,
        height: u32,
        pass_mode: PassMode,
    ) -> Result<(), rendergraph::RenderGraphError> {
        let saved_states = self.graph.save_pass_enabled_states();

        let has_culling_override = matches!(pass_mode, PassMode::World { .. })
            && world.resources.graphics.culling_camera_override.is_some();

        if has_culling_override
            && let Some(mesh_pass) = self.graph.get_pass_mut("mesh_pass")
            && let Some(mesh_pass) =
                (mesh_pass as &mut dyn std::any::Any).downcast_mut::<passes::MeshPass>()
        {
            mesh_pass.preserve_hiz = true;
        }

        self.resize_render_buffers(width, height);

        if matches!(pass_mode, PassMode::World { .. })
            && let Some(lines_pass) = self.graph.get_pass_mut("lines_pass")
            && let Some(lines_pass) =
                (lines_pass as &mut dyn std::any::Any).downcast_mut::<passes::LinesPass>()
        {
            passes::sync_lines_data(lines_pass, &self.device, &self.queue, world);
        }

        match pass_mode {
            PassMode::World { enable_ui } => {
                let _ = self.graph.set_pass_enabled("egui_pass", false);
                let _ = self.graph.set_pass_enabled("viewport_blit_pass", false);
                if !enable_ui {
                    let _ = self.graph.set_pass_enabled("ui_pass", false);
                    let _ = self.graph.set_pass_enabled("ui_image_pass", false);
                }

                let graphics = &world.resources.graphics;
                let _ = self
                    .graph
                    .set_pass_enabled("bloom_pass", graphics.bloom_enabled);
                let _ = self
                    .graph
                    .set_pass_enabled("ssao_pass", graphics.ssao_enabled);
                let _ = self
                    .graph
                    .set_pass_enabled("ssao_blur_pass", graphics.ssao_enabled);
                let _ = self
                    .graph
                    .set_pass_enabled("ssr_pass", graphics.ssr_enabled);
                let _ = self
                    .graph
                    .set_pass_enabled("ssr_blur_pass", graphics.ssr_enabled);
                let _ = self
                    .graph
                    .set_pass_enabled("ssgi_pass", graphics.ssgi_enabled);
                let _ = self
                    .graph
                    .set_pass_enabled("ssgi_blur_pass", graphics.ssgi_enabled);
            }
            PassMode::UiOnly => {
                for name in saved_states.keys() {
                    let _ = self.graph.set_pass_enabled(name, false);
                }
                let _ = self.graph.set_pass_enabled("ui_pass", true);
                let _ = self.graph.set_pass_enabled("ui_image_pass", true);
            }
        }

        self.graph.set_external_texture(
            self.swapchain_id,
            target_texture.cloned(),
            target_view.clone(),
            width,
            height,
        );

        if matches!(pass_mode, PassMode::World { .. }) {
            self.extract_frame_dirty_state(world);
        }

        let execute_result = self.graph.execute(&self.device, &self.queue, world);
        let execute_error = match execute_result {
            Ok(command_buffers) => {
                self.queue.submit(command_buffers);
                None
            }
            Err(error) => Some(error),
        };

        self.graph.restore_pass_enabled_states(&saved_states);

        if has_culling_override
            && let Some(mesh_pass) = self.graph.get_pass_mut("mesh_pass")
            && let Some(mesh_pass) =
                (mesh_pass as &mut dyn std::any::Any).downcast_mut::<passes::MeshPass>()
        {
            mesh_pass.preserve_hiz = false;
        }

        match execute_error {
            Some(error) => Err(error),
            None => Ok(()),
        }
    }

    pub fn render_world_to_texture(
        &mut self,
        world: &mut crate::ecs::world::World,
        target_texture: Option<&wgpu::Texture>,
        target_view: &wgpu::TextureView,
        width: u32,
        height: u32,
    ) -> Result<(), Box<dyn std::error::Error>> {
        self.execute_to_external_target(
            world,
            target_texture,
            target_view,
            width,
            height,
            PassMode::World { enable_ui: false },
        )?;
        Ok(())
    }

    pub fn device(&self) -> &wgpu::Device {
        &self.device
    }

    pub fn queue(&self) -> &wgpu::Queue {
        &self.queue
    }

    pub fn surface_format(&self) -> wgpu::TextureFormat {
        self.surface_format
    }

    pub fn surface_size(&self) -> (u32, u32) {
        (self.surface_config.width, self.surface_config.height)
    }

    pub(super) fn render_to_secondary_surface(
        &mut self,
        id: usize,
        world: &mut crate::ecs::world::World,
        pass_mode: PassMode,
    ) -> Result<(), Box<dyn std::error::Error>> {
        let Some((surface_texture, view, width, height)) =
            self.acquire_secondary_surface_texture(id)?
        else {
            return Ok(());
        };

        let saved = self.swap_secondary_ui_buffers(world, id, width, height);

        let result = self.execute_to_external_target(
            world,
            Some(&surface_texture.texture),
            &view,
            width,
            height,
            pass_mode,
        );

        self.restore_secondary_ui_buffers(world, saved);

        result?;
        surface_texture.present();
        Ok(())
    }

    pub fn cleanup_world(&mut self, world_id: u64) {
        if let Some(mesh_pass) = self.graph.get_pass_mut("mesh_pass")
            && let Some(mesh_pass) =
                (mesh_pass as &mut dyn std::any::Any).downcast_mut::<passes::MeshPass>()
        {
            mesh_pass.cleanup_world_state(world_id);
        }
    }

    pub fn cleanup_stale_worlds(&mut self, max_age_frames: u64) {
        if let Some(mesh_pass) = self.graph.get_pass_mut("mesh_pass")
            && let Some(mesh_pass) =
                (mesh_pass as &mut dyn std::any::Any).downcast_mut::<passes::MeshPass>()
        {
            mesh_pass.cleanup_stale_world_states(max_age_frames);
        }
    }

    pub(super) fn regenerate_bitmap_atlases(
        &mut self,
        new_scale: f32,
        new_subpixel: bool,
        world: &mut crate::ecs::world::World,
    ) {
        self.bitmap_font_textures.clear();
        self.bitmap_font_data.clear();
        world.resources.text_cache.font_manager.clear_bitmap_fonts();

        for (source_data, base_size) in &self.bitmap_font_sources {
            let atlas = match font_atlas::generate_font_atlas_bitmap(
                &self.device,
                &self.queue,
                source_data,
                *base_size,
                new_scale,
                new_subpixel,
            ) {
                Ok(atlas) => atlas,
                Err(error) => {
                    tracing::error!("Failed to regenerate bitmap font atlas: {}", error);
                    continue;
                }
            };

            self.bitmap_font_textures
                .push((atlas.texture, atlas.texture_view));
            let texture_index = (self.bitmap_font_textures.len() - 1) as u32;

            let atlas_data = crate::ecs::text::resources::FontAtlasData {
                texture_index,
                glyphs: atlas.glyphs,
                kerning: atlas.kerning,
                width: atlas.width,
                height: atlas.height,
                font_size: atlas.font_size,
                sdf_range: atlas.sdf_range,
            };

            self.bitmap_font_data.push(atlas_data.clone());
            world
                .resources
                .text_cache
                .font_manager
                .add_bitmap_font(atlas_data);
        }

        if let Some(ui_pass) = self.graph.get_pass_mut("ui_pass")
            && let Some(ui_pass) =
                (ui_pass as &mut dyn std::any::Any).downcast_mut::<passes::UiPass>()
        {
            ui_pass.update_texture_bind_groups(&self.device, &self.bitmap_font_textures);
        }

        world.resources.retained_ui.text_mesh_cache.clear();

        self.bitmap_atlas_scale = new_scale;
        self.bitmap_atlas_subpixel = new_subpixel;
    }
}