mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-08-29 18:06:37 +00:00
baldurk
5b90b75b79
* The docs now explicitly tell people how to write UI scripts, then UI extensions, with as quick a start as possible, and go into detail in later documents. Use of the python module directly is also not featured prominently as this is a rare use-case for casual scripting needs.
23 lines
889 B
ReStructuredText
23 lines
889 B
ReStructuredText
Python API
|
|
==========
|
|
|
|
RenderDoc exposes a significant amount of functionality to custom python scripting. This documentation will walk you through how to get started, showing examples of one-off scripts and permanent UI extensions.
|
|
|
|
Scripting this way can help automate or simplify common patterns you use, and personalise RenderDoc for your specific needs or wants.
|
|
|
|
RenderDoc's internal APIs are exposed directly to python, meaning any feature exposed in the UI will be accessible in some way to python as well. Many aspects of the UI itself are also accessible, and that can be extended in future by request.
|
|
|
|
It's assumed that you have a basic familiarity with python or can learn the syntax.
|
|
|
|
-----------------
|
|
|
|
.. toctree::
|
|
first_steps
|
|
ui_extensions
|
|
ide_integration
|
|
faq
|
|
examples/index
|
|
in_depth/index
|
|
python_module
|
|
renderdoc/index
|
|
qrenderdoc/index |