lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-08-30 18:35:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Expose UI extension management via context menu in project explorer

Browse Source 
* Allow reloading and viewing output from context. Also add items for viewing in
  file explorer.
This commit is contained in:
baldurk
2026-08-13 21:05:13 +01:00
parent 14e636d1a5
commit 650188f32c
3 changed files with 175 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/window/python_scripting.rst
+20 -2
View File
@@ -10,9 +10,27 @@ Overview
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.
You can open the python scripting panel from the window menu. It offers both an interactive ``REPL`` and a window that can open, edit, and run scripts & UI extensions. 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.
Examples
--------
A number of included example scripts are included for running to demonstrate use of the python APIs that RenderDoc exposes. Opening any of these example scripts will create a new temporary tab with the contents of the example script, but they will not be saved to disk.
UI extensions
-------------
UI extensions that are enumerated by RenderDoc will be listed with all python and markdown files as well as :file:`extension.json`, for editing within RenderDoc.
Right clicking on a UI extension can offer additional management options like enabling or reloading an extension, or revealing it in the file explorer.
Output
------
The output from python scripting is visible in this panel, and can either be shown from all possible sources or filtered to a particular source - e.g. only the output from the running script, or a particular UI extension.
Python documentation
--------------------
The full :doc:`python API <../python_api/index>` documentation contains a guide on how to get started with writing python scripts and UI extensions.