Skip to content

Conversation

Calinou
Copy link
Member

@Calinou Calinou commented Sep 2, 2025

This documentation is aimed at new and returning rendering contributors (as well as users wishing to get more information than with Godot's own visual profiler). It aims to describe basic usage of GPU debugging/profiling tools on Godot projects.

TODO

  • Document how to make use of rendering markers (such as Render Sky) in RenderDoc. Starting Godot with --verbose doesn't seem to suffice for Vulkan on Linux at least (although it works on Windows in NSight).
    • If you can figure it out, let me know.
  • Document how to access shader sources in RenderDoc and NSight. Using --generate-spirv-debug-info currently doesn't work due to an engine bug.
  • Document Radeon GPU Profiler in graphics profiling page.
  • Document Radeon Memory Visualizer in graphics profiling page.

@Calinou Calinou added content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features topic:rendering area:engine details Issues and PRs related to the Engine Details section of the documentation labels Sep 2, 2025
@Calinou Calinou force-pushed the add-graphics-debugging-profiling branch 2 times, most recently from 6e9e998 to a0c161d Compare September 2, 2025 17:15
@Ivorforce
Copy link
Member

Needs rebase after #11188.

@Calinou Calinou force-pushed the add-graphics-debugging-profiling branch 2 times, most recently from 054a1b6 to 908acbd Compare September 13, 2025 21:59
TODO:

- Document how to make use of markers in RenderDoc.
  Using `--verbose` doesn't seem to suffice for Vulkan on Linux at least
  (although it works on Windows in NSight).
- Document how to access shader sources in RenderDoc.
  Using `--generate-spirv-debug-info` currently doesn't work due to an engine bug.
- Document Radeon GPU profiling in graphics profiling page.
- Document Radeon Memory Visualizer in graphics profiling page.
@Calinou Calinou force-pushed the add-graphics-debugging-profiling branch from 908acbd to 47a875f Compare September 14, 2025 01:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:engine details Issues and PRs related to the Engine Details section of the documentation content:new page Issues and PRs related to creation of new documentation pages for new or undocumented features topic:rendering
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants