lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-08-29 09:56:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename python shell to python scripting window in docs

Browse Source
This commit is contained in:
baldurk
2026-08-13 21:05:11 +01:00
parent 1bad994e84
commit eb27bd34bf
5 changed files with 33 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/window/python_scripting.rst
+27
View File
@@ -0,0 +1,27 @@
Python Scripting
================
The python scripting panel allows the management of python scripts and extensions.
Overview
--------
.. figure:: ../imgs/Screenshots/pythonshell.png
The python shell
You can open the python scripting panel from the window menu. It offers both an interactive ``REPL`` and a window that can open and run scripts and display the output. The editor has limited auto-complete and error checking, though for complex scripts editing in an external IDE is recommended.
A number of included example scripts are included for running to demonstrate use of the python APIs that RenderDoc exposes.
The full :doc:`python API <../python_api/index>` documentation contains a guide on how to get started with writing python scripts and UI extensions.
To get started the :code:`pyrenderdoc` object corresponds to a :class:`~qrenderdoc.CaptureContext` object through which the internal API and UI windows can be obtained.
For Qt integration, if available, you can import :code:`PySide2` which provides python bindings for the Qt API.
See Also
--------
* :doc:`../python_api/index`
* :doc:`../how/how_python_extension`