RenderDoc is a stand-alone graphics debugging tool.
C++ C# C CMake Objective-C HLSL Other
Latest commit 35a30be Sep 27, 2016 @michaelrgb michaelrgb committed with Forgotten break in remap switch label.
Permalink
Failed to load latest commit information.
docs Trim down LICENSE.md to just the core RenderDoc license, link to others Sep 27, 2016
installer Add plthook for hooking libraries on linux even through DEEPBIND Sep 26, 2016
pdblocate Format code according to newly added clang-format May 22, 2016
qrenderdoc Keep modified qrenderdoc arguments around until end of execution Sep 20, 2016
renderdoc Forgotten break in remap switch label. Sep 29, 2016
renderdoccmd Handle injecting environment variable params Sep 28, 2016
renderdocshim Remove Sleep(500) with global hook - was causing process creation stalls Sep 6, 2016
renderdocui Handle injecting environment variable params Sep 28, 2016
scripts Missed references to moved scripts - grep didn't search dotfiles Sep 27, 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 Git ignore all build-*/ folders Sep 27, 2016
.travis.yml Set travis to use cmake explicitly Sep 27, 2016
CMakeLists.txt Define _RELEASE macro on Release CMake targets Sep 28, 2016
CODE_OF_CONDUCT.md Add code of conduct May 22, 2016
CONTRIBUTING.md Move compilation instructions into CONTRIBUTING.md Sep 27, 2016
LICENSE.md Trim down LICENSE.md to just the core RenderDoc license, link to others Sep 27, 2016
README.md Minor tweaks to README phrasing/organisation/links. Sep 27, 2016
renderdoc.sln Move D3D9 hooks to a separate new project, commit official DX9 headers Sep 25, 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.

If you have any questions, suggetions or problems or you can create an issue here on github, email me directly or come into IRC to discuss it.

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 ✖️ ✖️
OpenGL ES (2&3) No immediate plans ✖️ ✖️
Metal 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 UI is in progress, 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. Nightly builds are available every day from master branch here if you need it, but correspondingly may be less stable.

Documentation

The text documentation is available online for the latest stable version, as well as in renderdoc.chm in any build. It's built from restructured text with sphinx.

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.

Contributing & Development

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

I've added some notes on how to contribute, as well as where to get started looking through the code in CONTRIBUTING.md.