lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-05-04 17:10:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

On main UI interface classes add a back-link at where they are retrieved

Browse Source 
* E.g. this documents on the ExtensionManager that it's retrieved from
  CaptureContext.Extensions()
This commit is contained in:
baldurk
2024-12-13 15:23:28 +00:00
parent 0880f7b0be
commit 7d6ecd1b3d
3 changed files with 83 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
qrenderdoc/Code/Interface/Extensions.h
+4
View File
@@ -346,6 +346,8 @@ helper exposes a small subset of Qt via RenderDoc's python bindings.
The intention is not to allow fully flexible building of Qt panels, but to allow access to some
basic UI building tools for simple data input and display which can be used on any RenderDoc build.
This manager is retrieved by calling :meth:`ExtensionManager.GetMiniQtHelper`.
.. note::
The widget handles returned are PySide2 widgets where that is available, so this can be used to
make a basic UI and optionally customise it further with PySide2 when possible.
@@ -1030,6 +1032,8 @@ DECLARE_REFLECTION_STRUCT(IMiniQtHelper);
DOCUMENT(R"(A manager for listing available and active extensions, as well as the interface for
extensions to register hooks and additional functionality.
This manager is retrieved by calling :meth:`CaptureContext.Extensions`.
.. function:: ExtensionCallback(context, data)
Not a member function - the signature for any ``ExtensionCallback`` callbacks.
qrenderdoc/Code/Interface/PersistantConfig.h
+2
View File
@@ -651,6 +651,8 @@ struct CustomPersistentStorage
DOCUMENT(R"(A persistant config file that is automatically loaded and saved, which contains any
settings and information that needs to be preserved from one run to the next.
The config is retrieved by calling :meth:`CaptureContext.Config`.
For more information about some of these settings that are user-facing see
:ref:`the documentation for the settings window <settings-window>`.
)");
qrenderdoc/Code/Interface/QRDInterface.h
+77 -16
View File
@@ -134,6 +134,8 @@ DECLARE_REFLECTION_STRUCT(CaptureSettings);
DOCUMENT(R"(The main parent window of the application.
This window is retrieved by calling :meth:`CaptureContext.GetMainWindow`.
.. function:: ShortcutCallback(QWidget focusWidget)
Not a member function - the signature for any ``ShortcutCallback`` callbacks.
@@ -203,6 +205,8 @@ DECLARE_REFLECTION_STRUCT(IMainWindow);
DOCUMENT(R"(The event browser window.
This window is retrieved by calling :meth:`CaptureContext.GetEventBrowser`.
.. function:: EventFilterCallback(context, filter, params, eventId, chunk, action, name)
Not a member function - the signature for any ``EventFilterCallback`` callbacks.
@@ -424,7 +428,10 @@ protected:
DECLARE_REFLECTION_STRUCT(IEventBrowser);
DOCUMENT("The API inspector window.");
DOCUMENT(R"(The API inspector window.
This window is retrieved by calling :meth:`CaptureContext.GetAPIInspector`.
)");
struct IAPIInspector
{
DOCUMENT(R"(Retrieves the PySide2 QWidget for this :class:`APIInspector` if PySide2 is available, or otherwise
@@ -547,7 +554,10 @@ enum class PipelineStage : int
SampleMask,
};
DOCUMENT("The pipeline state viewer window.");
DOCUMENT(R"(The pipeline state viewer window.
This window is retrieved by calling :meth:`CaptureContext.GetPipelineViewer`.
)");
struct IPipelineStateViewer
{
DOCUMENT(R"(Retrieves the PySide2 QWidget for this :class:`PipelineStateViewer` if PySide2 is available, or otherwise
@@ -615,7 +625,10 @@ enum class FollowType : int
OutputDepthResolve
};
DOCUMENT("The texture viewer window.");
DOCUMENT(R"(The texture viewer window.
This window is retrieved by calling :meth:`CaptureContext.GetTextureViewer`.
)");
struct ITextureViewer
{
DOCUMENT(R"(Retrieves the PySide2 QWidget for this :class:`TextureViewer` if PySide2 is available, or otherwise
@@ -761,7 +774,14 @@ protected:
DECLARE_REFLECTION_STRUCT(ITextureViewer);
DOCUMENT("The buffer viewer window, either a raw buffer or the geometry pipeline.");
DOCUMENT(R"(The buffer viewer window, either a raw buffer or the geometry pipeline.
This mesh viewer is retrieved by calling :meth:`CaptureContext.GetMeshPreview`.
A raw buffer viewer can be opened by calling :meth:`CaptureContext.ViewBuffer`,
:meth:`CaptureContext.ViewTextureAsBuffer`, or :meth:`CaptureContext.ViewConstantBuffer`.
)");
struct IBufferViewer
{
DOCUMENT(R"(Retrieves the PySide2 QWidget for this :class:`BufferViewer` if PySide2 is available, or otherwise
@@ -821,7 +841,10 @@ protected:
DECLARE_REFLECTION_STRUCT(IBufferViewer);
DOCUMENT("The Resource inspector window.");
DOCUMENT(R"(The Resource inspector window.
This window is retrieved by calling :meth:`CaptureContext.GetResourceInspector`.
)");
struct IResourceInspector
{
DOCUMENT(R"(Retrieves the PySide2 QWidget for this :class:`ResourceInspector` if PySide2 is available, or otherwise
@@ -859,7 +882,10 @@ protected:
DECLARE_REFLECTION_STRUCT(IResourceInspector);
DOCUMENT("The executable capture window.");
DOCUMENT(R"(The executable capture window.
This window is retrieved by calling :meth:`CaptureContext.GetCaptureDialog`.
)");
struct ICaptureDialog
{
DOCUMENT(R"(Retrieves the PySide2 QWidget for this :class:`CaptureDialog` if PySide2 is available, or otherwise
@@ -948,7 +974,10 @@ protected:
DECLARE_REFLECTION_STRUCT(ICaptureDialog);
DOCUMENT("The debug warnings and errors window.");
DOCUMENT(R"(The debug warnings and errors window.
This window is retrieved by calling :meth:`CaptureContext.GetDebugMessageView`.
)");
struct IDebugMessageView
{
DOCUMENT(R"(Retrieves the PySide2 QWidget for this :class:`DebugMessageView` if PySide2 is available, or otherwise
@@ -967,7 +996,10 @@ protected:
DECLARE_REFLECTION_STRUCT(IDebugMessageView);
DOCUMENT("The diagnostic log viewing window.");
DOCUMENT(R"(The diagnostic log viewing window.
This window is retrieved by calling :meth:`CaptureContext.GetDiagnosticLogView`.
)");
struct IDiagnosticLogView
{
DOCUMENT(R"(Retrieves the PySide2 QWidget for this :class:`DiagnosticLogView` if PySide2 is available, or otherwise
@@ -986,7 +1018,10 @@ protected:
DECLARE_REFLECTION_STRUCT(IDiagnosticLogView);
DOCUMENT("The capture comments window.");
DOCUMENT(R"(The capture comments window.
This window is retrieved by calling :meth:`CaptureContext.GetCommentView`.
)");
struct ICommentView
{
DOCUMENT(R"(Retrieves the PySide2 QWidget for this :class:`CommentView` if PySide2 is available, or otherwise
@@ -1018,7 +1053,10 @@ protected:
DECLARE_REFLECTION_STRUCT(ICommentView);
DOCUMENT("The statistics window.");
DOCUMENT(R"(The statistics window.
This window is retrieved by calling :meth:`CaptureContext.GetStatisticsViewer`.
)");
struct IStatisticsViewer
{
DOCUMENT(R"(Retrieves the PySide2 QWidget for this :class:`StatisticsViewer` if PySide2 is available, or otherwise
@@ -1035,7 +1073,10 @@ protected:
~IStatisticsViewer() = default;
};
DOCUMENT("The timeline bar.");
DOCUMENT(R"(The timeline bar.
This window is retrieved by calling :meth:`CaptureContext.GetTimelineBar`.
)");
struct ITimelineBar
{
DOCUMENT(R"(Retrieves the PySide2 QWidget for this :class:`TimelineBar` if PySide2 is available, or otherwise
@@ -1067,7 +1108,10 @@ protected:
DECLARE_REFLECTION_STRUCT(IStatisticsViewer);
DOCUMENT("The performance counter view window.");
DOCUMENT(R"(The performance counter view window.
This window is retrieved by calling :meth:`CaptureContext.GetPerformanceCounterViewer`.
)");
struct IPerformanceCounterViewer
{
DOCUMENT(R"(Retrieves the PySide2 QWidget for this :class:`PerformanceCounterViewer` if PySide2 is available, or otherwise
@@ -1089,7 +1133,10 @@ protected:
DECLARE_REFLECTION_STRUCT(IPerformanceCounterViewer);
DOCUMENT("The interactive python shell.");
DOCUMENT(R"(The interactive python shell.
This window is retrieved by calling :meth:`CaptureContext.GetPythonShell`.
)");
struct IPythonShell
{
DOCUMENT(R"(Retrieves the PySide2 QWidget for this :class:`PythonShell` if PySide2 is available, or otherwise
@@ -1135,6 +1182,9 @@ DECLARE_REFLECTION_STRUCT(IPythonShell);
DOCUMENT(R"(A shader window used for viewing, editing, or debugging.
This window is retrieved by calling :meth:`CaptureContext.ViewShader`,
:meth:`CaptureContext.EditShader`, or :meth:`CaptureContext.DebugShader`.
.. function:: SaveCallback(context, viewer, encoding, flags, entry, compiled)
Not a member function - the signature for any ``SaveCallback`` callbacks.
@@ -1234,7 +1284,10 @@ protected:
DECLARE_REFLECTION_STRUCT(IShaderViewer);
DOCUMENT("A shader message list window.");
DOCUMENT(R"(A shader message list window.
This window is retrieved by calling :meth:`CaptureContext.ViewShaderMessages`.
)");
struct IShaderMessageViewer
{
DOCUMENT(R"(Retrieves the PySide2 QWidget for this :class:`ShaderMessageViewer` if PySide2 is available, or otherwise
@@ -1275,7 +1328,10 @@ protected:
DECLARE_REFLECTION_STRUCT(IShaderMessageViewer);
DOCUMENT("A descriptor viewer window.");
DOCUMENT(R"(A descriptor viewer window.
This window is retrieved by calling :meth:`CaptureContext.ViewDescriptorStore` or :meth:`CaptureContext.ViewDescriptors`.
)");
struct IDescriptorViewer
{
DOCUMENT(R"(Retrieves the PySide2 QWidget for this :class:`DescriptorViewer` if PySide2 is available, or otherwise
@@ -1294,7 +1350,10 @@ protected:
DECLARE_REFLECTION_STRUCT(IDescriptorViewer);
DOCUMENT("A pixel history window.");
DOCUMENT(R"(A pixel history window.
This window is retrieved by calling :meth:`CaptureContext.ViewPixelHistory`.
)");
struct IPixelHistoryView
{
DOCUMENT(R"(Retrieves the PySide2 QWidget for this :class:`PixelHistoryView` if PySide2 is available, or otherwise
@@ -1363,6 +1422,8 @@ DOCUMENT(R"(A manager for accessing the underlying replay information that isn't
in UI side structures. This manager controls and serialises access to the underlying
:class:`~renderdoc.ReplayController`, as well as handling remote server connections.
This manager is retrieved by calling :meth:`CaptureContext.Replay`.
.. function:: InvokeCallback(controller)
Not a member function - the signature for any ``InvokeCallback`` callbacks.