sim-engine 0.4.2

A validated high-performance visualization engine for simulations
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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
//! Retained 3D frame validation, staging, upload and submission.

use super::upload_changes::UploadSpan;
use super::{
    Arc, Camera3d, Camera3dUniform, Color, EdgeObjectUniform, GpuTimingSource, Instant,
    LogicalPixels, Mesh3dRenderBudget, Mesh3dRenderError, Mesh3dRenderReport, Mesh3dRenderer,
    MeshColorGpu, MeshInstanceGpu, RenderTarget3d, Scene3d, SurfaceClipEdge, SurfaceClipVertex,
    SurfaceEnvironmentGpu, SurfaceFrame, SurfaceLightingVertex, TextureMaterial3d,
    buffer_capacity_fits, encode_ordered_scene_pass, gpu_timing, material, surface, texture,
    validate_camera_target_aspect, validate_target_identity,
};

// Keep visible-index dynamic offsets unchanged when edges exist. Surface-only
// frames need neither padded edge staging nor a proportional edge GPU buffer.
pub(super) fn edge_uniform_object_count(scene: &Scene3d) -> usize {
    if scene.instances().iter().any(|instance| {
        instance.visible && instance.wireframe().is_some() && instance.mesh.edge_count > 0
    }) {
        scene.visible_object_count()
    } else {
        0
    }
}

impl Mesh3dRenderer {
    pub(super) fn retained_frame_cpu_bytes(&self) -> usize {
        self.instances
            .capacity()
            .saturating_mul(std::mem::size_of::<MeshInstanceGpu>())
            .saturating_add(self.edge_object_bytes.capacity())
            .saturating_add(self.surface_frame.retained_cpu_bytes())
    }

    pub(super) fn retained_frame_gpu_bytes(&self) -> usize {
        [
            Some(&self.camera_uniform_buffer),
            Some(&self.instance_buffer),
            Some(&self.edge_object_buffer),
            self.clipped_surface_buffer.as_ref(),
            self.clipped_color_buffer.as_ref(),
            self.clipped_lighting_buffer.as_ref(),
            self.clipped_edge_buffer.as_ref(),
        ]
        .into_iter()
        .flatten()
        .fold(0usize, |total, buffer| {
            total.saturating_add(buffer.size() as usize)
        })
    }

    pub(super) fn preflight_scene3d(
        &self,
        device: &wgpu::Device,
        renderer_identity: &Arc<()>,
        target: &RenderTarget3d,
        scene: &Scene3d,
        camera: Camera3d,
        budget: Mesh3dRenderBudget,
    ) -> Result<(Camera3dUniform, SurfaceFrame), Mesh3dRenderError> {
        let mut frame = SurfaceFrame::default();
        let camera = Self::prepare_frame(
            device,
            renderer_identity,
            target,
            scene,
            camera,
            budget,
            self.edge_object_stride,
            &mut frame,
        )?;
        Ok((camera, frame))
    }

    #[allow(clippy::too_many_arguments)]
    fn prepare_frame(
        device: &wgpu::Device,
        renderer_identity: &Arc<()>,
        target: &RenderTarget3d,
        scene: &Scene3d,
        camera: Camera3d,
        budget: Mesh3dRenderBudget,
        edge_object_stride: usize,
        frame: &mut SurfaceFrame,
    ) -> Result<Camera3dUniform, Mesh3dRenderError> {
        frame.reset();
        let result = (|| {
            validate_target_identity(renderer_identity, target)?;
            validate_camera_target_aspect(camera, target.logical_viewport())?;
            let mut camera_uniform = Camera3dUniform::new(
                camera,
                target.width(),
                target.height(),
                target.pixels_per_logical(),
            )?;
            if scene.visible_object_count() > u32::MAX as usize {
                return Err(Mesh3dRenderError::InstanceCapacityTooLarge);
            }
            let capacity = scene
                .visible_object_count()
                .max(1)
                .checked_next_power_of_two()
                .ok_or(Mesh3dRenderError::InstanceCapacityTooLarge)?;
            let edge_capacity = edge_uniform_object_count(scene)
                .checked_next_power_of_two()
                .ok_or(Mesh3dRenderError::InstanceCapacityTooLarge)?;
            if !buffer_capacity_fits::<MeshInstanceGpu>(device, capacity)
                || edge_capacity
                    .checked_mul(edge_object_stride)
                    .is_none_or(|bytes| {
                        bytes as u64 > device.limits().max_buffer_size || bytes > u32::MAX as usize
                    })
            {
                return Err(Mesh3dRenderError::InstanceCapacityTooLarge);
            }
            camera_uniform.environment = SurfaceEnvironmentGpu::new(scene, camera);
            material::prepare_order_into(scene, camera, budget, &mut frame.order)?;
            surface::preflight_into(
                renderer_identity,
                scene,
                camera_uniform,
                budget,
                device.limits().max_buffer_size,
                frame,
            )?;
            Ok(camera_uniform)
        })();
        if result.is_err() {
            frame.reset();
        }
        result
    }

