kiss3d 0.45.0

Keep it simple, stupid, 2D and 3D graphics engine for Rust.
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

//! The "Global" inspector tab: the renderer toggle, settings shared by both
//! renderers (exposure/tonemap), the rasterizer settings (background, MSAA,
//! shadows, bloom, SSAO/SSR/DoF and the skybox loader), the path-tracer settings,
//! and the per-frame timings.

use crate::post_processing::HdrSettings;
use crate::renderer::{RayTracer, RenderTimings};
use crate::window::NumSamples;

use super::widgets::*;
use super::{Inspector, WinSettings};

impl Inspector {
    /// Per-step wall-clock timings of the last rendered frame.
    pub(super) fn timings_section(ui: &mut egui::Ui, timings: Option<&RenderTimings>) {
        egui::CollapsingHeader::new("Timings")
            .default_open(true)
            .show(ui, |ui| match timings {
                Some(t) => {
                    // `RenderTimings` already formats a tidy multi-line summary.
                    ui.monospace(t.to_string());
                }
                None => {
                    ui.label("No frame rendered yet.");
                }
            });
    }

    pub(super) fn renderer_section(
        &mut self,
        ui: &mut egui::Ui,
        raytracer: Option<&mut RayTracer>,
    ) {
        egui::CollapsingHeader::new("Renderer")
            .default_open(true)
            .show(ui, |ui| match raytracer {
                Some(rt) => {
                    let mut enabled = rt.enabled();
                    if ui
                        .checkbox(&mut enabled, "Enable path tracer")
                        .on_hover_text("Off renders with the rasterizer instead")
                        .changed()
                    {
                        rt.set_enabled(enabled);
                    }
                    if rt.enabled() {
                        ui.label(format!("Backend: {:?}", rt.backend()));
                        ui.label(format!("Samples accumulated: {}", rt.samples_accumulated()));
                        if ui.button("Restart accumulation").clicked() {
                            rt.mark_dirty();
                        }
                    }
                }
                None => {
                    ui.label("Rasterizer (no path tracer was passed to draw_inspector).");
                }
            });
    }

    /// Settings that affect both renderers (exposure, tonemap operator, vsync).
    pub(super) fn common_section(
        &mut self,
        ui: &mut egui::Ui,
        hdr: &mut HdrSettings,
        vsync: &mut bool,
    ) {
        egui::CollapsingHeader::new("Common")
            .default_open(true)
            .show(ui, |ui| {
                ui.add(
                    egui::Slider::new(&mut hdr.exposure, 0.0..=8.0)
                        .text("Exposure")
                        .logarithmic(true),
                );
                tonemap_combo(ui, "inspector_tonemap", &mut hdr.tonemap);
                ui.checkbox(vsync, "VSync").on_hover_text(
                    "Off presents frames uncapped (not paced to the display refresh) \
                     — compare with the wall-clock frame time in Timings to see the \
                     real GPU-bound throughput.",
                );
            });
    }

    pub(super) fn rasterizer_section(&mut self, ui: &mut egui::Ui, win: &mut WinSettings) {
        egui::CollapsingHeader::new("Rasterizer")
            .default_open(true)
            .show(ui, |ui| {
                ui.horizontal(|ui| {
                    ui.label("Background");
                    ui.color_edit_button_rgb(&mut win.background);
                });
                ui.add(egui::Slider::new(&mut win.ambient, 0.0..=1.0).text("Ambient"));

                ui.horizontal(|ui| {
                    ui.label("MSAA");
                    egui::ComboBox::from_id_salt("inspector_msaa")
                        .selected_text(msaa_label(win.samples))
                        .show_ui(ui, |ui| {
                            ui.selectable_value(&mut win.samples, NumSamples::One, "Off");
                            ui.selectable_value(&mut win.samples, NumSamples::Four, "4×");
                        });
                });

                ui.checkbox(&mut win.shadows, "Shadows");
                ui.add_enabled_ui(win.shadows, |ui| {
                    ui.add(
                        egui::Slider::new(&mut win.shadow_res, 256..=8192)
                            .text("Shadow resolution")
                            .step_by(256.0),
                    );
                    ui.add(
                        egui::Slider::new(&mut win.shadow_softness, 0.0..=8.0)
                            .text("Shadow softness"),
                    );
                });

                // Bloom is a rasterizer post-process (the path tracer ignores it).
                let hdr = &mut win.hdr;
                ui.checkbox(&mut hdr.bloom_enabled, "Bloom");
                ui.add_enabled_ui(hdr.bloom_enabled, |ui| {
                    ui.add(
                        egui::Slider::new(&mut hdr.bloom_threshold, 0.0..=4.0).text("Threshold"),
                    );
                    ui.add(egui::Slider::new(&mut hdr.bloom_knee, 0.0..=1.0).text("Knee"));
                    ui.add(
                        egui::Slider::new(&mut hdr.bloom_intensity, 0.0..=1.0).text("Intensity"),
                    );
                });

                self.effects_ui(ui);
                self.skybox_ui(ui);
            });
    }

