Add pages on graphics debugging and profiling#11253
Add pages on graphics debugging and profiling#11253Calinou wants to merge 1 commit intogodotengine:masterfrom
Conversation
Calinou
added
content:new page
contributing/development/debugging/using_graphics_debuggers.rst
Outdated
Show resolved
Hide resolved
contributing/development/debugging/using_graphics_debuggers.rst
Outdated
Show resolved
Hide resolved
contributing/development/debugging/using_graphics_debuggers.rst
Outdated
Show resolved
Hide resolved
Calinou
force-pushed
the
add-graphics-debugging-profiling
branch
2 times, most recently
from
6e9e998 to
a0c161d
Compare
|
Needs rebase after #11188. |
Calinou
force-pushed
the
add-graphics-debugging-profiling
branch
2 times, most recently
from
054a1b6 to
908acbd
Compare
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
force-pushed
the
add-graphics-debugging-profiling
branch
from
908acbd to
47a875f
Compare
|
I think it's a great first step, should we try to get this merged as is / after rebase and leave the other TODOs for a future PR? |
| Additionally, when running Godot through a graphics debugger, you should | ||
| always run it using the ``--generate-spirv-debug-info`` | ||
| :ref:`command line argument <doc_command_line_tutorial>`. Otherwise, source-level | ||
| shader debugging won't work. |
There was a problem hiding this comment.
I think this isn't needed if users are using a debug build. So the above paragraph may also be incorrect
There was a problem hiding this comment.
I have checked the source it's not always enabled in debug builds: https://github.com/godotengine/godot/blob/c3058391d7bd1a13481c393061c164c24ec99685/drivers/vulkan/rendering_device_driver_vulkan.cpp#L566-L568
However, the option is unused in D3D12 since it's not supported there: https://github.com/godotengine/godot/blob/c3058391d7bd1a13481c393061c164c24ec99685/modules/glslang/register_types.cpp#L75-L81
When it comes to D3D12, we need to document use_pix=yes in the Compiling for Windows documentation, as it's not enabled by default, even in debug builds.
Edit: Done in #11657.
6 participants
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
Render Sky) in RenderDoc. Starting Godot with--verbosedoesn't seem to suffice for Vulkan on Linux at least (although it works on Windows in NSight).--generate-spirv-debug-infocurrently doesn't work due to an engine bug.