baldurk 62c840dca2 Fix a problem with different mem requirements between capture and replay
* If the usage flags on an image are different then the ICD might return
  different memory requirements at replay time, which are no longer
  respected by the offset/alignment that the application chose at
  capture time.
* The real solution is to abstract the requirements and return our own
  set of pessimistic requirements that encompass most hardware. For the
  moment as a simpler solution we just add the same usage flags for both
  capture and replay, if a flag is needed for either.
2017-02-03 10:25:20 +00:00
2017-01-25 20:53:03 +00:00

RenderDoc

Travis CI AppVeyor Coverity Scan MIT licensed

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

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

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.* ✔️ ✔️ WIP UI**
Vulkan Well supported, most features. ✔️ ✔️ WIP UI**
D3D12 Well supported, most features. ✔️ ✖️
OpenGL Compatibility, GLES No immediate plans ✖️ ✖️
D3D9 & 10 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 and a TODO list of remaining work.

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.

Languages
C++ 79.3%
C 16.6%
Python 2.8%
Objective-C++ 0.4%
HLSL 0.2%
Other 0.6%