diff --git a/docs/how/how_import_export.rst b/docs/how/how_import_export.rst index d18607870..683aee587 100644 --- a/docs/how/how_import_export.rst +++ b/docs/how/how_import_export.rst @@ -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: diff --git a/docs/renderdoc.hhk b/docs/renderdoc.hhk index bcc72a1e4..95ae38626 100644 --- a/docs/renderdoc.hhk +++ b/docs/renderdoc.hhk @@ -257,7 +257,7 @@
  • - +
  • @@ -293,7 +293,7 @@
  • - +
  • @@ -415,8 +415,8 @@
  • - - + +
  • diff --git a/docs/window/index.rst b/docs/window/index.rst index b9d85c3ce..f446a7e73 100644 --- a/docs/window/index.rst +++ b/docs/window/index.rst @@ -13,7 +13,7 @@ Window reference mesh_viewer performance_counter_viewer pipeline_state - python_shell + python_scripting resource_inspector settings_window shader_messages diff --git a/docs/window/python_scripting.rst b/docs/window/python_scripting.rst new file mode 100644 index 000000000..45ee592dd --- /dev/null +++ b/docs/window/python_scripting.rst @@ -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` diff --git a/docs/window/python_shell.rst b/docs/window/python_shell.rst deleted file mode 100644 index 1a1205dd0..000000000 --- a/docs/window/python_shell.rst +++ /dev/null @@ -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`