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