Track: audit and modernize the v1.6 debug UI #971

Closed
opened 2026-10-29 16:43:39 +00:00 by SakulFlee · 1 comment
Owner

Summary

Audit and modernize the in-game debug UI for v1.6 now that the renderer has moved to the graph-driven hybrid path.

The current orbital_debug_ui panels are still useful, but the renderer surface has changed enough that the UI is missing live controls and some existing information may no longer describe the active path accurately.

Current panels

  • Performance: FPS, frame time, per-stage timings, graphs.
  • ECS: entity/component tree and editable fields.
  • Console: log buffer and level filter.
  • Rendering: AA mode, SMAA quality, active-camera projection, volumetrics.

Audit goals

  • Verify every control and displayed value against the current renderer path.
  • Add controls for settings that are currently only available through AppSettings, module setup, or direct Renderer access.
  • Remove or relabel values that no longer match the graph/deferred/forward/transparency/volumetrics pipeline.
  • Make the panel usable for tuning: grouped sections, current values, reset, and clear labels.

Missing or candidate controls

  • Deferred vs forward opaque rendering.
  • Shadow enable/disable, shadow map resolution, cascade count, and stagger budget.
  • Tonemap exposure.
  • Environment/IBL selection and intensity, once volumetrics can consume it.
  • Light culling / active light counts.
  • Render graph pass list and pass-level timing.
  • Texture pool usage and transient target counts.
  • Volumetric quality, step count, grid dimensions, and local-volume controls.
  • AA debug options and an obvious current-mode indicator.
  • Reset-to-default and copy/save current settings.

Known issues to fix as part of the audit

  • The projection pick_list does not open inside FloatingPanel; FloatingPanel::overlay currently returns an empty overlay list. Any future dropdown in a debug panel will need overlay forwarding.
  • SMAA quality should only be shown when SMAA is selected, or should clearly indicate that it is inactive for FXAA/Off.
  • Volumetric slider labels need explanations: base density, height density, scattering, extinction, anisotropy, and froxel quality currently look like variations of the same control.
  • A "froxel quality" change causes a large visual change; the UI should make it clear that this changes grid resolution and integration steps, and the renderer should be validated for stable output across tiers.
  • Consider a dedicated AA test pattern/debug view so toggles can be verified visually.

Acceptance criteria

  • Every rendering control has a verified effect and a visible current value.
  • No stale renderer names or removed paths remain in the panels.
  • Dropdowns and overlays work inside floating debug panels.
  • The panel remains usable at 1280x720 and scales to larger windows.
  • Controls that are unavailable or inactive are disabled or visually marked.
  • Existing noop/unit tests remain green; any new widget logic that can be tested headlessly is covered.
  • #970 — rendering controls panel
  • #969 — anti-aliasing / TAA / SMAA tracking
  • #781 — renderer overhaul umbrella
## Summary Audit and modernize the in-game debug UI for v1.6 now that the renderer has moved to the graph-driven hybrid path. The current `orbital_debug_ui` panels are still useful, but the renderer surface has changed enough that the UI is missing live controls and some existing information may no longer describe the active path accurately. ## Current panels - Performance: FPS, frame time, per-stage timings, graphs. - ECS: entity/component tree and editable fields. - Console: log buffer and level filter. - Rendering: AA mode, SMAA quality, active-camera projection, volumetrics. ## Audit goals - Verify every control and displayed value against the current renderer path. - Add controls for settings that are currently only available through `AppSettings`, module setup, or direct `Renderer` access. - Remove or relabel values that no longer match the graph/deferred/forward/transparency/volumetrics pipeline. - Make the panel usable for tuning: grouped sections, current values, reset, and clear labels. ## Missing or candidate controls - Deferred vs forward opaque rendering. - Shadow enable/disable, shadow map resolution, cascade count, and stagger budget. - Tonemap exposure. - Environment/IBL selection and intensity, once volumetrics can consume it. - Light culling / active light counts. - Render graph pass list and pass-level timing. - Texture pool usage and transient target counts. - Volumetric quality, step count, grid dimensions, and local-volume controls. - AA debug options and an obvious current-mode indicator. - Reset-to-default and copy/save current settings. ## Known issues to fix as part of the audit - The projection `pick_list` does not open inside `FloatingPanel`; `FloatingPanel::overlay` currently returns an empty overlay list. Any future dropdown in a debug panel will need overlay forwarding. - SMAA quality should only be shown when SMAA is selected, or should clearly indicate that it is inactive for FXAA/Off. - Volumetric slider labels need explanations: base density, height density, scattering, extinction, anisotropy, and froxel quality currently look like variations of the same control. - A "froxel quality" change causes a large visual change; the UI should make it clear that this changes grid resolution and integration steps, and the renderer should be validated for stable output across tiers. - Consider a dedicated AA test pattern/debug view so toggles can be verified visually. ## Acceptance criteria - Every rendering control has a verified effect and a visible current value. - No stale renderer names or removed paths remain in the panels. - Dropdowns and overlays work inside floating debug panels. - The panel remains usable at 1280x720 and scales to larger windows. - Controls that are unavailable or inactive are disabled or visually marked. - Existing noop/unit tests remain green; any new widget logic that can be tested headlessly is covered. ## Related - #970 — rendering controls panel - #969 — anti-aliasing / TAA / SMAA tracking - #781 — renderer overhaul umbrella
Author
Owner

The audit is complete. The concrete debug-UI issues (#977, #980, #994, #996) are closed, and new findings from the verification pass are tracked as #1019, #1020, and #1021. The remaining candidate controls (shadow controls, IBL selection, render-graph/pass listing, texture-pool stats, advanced volumetric controls, reset/save, and a dedicated AA test view) are optional post-1.6 work rather than blockers for this audit. Closing this umbrella to avoid an open-ended tracking issue; reopen or file a narrower follow-up if any of those controls are needed for the release.

The audit is complete. The concrete debug-UI issues (#977, #980, #994, #996) are closed, and new findings from the verification pass are tracked as #1019, #1020, and #1021. The remaining candidate controls (shadow controls, IBL selection, render-graph/pass listing, texture-pool stats, advanced volumetric controls, reset/save, and a dedicated AA test view) are optional post-1.6 work rather than blockers for this audit. Closing this umbrella to avoid an open-ended tracking issue; reopen or file a narrower follow-up if any of those controls are needed for the release.
Sign in to join this conversation.
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
SakulFlee/Orbital#971
No description provided.