feat(debug): expand overlay controls and add performance CSV #1026

Merged
SakulFlee merged 1 commit from feat/debug-overlays into main 2026-11-03 20:18:49 +00:00
Owner

Summary

Debug overlays

  • Replaces the single debug-render flag with per-category settings under the F3 master toggle.
  • Bounds: Off / Spheres / Boxes / Both, with a new mesh AABB.
  • Independent frustum, light-indicator, wireframe, grid/axes, shadow-frusta, and selected-entity highlight switches.
  • Wireframe reuses each model’s existing vertex/index/instance buffers and is feature-gated on POLYGON_MODE_LINE.
  • Shadow frusta use the previous shadow pass’s slot matrices; point shadows are marked at their light position because their slot matrix is only a translation.
  • The Rendering panel exposes all controls.

Performance CSV

  • Splits PerformanceLogConfig into console and CSV switches.
  • Adds PerformanceCsvRecorder, writing Logs/performance.csv through FileManager with one row per timing window.
  • CSV columns cover elapsed time, FPS, frame delta, every timing stage, and cache/creation counters.
  • Adds the CSV toggle and path to the Performance panel.
  • Enables iOS Documents file sharing in generated projects.

Retrieval notes

  • Desktop: Logs/performance.csv under the working directory.
  • iOS: Documents directory, now exposed to Finder/Files for newly generated projects.
  • Android: app-internal storage; debug builds can use adb pull, release retrieval still needs a native share/save flow.
  • File writing itself is cross-platform; native mobile export UI is the remaining follow-up.

Validation

  • cargo check and clippy with -D warnings on affected crates and template_all_in_one.
  • cargo test --lib for orbital_mesh, orbital_ecs_bridge, orbital_app, orbital_debug_ui, orbital_debug_render.
  • New tests for AABB, debug defaults/categories, CSV formatting, and the CSV timing window.
## Summary ### Debug overlays - Replaces the single debug-render flag with per-category settings under the F3 master toggle. - Bounds: Off / Spheres / Boxes / Both, with a new mesh AABB. - Independent frustum, light-indicator, wireframe, grid/axes, shadow-frusta, and selected-entity highlight switches. - Wireframe reuses each model’s existing vertex/index/instance buffers and is feature-gated on `POLYGON_MODE_LINE`. - Shadow frusta use the previous shadow pass’s slot matrices; point shadows are marked at their light position because their slot matrix is only a translation. - The Rendering panel exposes all controls. ### Performance CSV - Splits `PerformanceLogConfig` into console and CSV switches. - Adds `PerformanceCsvRecorder`, writing `Logs/performance.csv` through `FileManager` with one row per timing window. - CSV columns cover elapsed time, FPS, frame delta, every timing stage, and cache/creation counters. - Adds the CSV toggle and path to the Performance panel. - Enables iOS Documents file sharing in generated projects. ## Retrieval notes - Desktop: `Logs/performance.csv` under the working directory. - iOS: Documents directory, now exposed to Finder/Files for newly generated projects. - Android: app-internal storage; debug builds can use `adb pull`, release retrieval still needs a native share/save flow. - File writing itself is cross-platform; native mobile export UI is the remaining follow-up. ## Validation - `cargo check` and clippy with `-D warnings` on affected crates and `template_all_in_one`. - `cargo test --lib` for `orbital_mesh`, `orbital_ecs_bridge`, `orbital_app`, `orbital_debug_ui`, `orbital_debug_render`. - New tests for AABB, debug defaults/categories, CSV formatting, and the CSV timing window.
feat(debug): expand overlay controls and add performance CSV
All checks were successful
Lint / lint (pull_request) Successful in 7m30s
Templates / templates (pull_request) Successful in 9m18s
PR / test (pull_request) Successful in 20m53s
b13c5dff52

Smart test results

Result: PASS

Scope: full workspace

Reason: workspace-level change: Cargo.lock

Elapsed: 20m 9s

Workflow run

Overall: 494 tests, 484 passed, 0 failed, 10 skipped

Nextest: 483 tests, 483 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.93s
orbital_2d 29 29 0 0 0/1 0.34s
orbital_app 11 11 0 0 0/1 0.16s
orbital_billboard 6 6 0 0 - 0.31s
orbital_camera 8 8 0 0 - 0.09s
orbital_core 2 2 0 0 - 0.03s
orbital_debug_render 2 2 0 0 0/1 0.03s
orbital_debug_ui 49 49 0 0 0/1 0.79s
orbital_ecs 114 114 0 0 0/2 1.71s
orbital_ecs_bridge 44 44 0 0 - 0.53s
orbital_file_manager 5 5 0 0 - 0.08s
orbital_iced 25 25 0 0 - 0.41s
orbital_importer_gltf 14 14 0 0 - 0.31s
orbital_input 11 11 0 0 - 0.14s
orbital_light 6 6 0 0 - 0.09s
orbital_macros 0 0 0 0 0/1 0.00s
orbital_material_shader 2 2 0 0 - 0.03s
orbital_math 4 4 0 0 - 0.06s
orbital_mesh 2 2 0 0 - 0.03s
orbital_procgeo 2 2 0 0 - 0.03s
orbital_render_graph 6 6 0 0 - 0.07s
orbital_renderer 21 21 0 0 - 0.40s
orbital_resources 29 29 0 0 - 0.47s
orbital_shader_core 0 0 0 0 1/1 0.00s
orbital_shader_pbr 4 4 0 0 - 0.06s
orbital_shader_preprocessor 12 12 0 0 - 0.26s
orbital_shadow 3 3 0 0 - 0.08s
orbital_text 14 14 0 0 0/1 0.66s
orbital_texture 11 11 0 0 - 0.13s
orbital_touch_ui 1 1 0 0 0/1 0.02s
orbital_ui 32 32 0 0 0/1 0.39s
orbital_world_environment 13 13 0 0 - 0.19s
pie showData
    title Nextest outcomes
    "Passed" : 483
