Skip to content

Commit 4532d04

Browse files
committed
Remove stale documentation about python scripting
1 parent 76cfcd5 commit 4532d04

File tree

1 file changed

+1
-13
lines changed

1 file changed

+1
-13
lines changed

docs/window/python_shell.rst

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,7 @@ Overview
88

99
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.
1010

11-
Currently the support is fairly bare bones, and typically you will need some understanding of the code to use the scripting support well. The 'renderdoc' object corresponds to the Core object type used throughout the UI, and it provides a jumping off point for most operations from there.
12-
13-
Examples are:
14-
15-
* :code:`renderdoc.CurTextures` is an array of FetchTexture with all textures in the current log.
16-
* :code:`renderdoc.GetTextureViewer()` gives a handle to the texture viewer, allowing you to view a particular texture.
17-
* :code:`renderdoc.AppWindow.LoadLogfile("filename", False)` opens a given log.
18-
* :code:`renderdoc.GetDrawcall(0, 151)` will return the drawcall of EID 151. Drawcalls have next/previous/parent/children properties to allow you to step through the frame.
19-
* :code:`renderdoc.SetEventID(None, 0, 151)` browses to EID 151.
20-
11+
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.
2112

2213
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.
2314

24-
.. figure:: ../imgs/Screenshots/pythonshell.png
25-
26-
Python Shell: A simple script that looks at textures and their use in a log.

0 commit comments

Comments
 (0)