Files
renderdoc/docs/python_api/index.rst
T
2017-12-22 14:41:43 +00:00

11 lines
727 B
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
Python API
==========
The python API is accessible via scripting in the QRenderDoc tool. This gives access to both the base replay API that the UI is built on top of, as well as scripting ability for the UI itself and some higher level utility functionality.
It is also possible to build a standalone module of just the base API which can be loaded into python and used for scripting directly without the UI. Due to the inherent difficulty of distributing C python modules this isnt included by default in distributed builds at the time of writing, but is generated by default in source builds - ``renderdoc.py`` and ``_renderdoc.dll`` or ``_renderdoc.so`` make up this module.
.. toctree::
base/index
qrenderdoc/index