RenderDoc exposes APIs to python at two different levels:
The base replay API, the
renderdocmodule, which provides low level access to handling capture files, replaying frames and obtaining analysis information. The UI is built entirely on top of this API, so it provides the full power of RenderDoc, however is does not have many convenience abstractions.
The RenderDoc UI API, the
qrenderdocmodule, which exposes the abstractions and panels within the UI tool.
Within RenderDoc - when either running scripts on the command line, or via the Python Shell - both modules are pre-imported and available automatically.
It is also possible to build the
renderdoc module standalone which can be loaded into python and used for scripting directly without the UI program. Due to the inherent difficulty of distributing C python modules this isn’t included by default in distributed builds at the time of writing, but is generated by default in source builds -
renderdoc.pyd on windows or
renderdoc.so elsewhere. Use of this module is strictly a convenience and is not supported.
Due to Android being inherently an unstable and unreliable platform, using the python scripting on Android devices is not recommended or supported. It may work, but you’ll be on your own with any problems encountered as they are too likely to be caused by problems on Android.
You must use exactly the same version of python to load the module as was used to build it. On Windows the version of python that comes with the repository and is used by default is python 3.6. This can be overridden at build time by setting the environment variable RENDERDOC_PYTHON_PREFIX32 or RENDERDOC_PYTHON_PREFIX64 to the path of a compatible python install. NOTE that the embedded zip distribution doesn’t come with python38.lib which is necessary, so you must regenerate it or get it from the installed python. The installed python folder doesn’t come with a python38.zip standard library bundle which you’d need to create or get from the embedded zip distribution.
RenderDoc only supports Python 3.4+, Python 2 is not supported.
This documentation contains information on getting started with the scripting, as well as tutorials and examples outline how to perform simple tasks.
Each example has a simple motivating goal and shows how to achieve it using the interfaces provided. They will not show every possible use of the interfaces, but instead give a starting point to build on. Further information about exactly what functionality is available can be found in the API reference below as well as using the python built-in
- Getting Started (python)
- Getting Started (RenderDoc UI)
- Python development environment
- Writing UI extensions
- Basic Interfaces
- renderdoc Examples
- qrenderdoc examples
- renderdoc API Reference
- qrenderdoc API Reference