Rewrite python docs & onboarding to be more opinionated

* The docs now explicitly tell people how to write UI scripts, then UI extensions, with as quick a start as possible, and go into detail in later documents. Use of the python module directly is also not featured prominently as this is a rare use-case for casual scripting needs.
2026-08-30 10:25:43 +00:00 · 2026-08-13 21:05:12 +01:00
parent e032466be2
commit 5b90b75b79
18 changed files with 627 additions and 0 deletions
@@ -0,0 +1,78 @@
+import renderdoc as rd
+import qrenderdoc as qrd
+from typing import List
+
+
+def check_draw(best_size: int, action: rd.ActionDescription):
+    if action.flags & rd.ActionFlags.Drawcall:
+        size = action.numIndices * action.numInstances
+        if size > best_size:
+            return action.eventId, size
+    return 0, 0
+
+
+def find_largest_draw(best_size: int, actions: List[rd.ActionDescription]):
+    ret = 0
+    for action in actions:
+        result = check_draw(best_size, action)
+
+        if result[0] == 0:
+            result = find_largest_draw(best_size, action.children)
+
+        if result[0] > 0:
+            ret, best_size = result
+
+    return ret, best_size
+
+
+def open_window(pyrenderdoc: qrd.CaptureContext, data):
+    mqt = pyrenderdoc.Extensions().GetMiniQtHelper()
+
+    top = mqt.CreateToplevelWidget("Scavenger Hunt")
+
+    group = mqt.CreateGroupBox(False)
+    mqt.SetWidgetText(group, "Exciting scavenger hunt!")
+
+    label = mqt.CreateLabel()
+    mqt.SetWidgetText(label, "Guess the biggest draw!")
+
+    eid, size = find_largest_draw(0, pyrenderdoc.CurRootActions())
+
+    def do_guess(pyrenderdoc, widget, text):
+        print(f"Spoiler: largest draw is {eid}, it drew {size} indices")
+
+        if pyrenderdoc.CurEvent() == eid:
+            msg = "You found it!"
+        elif pyrenderdoc.CurEvent() < eid:
+            msg = "The largest draw is later in the capture..."
+        else:
+            msg = "The largest draw is earlier in the capture..."
+
+        mqt.SetWidgetText(label, f"Guess the biggest draw!\n\n{msg}")
+
+    button = mqt.CreateButton(do_guess)
+    mqt.SetWidgetText(button, "Guess")
+
+    if eid == 0:
+        mqt.SetWidgetText(
+            label,
+            "You don't have a capture with drawcalls loaded :(.\n"
+            "Re-open this window after opening a capture!",
+        )
+        mqt.SetWidgetEnabled(button, False)
+
+    mqt.AddWidget(top, group)
+    mqt.AddWidget(group, label)
+    mqt.AddWidget(group, button)
+
+    pyrenderdoc.AddDockWindow(
+        top, qrd.DockReference.TopOf, pyrenderdoc.GetEventBrowser().Widget(), 0.2
+    )
+
+
+def register(version, pyrenderdoc: qrd.CaptureContext):
+    print(f"Tutorial extension registered in RenderDoc {version}")
+
+    pyrenderdoc.Extensions().RegisterPanelMenu(
+        qrd.PanelMenu.EventBrowser, ["Tutorial", "Scavenger Hunt"], open_window
+    )