    /// Equirectangular skybox loader (the actual load/clear is applied to the
    /// window in `draw_inspector`; the request flags are set here).
    fn skybox_ui(&mut self, ui: &mut egui::Ui) {
        ui.collapsing("Skybox", |ui| {
            ui.horizontal(|ui| {
                ui.label("Image");
                ui.text_edit_singleline(&mut self.skybox_path);
            });
            ui.horizontal(|ui| {
                // Native file-open dialog (wasm: type a path instead).
                #[cfg(not(target_arch = "wasm32"))]
                if ui.button("Open…").clicked() {
                    if let Some(p) = pick_image_path() {
                        self.skybox_path = p;
                        self.skybox_load_requested = true;
                    }
                }
                if ui.button("Load").clicked() {
                    self.skybox_load_requested = true;
                }
                if ui.button("Clear").clicked() {
                    self.skybox_clear_requested = true;
                }
            });
            let mut changed = ui
                .add(
                    egui::Slider::new(&mut self.skybox_rotation_deg, -180.0..=180.0)
                        .text("Rotation°"),
                )
                .changed();
            changed |= ui
                .add(egui::Slider::new(&mut self.skybox_intensity, 0.0..=8.0).text("Intensity"))
                .changed();
            if changed {
                self.skybox_orient_dirty = true;
            }
            if !self.skybox_status.is_empty() {
                ui.label(&self.skybox_status);
            }
        });
    }

    /// Screen-space effects sharing the geometry prepass (SSAO / SSR / DoF). All
    /// are rasterizer-only post-processes; the path tracer ignores them.
    fn effects_ui(&mut self, ui: &mut egui::Ui) {
        ui.collapsing("Ambient occlusion (SSAO)", |ui| {
            ui.checkbox(&mut self.ssao_enabled, "Enabled");
            ui.add_enabled_ui(self.ssao_enabled, |ui| {
                let s = &mut self.ssao;
                ui.add(egui::Slider::new(&mut s.radius, 0.0..=4.0).text("Radius"));
                ui.add(egui::Slider::new(&mut s.bias, 0.0..=0.2).text("Bias"));
                ui.add(egui::Slider::new(&mut s.intensity, 0.0..=4.0).text("Intensity"));
                ui.add(egui::Slider::new(&mut s.power, 0.1..=8.0).text("Power"));
            });
        });

        ui.collapsing("Screen-space reflections (SSR)", |ui| {
            ui.checkbox(&mut self.ssr_enabled, "Enabled")
                .on_hover_text("Native / WebGPU only (needs compute + storage buffers)");
            ui.add_enabled_ui(self.ssr_enabled, |ui| {
                let s = &mut self.ssr;
                ui.add(egui::Slider::new(&mut s.intensity, 0.0..=2.0).text("Intensity"));
                ui.add(egui::Slider::new(&mut s.max_steps, 8..=128).text("Max steps"));
                ui.add(egui::Slider::new(&mut s.thickness, 0.01..=3.0).text("Thickness"));
                ui.add(egui::Slider::new(&mut s.max_distance, 1.0..=200.0).text("Max distance"));
                ui.add(
                    egui::Slider::new(&mut s.roughness_cutoff, 0.0..=1.0).text("Roughness cutoff"),
                );
                ui.add(egui::Slider::new(&mut s.edge_fade, 0.0..=0.5).text("Edge fade"));
            });
        });

        ui.collapsing("Depth of field", |ui| {
            ui.checkbox(&mut self.dof_enabled, "Enabled");
            ui.add_enabled_ui(self.dof_enabled, |ui| {
                let s = &mut self.dof;
                dof_mode_combo(ui, &mut s.mode);
                ui.add(
                    egui::Slider::new(&mut s.focal_distance, 0.1..=100.0)
                        .text("Focal distance")
                        .logarithmic(true),
                );
                ui.add(
                    egui::Slider::new(&mut s.aperture_f_stops, 0.05..=16.0)
                        .text("Aperture (f-stops)")
                        .logarithmic(true),
                );
                ui.add(
                    egui::Slider::new(&mut s.max_coc_diameter, 4.0..=96.0).text("Max blur (px)"),
                );
                ui.add(egui::Slider::new(&mut s.num_taps, 8..=96).text("Gather taps"));
            });
        });
    }

    pub(super) fn path_tracer_section(&mut self, ui: &mut egui::Ui) {
        egui::CollapsingHeader::new("Path tracer")
            .default_open(true)
            .show(ui, |ui| {
                ui.add(egui::Slider::new(&mut self.rt.max_bounces, 1..=32).text("Max bounces"));
                ui.add(
                    egui::Slider::new(&mut self.rt.samples_per_frame, 1..=64)
                        .text("Samples / frame"),
                );

                ui.checkbox(&mut self.rt.denoise, "Denoise");
                ui.add_enabled(
                    self.rt.denoise,
                    egui::Slider::new(&mut self.rt.denoise_iterations, 1..=10)
                        .text("Denoise iterations"),
                );

                ui.add(
                    egui::Slider::new(&mut self.rt.interactive_scale, 0.05..=1.0)
                        .text("Interactive scale"),
                );

                // Depth of field is shared with the rasterizer — edit it in the
                // global "Depth of field" section above; the path tracer mirrors it.

                ui.collapsing("Environment", |ui| {
                    ui.add(
                        egui::Slider::new(&mut self.rt.env_rotation_deg, -180.0..=180.0)
                            .text("Rotation°"),
                    );
                    ui.add(
                        egui::Slider::new(&mut self.rt.env_intensity, 0.0..=8.0).text("Intensity"),
                    );
                    ui.horizontal(|ui| {
                        ui.label("HDRI");
                        ui.text_edit_singleline(&mut self.env_path);
                    });
                    ui.horizontal(|ui| {
                        // Applied against the live path tracer after the UI runs
                        // (see `draw_inspector`).
                        if ui.button("Load").clicked() {
                            self.env_load_requested = true;
                        }
                        if ui.button("Clear").clicked() {
                            self.env_clear_requested = true;
                        }
                    });
                    if !self.env_status.is_empty() {
                        ui.label(&self.env_status);
                    }
                });
            });
    }
}