From 83a80ad9dccf30eca7f94ff357bcf43632f00023 Mon Sep 17 00:00:00 2001 From: baldurk Date: Tue, 23 Jun 2026 15:52:12 +0100 Subject: [PATCH] Add some notes to main interface docstrings of where they are obtained --- qrenderdoc/Code/Interface/QRDInterface.h | 6 +++++- renderdoc/api/replay/pipestate.h | 3 +++ renderdoc/api/replay/renderdoc_replay.h | 4 ++++ 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/qrenderdoc/Code/Interface/QRDInterface.h b/qrenderdoc/Code/Interface/QRDInterface.h index ffe46aad5..d0f1ede94 100644 --- a/qrenderdoc/Code/Interface/QRDInterface.h +++ b/qrenderdoc/Code/Interface/QRDInterface.h @@ -2272,7 +2272,11 @@ protected: DECLARE_REFLECTION_STRUCT(IRGPInterop); -DOCUMENT("The capture context that the python script is running in.") +DOCUMENT(R"( +The capture context that the python script is running in. + +Available as a ``pyrenderdoc`` global variable in any python scripts run from RenderDoc's UI. +)") struct ICaptureContext { DOCUMENT(R"(Retrieve the absolute path where a given temporary capture should be stored. diff --git a/renderdoc/api/replay/pipestate.h b/renderdoc/api/replay/pipestate.h index 16c812f24..c52fbdebf 100644 --- a/renderdoc/api/replay/pipestate.h +++ b/renderdoc/api/replay/pipestate.h @@ -38,6 +38,9 @@ available on all APIs. For more detailed or precise information without abstraction, access the specific pipeline state for the capture that's open. + +Available from :meth:`~qrenderdoc.CaptureContext.CurPipelineState` in the UI or +:meth:`~renderdoc.ReplayController.GetPipelineState` from the replay API directly. )"); struct PipeState { diff --git a/renderdoc/api/replay/renderdoc_replay.h b/renderdoc/api/replay/renderdoc_replay.h index 270e4d16d..463f79c0f 100644 --- a/renderdoc/api/replay/renderdoc_replay.h +++ b/renderdoc/api/replay/renderdoc_replay.h @@ -383,6 +383,10 @@ protected: DOCUMENT(R"(The primary interface to access the information in a capture and the current state, as well as control the replay and analysis functionality available. +Available as a blocking interface in UI scripts via +:meth:`~qrenderdoc.CaptureContext.GetBlockingController` or directly on the replay thread using +:meth:`~qrenderdoc.ReplayManager.AsyncInvoke`. + .. function:: KillCallback() Not an actual member function - the signature for any ``KillCallback`` callbacks.