lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-05-06 01:50:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for v1.0

Browse Source 
* Screenshots and icons are updated to latest style
* Many out-dated references and mentions of support updated.
* Documentation added for new windows like resource inspector and
  performance counter viewer, as well as new features like saving
  bookmarks, resource names.
* Added documentation for Android support as well as OpenGL ES support.
This commit is contained in:
baldurk
2018-02-25 23:27:13 +00:00
parent 1cd8559d0c
commit 933c00985d
175 changed files with 1187 additions and 711 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/window/python_shell.rst
+13 -3
View File
@@ -1,14 +1,24 @@
Python Shell
============
The python shell allows a limited form of scripting for RenderDoc, including the ability to run simple scripts over the whole dataset in ways not easy to do in the UI.
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.
Currently the support is fairly bare bones, and typically you will need some understanding of the code to use the scripting support well. The :code:`pyrenderdoc` object corresponds to the :code:`Core` object type used throughout the UI, and the :code:`renderdoc` python module corresponds to the :code:`renderdoc` namespace in C# and it provides a jumping off point for most operations from there.
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.
So while not particularly friendly to discovery, you can use this to perform an automated iteration over e.g. all events or all textures for something of interest.
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`