feat(debug-ui): expose debug overlay and performance logging toggles #1024

Merged
SakulFlee merged 1 commit from feat/debug-ui-logging into main 2026-11-03 19:15:50 +00:00
Owner

Summary

  • Add a Debug overlays checkbox to the Rendering panel that mirrors the DebugModule F3 state.
  • Add a Log FPS, timings & cache counters checkbox to the Performance panel.
  • Add PerformanceLogConfig (off by default) and gate the per-second FPS, TIMING, and PERF log lines through it.
  • FrameTimings::try_log_if resets the one-second window even while disabled, so enabling logging does not dump a backlog.

Fixes #1021 and #1019.

Notes

  • The debug overlay toggle is hidden behind an explanatory message when DebugModule is not installed.
  • CSV/file capture from #1019 is not included; this change only gives the existing logging a runtime switch.

Validation

  • cargo check -p orbital_ecs_bridge -p orbital_debug_ui -p orbital_app -p template_all_in_one
  • cargo test -p orbital_ecs_bridge -p orbital_debug_ui --lib
  • cargo test -p orbital_app --lib
  • fmt/clippy on affected crates
## Summary - Add a **Debug overlays** checkbox to the Rendering panel that mirrors the `DebugModule` F3 state. - Add a **Log FPS, timings & cache counters** checkbox to the Performance panel. - Add `PerformanceLogConfig` (off by default) and gate the per-second FPS, TIMING, and PERF log lines through it. - `FrameTimings::try_log_if` resets the one-second window even while disabled, so enabling logging does not dump a backlog. Fixes #1021 and #1019. ## Notes - The debug overlay toggle is hidden behind an explanatory message when `DebugModule` is not installed. - CSV/file capture from #1019 is not included; this change only gives the existing logging a runtime switch. ## Validation - `cargo check -p orbital_ecs_bridge -p orbital_debug_ui -p orbital_app -p template_all_in_one` - `cargo test -p orbital_ecs_bridge -p orbital_debug_ui --lib` - `cargo test -p orbital_app --lib` - fmt/clippy on affected crates
feat(debug-ui): expose debug overlay and performance logging toggles
All checks were successful
Lint / lint (pull_request) Successful in 1m38s
Templates / templates (pull_request) Successful in 8m33s
PR / test (pull_request) Successful in 19m50s
c7a2756ba6

Smart test results

Result: PASS

Scope: full workspace

Reason: workspace-level change: Cargo.lock

Elapsed: 19m 4s

Workflow run

Overall: 488 tests, 478 passed, 0 failed, 10 skipped

Nextest: 477 tests, 477 passed, 0 failed, 0 skipped
Doctests: 11 tests, 1 passed, 0 failed, 10 skipped

Outcome charts are split between nextest and doctests. The timing chart covers nextest only.

Crate Nextest Passed Failed Skipped Doctests Time
orbital 1 1 0 0 - 0.77s
orbital_2d 29 29 0 0 0/1 0.17s
orbital_app 10 10 0 0 0/1 0.05s
orbital_billboard 6 6 0 0 - 0.13s
orbital_camera 8 8 0 0 - 0.05s
orbital_core 2 2 0 0 - 0.02s
orbital_debug_render 0 0 0 0 0/1 0.00s
orbital_debug_ui 49 49 0 0 0/1 0.38s
orbital_ecs 114 114 0 0 0/2 0.80s
orbital_ecs_bridge 43 43 0 0 - 0.29s
orbital_file_manager 5 5 0 0 - 0.04s
orbital_iced 25 25 0 0 - 0.16s
orbital_importer_gltf 14 14 0 0 - 0.19s
orbital_input 11 11 0 0 - 0.07s
orbital_light 6 6 0 0 - 0.05s
orbital_macros 0 0 0 0 0/1 0.00s
orbital_material_shader 2 2 0 0 - 0.02s
orbital_math 4 4 0 0 - 0.04s
orbital_procgeo 2 2 0 0 - 0.02s
orbital_render_graph 6 6 0 0 - 0.05s
orbital_renderer 21 21 0 0 - 0.30s
orbital_resources 29 29 0 0 - 0.33s
orbital_shader_core 0 0 0 0 1/1 0.00s
orbital_shader_pbr 4 4 0 0 - 0.03s
orbital_shader_preprocessor 12 12 0 0 - 0.08s
orbital_shadow 3 3 0 0 - 0.02s
orbital_text 14 14 0 0 0/1 0.39s
orbital_texture 11 11 0 0 - 0.08s
orbital_touch_ui 1 1 0 0 0/1 0.01s
orbital_ui 32 32 0 0 0/1 0.22s
orbital_world_environment 13 13 0 0 - 0.09s
pie showData
    title Nextest outcomes
    "Passed" : 477
