RenderDoc Graphics Debugger

RenderDoc Tutorial for Windows

  • If you encounter a graphics bug or you would like to analyze how inexor-vulkan-renderer-example works, you can run it easily in RenderDoc by following these steps on Windows:

STEP 1: Download, install, and open RenderDoc:

../../_images/renderdoc-win-1.png

STEP 2: Build inexor-vulkan-renderer-example in Microsoft Visual Studio.

STEP 3: In RenderDoc, go to “Launch Application” (or press CTRL+N).

../../_images/renderdoc-win-2.png

This tab will open in RenderDoc:

../../_images/renderdoc-win-3.png

STEP 4: Specify the path to the inexor-vulkan-renderer-example executable and also the working directory. If you have several gpus and you would like to use a certain one, specify the --gpu <index> command line argument in the input field in RenderDoc. See also: Command Line Arguments and Automatic GPU Selection.

Note

Make sure the working directory is really set correctly because otherwise the inexor-vulkan-renderer-example will crash on start!

../../_images/renderdoc-win-4.png

STEP 5: Click “Launch”. You will get a warning from Windows Firewall because RenderDoc is injecting itself into the process for debugging. The application is now running. Press F12 to collect a so called capture of the screen. You can collect as many captures as you like.

../../_images/renderdoc-win-5.png

STEP 6: Close the executable and inspect the captures in RenderDoc.

../../_images/renderdoc-win-6.png