RenderDoc is a stand-alone graphics debugging tool.
C++ C# C Objective-C HLSL GLSL Other
Permalink
Failed to load latest commit information.
docs Remove sandcastle help file builder project - switched to sphinx now Aug 26, 2016
installer Use @Marqin's include-bin program to remove xxd dependency Aug 15, 2016
pdblocate Format code according to newly added clang-format May 22, 2016
qrenderdoc Only flip uncompressed texture data out of GL when saving to disk Aug 24, 2016
renderdoc Remove use of non-portable egrep in scripts Aug 26, 2016
renderdoccmd Add command to renderdoccmd that will handle vulkan layer registration Aug 26, 2016
renderdocshim Format code according to newly added clang-format May 22, 2016
renderdocui Re-jig remote manager GUI a little for better user flow Aug 26, 2016
.appveyor.yml AppVeyor: Allow Win32 Development job to fail May 22, 2016
.clang-format Add .clang-format, but don't convert any files yet May 22, 2016
.gitattributes Initial commit of existing code. May 2, 2014
.gitignore Add new VS2015 intellisense files to .gitignore, remove sandcastle ext Jun 7, 2016
.travis.yml Travis: Re-enable clang-format checks with restored LLVM apt repo Jul 5, 2016
CMakeLists.txt Print custom lines of API support on the version string of renderdoccmd Aug 25, 2016
CODE_OF_CONDUCT.md Add code of conduct May 22, 2016
COMPILE.md Remove vim dependency from COMPILE.md Aug 19, 2016
CONTRIBUTING.md Update CONTRIBUTING.md to mention clang-format May 22, 2016
LICENSE.md Use @Marqin's include-bin program to remove xxd dependency Aug 15, 2016
Makefile Update CMake rules Mar 11, 2016
README.md Add MIT license badge Aug 1, 2016
calc_hash.sh Create 'safe' git hash script that works outside git repo. Refs #186 Feb 23, 2016
dist.sh Delete new VS2015 incremental pdb/obj files from dist folders Aug 26, 2016
hash_version.sh Create 'safe' git hash script that works outside git repo. Refs #186 Feb 23, 2016
renderdoc.sln Add initial skeleton of D3D12 support Jul 10, 2016
valgrind.supp Fix errors and leaks found by valgrind on linux replay host Jul 14, 2016

README.md

RenderDoc

Travis CI AppVeyor Coverity Scan MIT licensed

Welcome to RenderDoc - a graphics debugger, currently available for D3D11, Vulkan and OpenGL development on windows.

Quick Links:

Screenshots

Texture view Pixel history & shader debug
Mesh viewer Pipeline viewer & constants

API Support

Status Windows Linux
D3D11 Well supported, all features. ✔️ ✖️
OpenGL 3.2 core+ Well supported, most features.* ✔️ ✔️ No UI**
Vulkan Well supported, most features. ✔️ ✔️ No UI**
D3D12 In Progress. 🔃 ✖️
OpenGL Pre-3.2 No immediate plans ✖️ ✖️
D3D10 No immediate plans ✖️ ✖️
D3D9 No immediate plans ✖️ ✖️
  • D3D11 has full feature support and is stable & tested. Feature Level 11 hardware is assumed - Radeon 4000/5000+, GeForce 400+, Intel Ivy Bridge, falling back to WARP software emulation if this hardware isn't present.
  • *OpenGL is only explicitly supported for the core profile 3.2+ subset of features, check the OpenGL wiki page for details.
  • **A Qt version of the UI is planned, with some implementation notes on the wiki.

Downloads

There are binary releases available, built from the release targets. If you just want to use the program and you ended up here, this is what you want :).

It's recommended that if you're new you start with the stable builds. Beta builds are available for those who want more regular updates with the latest features and fixes, but might run into some bugs as well. Nightly builds are available every day from master branch here if you need it.

Documentation

As mentioned above there are some youtube videos showing the use of some basic features and an introduction/overview.

There is also a great presentation by @Icetigris which goes into some details of how RenderDoc can be used in real world situations: slides are up here.

License

RenderDoc is released under the MIT license, see LICENSE.md for full text as well as 3rd party library acknowledgements.

Building

Building RenderDoc is fairly straight forward. See COMPILE.md for more details.

Contributing & Development

I've added some notes on how to contribute, as well as where to get started looking through the code in CONTRIBUTING.md - also look at COMPILE.md for details on how to set up to build renderdoc.