pie showData
    title Doctest outcomes
    "Passed" : 1
    "Skipped" : 10
xychart-beta
    title "Slowest crates (nextest seconds)"
    x-axis ["orbital_ecs", "orbital", "orbital_debug_ui", "orbital_text", "orbital_ecs_bridge", "orbital_resources", "orbital_iced", "orbital_renderer"]
    y-axis "Seconds" 0 --> 1.8
    bar [1.71, 0.93, 0.79, 0.66, 0.53, 0.47, 0.41, 0.40]
<!-- orbital-ci-test-results --> ## Smart test results **Result:** PASS **Scope:** full workspace **Reason:** workspace-level change: Cargo.lock **Elapsed:** 20m 9s [Workflow run](https://forgejo.sakul-flee.de/SakulFlee/Orbital/actions/runs/1024) **Overall:** 494 tests, 484 passed, 0 failed, 10 skipped **Nextest:** 483 tests, 483 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.93s | | orbital_2d | 29 | 29 | 0 | 0 | 0/1 | 0.34s | | orbital_app | 11 | 11 | 0 | 0 | 0/1 | 0.16s | | orbital_billboard | 6 | 6 | 0 | 0 | - | 0.31s | | orbital_camera | 8 | 8 | 0 | 0 | - | 0.09s | | orbital_core | 2 | 2 | 0 | 0 | - | 0.03s | | orbital_debug_render | 2 | 2 | 0 | 0 | 0/1 | 0.03s | | orbital_debug_ui | 49 | 49 | 0 | 0 | 0/1 | 0.79s | | orbital_ecs | 114 | 114 | 0 | 0 | 0/2 | 1.71s | | orbital_ecs_bridge | 44 | 44 | 0 | 0 | - | 0.53s | | orbital_file_manager | 5 | 5 | 0 | 0 | - | 0.08s | | orbital_iced | 25 | 25 | 0 | 0 | - | 0.41s | | orbital_importer_gltf | 14 | 14 | 0 | 0 | - | 0.31s | | orbital_input | 11 | 11 | 0 | 0 | - | 0.14s | | orbital_light | 6 | 6 | 0 | 0 | - | 0.09s | | orbital_macros | 0 | 0 | 0 | 0 | 0/1 | 0.00s | | orbital_material_shader | 2 | 2 | 0 | 0 | - | 0.03s | | orbital_math | 4 | 4 | 0 | 0 | - | 0.06s | | orbital_mesh | 2 | 2 | 0 | 0 | - | 0.03s | | orbital_procgeo | 2 | 2 | 0 | 0 | - | 0.03s | | orbital_render_graph | 6 | 6 | 0 | 0 | - | 0.07s | | orbital_renderer | 21 | 21 | 0 | 0 | - | 0.40s | | orbital_resources | 29 | 29 | 0 | 0 | - | 0.47s | | orbital_shader_core | 0 | 0 | 0 | 0 | 1/1 | 0.00s | | orbital_shader_pbr | 4 | 4 | 0 | 0 | - | 0.06s | | orbital_shader_preprocessor | 12 | 12 | 0 | 0 | - | 0.26s | | orbital_shadow | 3 | 3 | 0 | 0 | - | 0.08s | | orbital_text | 14 | 14 | 0 | 0 | 0/1 | 0.66s | | orbital_texture | 11 | 11 | 0 | 0 | - | 0.13s | | orbital_touch_ui | 1 | 1 | 0 | 0 | 0/1 | 0.02s | | orbital_ui | 32 | 32 | 0 | 0 | 0/1 | 0.39s | | orbital_world_environment | 13 | 13 | 0 | 0 | - | 0.19s | ```mermaid pie showData title Nextest outcomes "Passed" : 483 ``` ```mermaid pie showData title Doctest outcomes "Passed" : 1 "Skipped" : 10 ``` ```mermaid xychart-beta title "Slowest crates (nextest seconds)" x-axis ["orbital_ecs", "orbital", "orbital_debug_ui", "orbital_text", "orbital_ecs_bridge", "orbital_resources", "orbital_iced", "orbital_renderer"] y-axis "Seconds" 0 --> 1.8 bar [1.71, 0.93, 0.79, 0.66, 0.53, 0.47, 0.41, 0.40] ```
SakulFlee referenced this pull request from a commit 2026-11-03 20:18:50 +00:00
Sign in to join this conversation.
No description provided.