lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-08-23 23:16:31 +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/how/how_import_export.rst
+1 -1
View File
@@ -8,7 +8,7 @@ The data is known internally as *structured data* and it can be examined in memo
In-capture access
-----------------
The structured data is available through the :doc:`python scripting <../window/python_shell>`. As an example, we look at one function call from a capture:
The structured data is available through the :doc:`python scripting <../window/python_scripting>`. As an example, we look at one function call from a capture:
First we obtain the :class:`~renderdoc.APIEvent` that we want to examine, as the last event in an action's list of events and find the chunk index it refers to:
docs/renderdoc.hhk
+4 -4
View File
@@ -257,7 +257,7 @@
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Python Scripting">
<param name="Local" value="window/python_shell.html">
<param name="Local" value="window/python_scripting.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Quick Start">
@@ -293,7 +293,7 @@
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Scripting the UI">
<param name="Local" value="window/python_shell.html">
<param name="Local" value="window/python_scripting.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Settings">
@@ -415,8 +415,8 @@
<param name="Local" value="window/pipeline_state.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Python Shell">
<param name="Local" value="window/python_shell.html">
<param name="Keyword" value="Python Scripting">
<param name="Local" value="window/python_scripting.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Raw Buffer Viewer">
docs/window/index.rst
+1 -1
View File
@@ -13,7 +13,7 @@ Window reference
mesh_viewer
performance_counter_viewer
pipeline_state
python_shell
python_scripting
resource_inspector
settings_window
shader_messages
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`
docs/window/python_shell.rst
-25
View File
@@ -1,25 +0,0 @@
Python Shell
============
The python shell allows flexible of RenderDoc, including the ability to run simple scripts over the whole dataset in ways not easy to do in the UI. Depending on the build-time configuration the Qt UI itself may also be exposed to python for customisation.
Overview
--------
.. figure:: ../imgs/Screenshots/pythonshell.png
The python shell
You can open the python shell from the window menu. It offers both an interactive shell and a window that can open and run scripts and display the output.
The full :doc:`python API reference <../python_api/index>` contains the explicit detail of the whole API, but you can also use the ``help()`` command to obtain information about a particular object or function call.
To get started the :code:`pyrenderdoc` object corresponds to a :py: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`