pie showData
    title Doctest outcomes
    "Passed" : 1
    "Skipped" : 10
xychart-beta
    title "Slowest crates (nextest seconds)"
    x-axis ["orbital_ecs", "orbital", "orbital_text", "orbital_debug_ui", "orbital_resources", "orbital_renderer", "orbital_ecs_bridge", "orbital_ui"]
    y-axis "Seconds" 0 --> 1
    bar [0.80, 0.77, 0.39, 0.38, 0.33, 0.30, 0.29, 0.22]
<!-- orbital-ci-test-results --> ## Smart test results **Result:** PASS **Scope:** full workspace **Reason:** workspace-level change: Cargo.lock **Elapsed:** 19m 4s [Workflow run](https://forgejo.sakul-flee.de/SakulFlee/Orbital/actions/runs/1019) **Overall:** 488 tests, 478 passed, 0 failed, 10 skipped **Nextest:** 477 tests, 477 passed, 0 failed, 0 skipped **Doctests:** 11 tests, 1 passed, 0 failed, 10 skipped _Outcome charts are split between nextest and doctests. The timing chart covers nextest only._ | Crate | Nextest | Passed | Failed | Skipped | Doctests | Time | | --- | ---: | ---: | ---: | ---: | ---: | ---: | | orbital | 1 | 1 | 0 | 0 | - | 0.77s | | orbital_2d | 29 | 29 | 0 | 0 | 0/1 | 0.17s | | orbital_app | 10 | 10 | 0 | 0 | 0/1 | 0.05s | | orbital_billboard | 6 | 6 | 0 | 0 | - | 0.13s | | orbital_camera | 8 | 8 | 0 | 0 | - | 0.05s | | orbital_core | 2 | 2 | 0 | 0 | - | 0.02s | | orbital_debug_render | 0 | 0 | 0 | 0 | 0/1 | 0.00s | | orbital_debug_ui | 49 | 49 | 0 | 0 | 0/1 | 0.38s | | orbital_ecs | 114 | 114 | 0 | 0 | 0/2 | 0.80s | | orbital_ecs_bridge | 43 | 43 | 0 | 0 | - | 0.29s | | orbital_file_manager | 5 | 5 | 0 | 0 | - | 0.04s | | orbital_iced | 25 | 25 | 0 | 0 | - | 0.16s | | orbital_importer_gltf | 14 | 14 | 0 | 0 | - | 0.19s | | orbital_input | 11 | 11 | 0 | 0 | - | 0.07s | | orbital_light | 6 | 6 | 0 | 0 | - | 0.05s | | orbital_macros | 0 | 0 | 0 | 0 | 0/1 | 0.00s | | orbital_material_shader | 2 | 2 | 0 | 0 | - | 0.02s | | orbital_math | 4 | 4 | 0 | 0 | - | 0.04s | | orbital_procgeo | 2 | 2 | 0 | 0 | - | 0.02s | | orbital_render_graph | 6 | 6 | 0 | 0 | - | 0.05s | | orbital_renderer | 21 | 21 | 0 | 0 | - | 0.30s | | orbital_resources | 29 | 29 | 0 | 0 | - | 0.33s | | orbital_shader_core | 0 | 0 | 0 | 0 | 1/1 | 0.00s | | orbital_shader_pbr | 4 | 4 | 0 | 0 | - | 0.03s | | orbital_shader_preprocessor | 12 | 12 | 0 | 0 | - | 0.08s | | orbital_shadow | 3 | 3 | 0 | 0 | - | 0.02s | | orbital_text | 14 | 14 | 0 | 0 | 0/1 | 0.39s | | orbital_texture | 11 | 11 | 0 | 0 | - | 0.08s | | orbital_touch_ui | 1 | 1 | 0 | 0 | 0/1 | 0.01s | | orbital_ui | 32 | 32 | 0 | 0 | 0/1 | 0.22s | | orbital_world_environment | 13 | 13 | 0 | 0 | - | 0.09s | ```mermaid pie showData title Nextest outcomes "Passed" : 477 ``` ```mermaid pie showData title Doctest outcomes "Passed" : 1 "Skipped" : 10 ``` ```mermaid xychart-beta title "Slowest crates (nextest seconds)" x-axis ["orbital_ecs", "orbital", "orbital_text", "orbital_debug_ui", "orbital_resources", "orbital_renderer", "orbital_ecs_bridge", "orbital_ui"] y-axis "Seconds" 0 --> 1 bar [0.80, 0.77, 0.39, 0.38, 0.33, 0.30, 0.29, 0.22] ```
SakulFlee referenced this pull request from a commit 2026-11-03 19:15:51 +00:00
Sign in to join this conversation.
No description provided.