    /// Reference fixtures can explicitly overwrite private GPU buffers. Public
    /// callers cannot do this; a new logical renderer naturally starts empty.
    #[cfg(test)]
    pub(super) fn invalidate_upload_history(&mut self) {
        self.previous_camera = None;
        self.instances.clear();
        self.edge_object_bytes.clear();
    }
    #[cfg(test)]
    #[allow(clippy::too_many_arguments)]
    pub(super) fn render_scene3d(
        &mut self,
        device: &wgpu::Device,
        queue: &wgpu::Queue,
        renderer_identity: &Arc<()>,
        target: &RenderTarget3d,
        scene: &Scene3d,
        camera: Camera3d,
        budget: Mesh3dRenderBudget,
    ) -> Result<Mesh3dRenderReport, Mesh3dRenderError> {
        self.render_scene3d_with_timing(
            device,
            queue,
            renderer_identity,
            target,
            scene,
            camera,
            budget,
            None,
        )
    }

    #[allow(clippy::too_many_arguments)]
    pub(super) fn render_scene3d_with_timing(
        &mut self,
        device: &wgpu::Device,
        queue: &wgpu::Queue,
        renderer_identity: &Arc<()>,
        target: &RenderTarget3d,
        scene: &Scene3d,
        camera: Camera3d,
        budget: Mesh3dRenderBudget,
        mut gpu_timing: Option<&mut gpu_timing::GpuTimingCollector>,
    ) -> Result<Mesh3dRenderReport, Mesh3dRenderError> {
        let upload_started_at = Instant::now();
        let previous_surface_capacities = self.surface_frame.capacity_bytes();
        let previous_instance_bytes =
            self.instances.capacity() * std::mem::size_of::<MeshInstanceGpu>();
        let previous_edge_bytes = self.edge_object_bytes.capacity();
        let previous_frame_gpu_bytes = self.retained_frame_gpu_bytes();
        let camera_uniform = Self::prepare_frame(
            device,
            renderer_identity,
            target,
            scene,
            camera,
            budget,
            self.edge_object_stride,
            &mut self.surface_frame,
        )?;
        let preflight_duration = upload_started_at.elapsed();
        let surface_frame = &self.surface_frame;
        let visible_count = scene.visible_object_count();
        let edge_object_count = edge_uniform_object_count(scene);
        let mut uploaded_bytes = surface_frame.report.generated_upload_bytes();
        let mut upload_calls = usize::from(!surface_frame.vertices.is_empty())
            + usize::from(!surface_frame.colors.is_empty())
            + usize::from(!surface_frame.lighting.is_empty())
            + usize::from(!surface_frame.edges.is_empty());
        let replacement_surface_buffer =
            if surface_frame.vertices.len() > self.clipped_surface_capacity {
                Some(device.create_buffer(&wgpu::BufferDescriptor {
                    label: Some("sim-engine clipped 3D surface buffer"),
                    size: (surface_frame.vertices.len() * std::mem::size_of::<SurfaceClipVertex>())
                        as u64,
                    usage: wgpu::BufferUsages::VERTEX | wgpu::BufferUsages::COPY_DST,
                    mapped_at_creation: false,
                }))
            } else {
                None
            };
        let replacement_lighting_buffer = if surface_frame.lighting.len()
            > self.clipped_lighting_capacity
        {
            Some(device.create_buffer(&wgpu::BufferDescriptor {
                label: Some("sim-engine canonical 3D lighting attributes"),
                size: (surface_frame.lighting.len() * std::mem::size_of::<SurfaceLightingVertex>())
                    as u64,
                usage: wgpu::BufferUsages::VERTEX | wgpu::BufferUsages::COPY_DST,
                mapped_at_creation: false,
            }))
        } else {
            None
        };
        let replacement_color_buffer = if surface_frame.colors.len() > self.clipped_color_capacity {
            Some(device.create_buffer(&wgpu::BufferDescriptor {
                label: Some("sim-engine clipped 3D vertex color buffer"),
                size: (surface_frame.colors.len() * std::mem::size_of::<MeshColorGpu>()) as u64,
                usage: wgpu::BufferUsages::VERTEX | wgpu::BufferUsages::COPY_DST,
                mapped_at_creation: false,
            }))
        } else {
            None
        };
        let replacement_edge_buffer = if surface_frame.edges.len() > self.clipped_edge_capacity {
            Some(device.create_buffer(&wgpu::BufferDescriptor {
                label: Some("sim-engine canonical clip-space 3D edge buffer"),
                size: (surface_frame.edges.len() * std::mem::size_of::<SurfaceClipEdge>()) as u64,
                usage: wgpu::BufferUsages::VERTEX | wgpu::BufferUsages::COPY_DST,
                mapped_at_creation: false,
            }))
        } else {
            None
        };
        let replace_instance_buffer = visible_count > self.instance_capacity;
        let replace_edge_buffer = edge_object_count > self.edge_object_capacity;
        let replace_instance_staging = visible_count > self.instances.capacity();
        let replace_edge_staging =
            edge_object_count * self.edge_object_stride > self.edge_object_bytes.capacity();
        let generated_replacements = [
            replacement_surface_buffer.as_ref(),
            replacement_lighting_buffer.as_ref(),
            replacement_color_buffer.as_ref(),
            replacement_edge_buffer.as_ref(),
        ];
        let buffer_allocation_count = generated_replacements.iter().flatten().count()
            + usize::from(replace_instance_buffer)
            + usize::from(replace_edge_buffer);
        let replacement_generated_bytes = generated_replacements
            .into_iter()
            .flatten()
            .fold(0usize, |total, buffer| {
                total.saturating_add(buffer.size() as usize)
            });
        if let Err(error) = self.ensure_frame_capacity(device, visible_count, edge_object_count) {
            self.surface_frame.reset();
            return Err(error);
        }
        // Conservative overlap bound: unchanged arrays are counted once; a
        // capacity replacement may temporarily own both old and new allocations.
        let old_surface_overlap = previous_surface_capacities
            .into_iter()
            .zip(self.surface_frame.capacity_bytes())
            .filter(|(old, new)| old != new)
            .fold(0usize, |sum, (old, _)| sum.saturating_add(old));
        let peak_frame_cpu_bytes = self
            .retained_frame_cpu_bytes()
            .saturating_add(old_surface_overlap)
            .saturating_add(if replace_instance_staging {
                previous_instance_bytes
            } else {
                0
            })
            .saturating_add(if replace_edge_staging {
                previous_edge_bytes
            } else {
                0
            });
        let surface_frame = &self.surface_frame;
        let peak_frame_gpu_bytes = previous_frame_gpu_bytes
            .saturating_add(replacement_generated_bytes)
            .saturating_add(if replace_instance_buffer {
                self.instance_buffer.size() as usize
            } else {
                0
            })
            .saturating_add(if replace_edge_buffer {
                self.edge_object_buffer.size() as usize
            } else {
                0
            });
        if let Some(buffer) = replacement_surface_buffer {
            self.clipped_surface_buffer = Some(buffer);
            self.clipped_surface_capacity = surface_frame.vertices.len();
        }
        if let Some(buffer) = replacement_edge_buffer {
            self.clipped_edge_buffer = Some(buffer);
            self.clipped_edge_capacity = surface_frame.edges.len();
        }
        if let Some(buffer) = replacement_lighting_buffer {
            self.clipped_lighting_buffer = Some(buffer);
            self.clipped_lighting_capacity = surface_frame.lighting.len();
        }
        if let Some(buffer) = &self.clipped_lighting_buffer
            && !surface_frame.lighting.is_empty()
        {
            queue.write_buffer(buffer, 0, bytemuck::cast_slice(&surface_frame.lighting));
        }
        if let Some(buffer) = replacement_color_buffer {
            self.clipped_color_buffer = Some(buffer);
            self.clipped_color_capacity = surface_frame.colors.len();
        }
        if let Some(buffer) = &self.clipped_color_buffer
            && !surface_frame.colors.is_empty()
        {
            queue.write_buffer(buffer, 0, bytemuck::cast_slice(&surface_frame.colors));
        }
        if let Some(buffer) = &self.clipped_surface_buffer
            && !surface_frame.vertices.is_empty()
        {
            queue.write_buffer(buffer, 0, bytemuck::cast_slice(&surface_frame.vertices));
        }
        if let Some(buffer) = &self.clipped_edge_buffer
            && !surface_frame.edges.is_empty()
        {
            queue.write_buffer(buffer, 0, bytemuck::cast_slice(&surface_frame.edges));
        }
        let mut instance_changes = UploadSpan::default();
        let mut edge_changes = UploadSpan::default();
        let previous_edge_len = self.edge_object_bytes.len();
        self.edge_object_bytes
            .resize(edge_object_count.saturating_mul(self.edge_object_stride), 0);
        let triangle_count = surface_frame.report.submitted_triangle_count();
        let mut edge_count = 0usize;
        for (object_index, instance) in scene
            .instances()
            .iter()
            .filter(|instance| instance.visible)
            .enumerate()
        {
            let model_rows = surface_frame.objects[object_index].model_rows;
            let normal_rows = surface_frame.objects[object_index].transport.normal_rows;
            let next_instance = MeshInstanceGpu {
                normal_row_0: normal_rows[0],
                normal_row_1: normal_rows[1],
                normal_row_2: normal_rows[2],
                model_row_0: model_rows[0],
                model_row_1: model_rows[1],
                model_row_2: model_rows[2],
                surface: material::surface_parameters(instance.style.surface_style()),
                uv_transform: texture::material_uv_parameters(instance.mesh.material()),
                color: {
                    let color = instance
                        .style
                        .surface_style()
                        .map_or(Color::BLACK, |surface| surface.color())
                        .to_array();
                    let tint = instance
                        .mesh
                        .material()
                        .map_or(Color::WHITE, TextureMaterial3d::tint)
                        .to_array();
                    std::array::from_fn(|index| color[index] * tint[index])
                },
            };
            let instance_start = object_index * std::mem::size_of::<MeshInstanceGpu>();
            if let Some(previous) = self.instances.get_mut(object_index) {
                instance_changes.replace(instance_start, previous, next_instance);
            } else {
                self.instances.push(next_instance);
                instance_changes
                    .mark(instance_start..instance_start + std::mem::size_of::<MeshInstanceGpu>());
            }
            let mut edge_uniform = <EdgeObjectUniform as bytemuck::Zeroable>::zeroed();
            if let Some(style) = instance
                .wireframe()
                .filter(|_| instance.mesh.edge_count > 0)
            {
                let instance_edge_count = instance.mesh.source().display_edges().len();
                edge_count = edge_count.saturating_add(instance_edge_count);
                let hidden_color = style.hidden_color().unwrap_or(style.visible_color());
                let hidden_width = style.hidden_width().map_or(0.0, LogicalPixels::get);
                let (dash_length, gap_length) = style
                    .hidden_pattern()
                    .map_or((1.0, 1.0), |(dash, gap)| (dash.get(), gap.get()));
                edge_uniform = EdgeObjectUniform {
                    model_row_0: model_rows[0],
                    model_row_1: model_rows[1],
                    model_row_2: model_rows[2],
                    visible_color: style.visible_color().to_array(),
                    hidden_color: hidden_color.to_array(),
                    edge_style: [
                        style.visible_width().get(),
                        hidden_width,
                        dash_length,
                        gap_length,
                    ],
                };
            }
            if edge_object_count > 0 {
                let start = object_index * self.edge_object_stride;
                let end = start + std::mem::size_of::<EdgeObjectUniform>();
                edge_changes.replace_bytes(
                    start,
                    &mut self.edge_object_bytes[start..end],
                    bytemuck::bytes_of(&edge_uniform),
                );
                if start >= previous_edge_len {
                    // Newly exposed zero-valued slots are also unknown on GPU.
                    edge_changes.mark(start..start + self.edge_object_stride);
                }
            }
        }
        self.instances.truncate(visible_count);
        if replace_instance_buffer || replace_instance_staging {
            instance_changes
                .force_full(self.instances.len() * std::mem::size_of::<MeshInstanceGpu>());
        }
        if replace_edge_buffer || replace_edge_staging {
            edge_changes.force_full(self.edge_object_bytes.len());
        }
        if self.previous_camera.as_ref().is_none_or(|previous| {
            bytemuck::bytes_of(previous) != bytemuck::bytes_of(&camera_uniform)
        }) {
            queue.write_buffer(
                &self.camera_uniform_buffer,
                0,
                bytemuck::bytes_of(&camera_uniform),
            );
            uploaded_bytes = uploaded_bytes.saturating_add(std::mem::size_of::<Camera3dUniform>());
            upload_calls += 1;
        }
        self.previous_camera = Some(camera_uniform);
        if let Some(range) = instance_changes.range() {
            queue.write_buffer(
                &self.instance_buffer,
                range.start as u64,
                &bytemuck::cast_slice::<_, u8>(&self.instances)[range],
            );
            uploaded_bytes = uploaded_bytes.saturating_add(instance_changes.byte_count());
            upload_calls += 1;
        }
        if let Some(range) = edge_changes.range() {
            queue.write_buffer(
                &self.edge_object_buffer,
                range.start as u64,
                &self.edge_object_bytes[range],
            );
            uploaded_bytes = uploaded_bytes.saturating_add(edge_changes.byte_count());
            upload_calls += 1;
        }
        let upload = upload_started_at.elapsed();
        let staging_upload_duration = upload.saturating_sub(preflight_duration);
        let encode_started_at = Instant::now();
        let mut encoder = device.create_command_encoder(&wgpu::CommandEncoderDescriptor {
            label: Some("sim-engine retained 3D scene encoder"),
        });
        let timing = gpu_timing
            .as_deref_mut()
            .and_then(|collector| collector.reserve(GpuTimingSource::Scene3d));
        let draw_call_count = encode_ordered_scene_pass(
            &mut encoder,
            self,
            &target.color.view,
            &target.depth_view,
            scene.background(),
            scene.instances(),
            &surface_frame.order,
            timing.as_ref().map(|timing| timing.timestamp_writes()),
        );
        if let Some(timing) = &timing {
            timing.resolve(&mut encoder);
        }
        queue.submit([encoder.finish()]);
        let gpu_timing_id = match (gpu_timing, timing) {
            (Some(collector), Some(timing)) => Some(collector.submitted(timing)),
            _ => None,
        };
        let encode_submit = encode_started_at.elapsed();
        Ok(Mesh3dRenderReport {
            object_count: visible_count - surface_frame.report.culled_object_count(),
            triangle_count,
            edge_count,
            render_pass_count: 1,
            draw_call_count,
            upload,
            preflight_duration,
            staging_upload_duration,
            encode_submit,
            preflight: surface_frame.report,
            gpu_timing_id,
            uploaded_bytes,
            upload_calls,
            buffer_allocation_count,
            retained_frame_cpu_bytes: self.retained_frame_cpu_bytes(),
            retained_frame_gpu_bytes: self.retained_frame_gpu_bytes(),
            staging_capacity_bytes: self.retained_frame_cpu_bytes(),
            peak_frame_cpu_bytes,
            peak_frame_gpu_bytes,
        })
    }
}