mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-06 01:50:38 +00:00
Document the QRenderDoc python API
This commit is contained in:
@@ -6,4 +6,4 @@ Python API
|
||||
funcs
|
||||
enums_data
|
||||
pipelines/index
|
||||
qrenderdoc
|
||||
qrenderdoc/index
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
QRenderDoc
|
||||
==========
|
||||
|
||||
.. automodule:: qrenderdoc
|
||||
:members:
|
||||
:undoc-members:
|
||||
:imported-members:
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
Persistant Config
|
||||
=================
|
||||
|
||||
.. contents::
|
||||
|
||||
.. module:: qrenderdoc
|
||||
|
||||
Config
|
||||
------
|
||||
|
||||
.. autoclass:: qrenderdoc.PersistantConfig
|
||||
|
||||
.. autoclass:: qrenderdoc.SPIRVDisassembler
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
Remote Host
|
||||
-----------
|
||||
|
||||
.. autoclass:: qrenderdoc.RemoteHost
|
||||
:members:
|
||||
:undoc-members:
|
||||
@@ -0,0 +1,8 @@
|
||||
QRenderDoc
|
||||
==========
|
||||
|
||||
.. toctree::
|
||||
main
|
||||
windows
|
||||
config
|
||||
pipeline
|
||||
@@ -0,0 +1,40 @@
|
||||
Main Interfaces
|
||||
===============
|
||||
|
||||
.. contents::
|
||||
|
||||
.. module:: qrenderdoc
|
||||
|
||||
Context
|
||||
-------
|
||||
|
||||
.. autoclass:: qrenderdoc.CaptureContext
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
Replay Manager
|
||||
--------------
|
||||
|
||||
.. autoclass:: qrenderdoc.ReplayManager
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
LogViewer Interface
|
||||
-------------------
|
||||
|
||||
.. autoclass:: qrenderdoc.LogViewer
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
Utilities
|
||||
---------
|
||||
|
||||
.. autoclass:: qrenderdoc.DockReference
|
||||
:members:
|
||||
:undoc-members:
|
||||
:exclude-members: enum_constants__,
|
||||
|
||||
.. autoclass:: qrenderdoc.CaptureSettings
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
Pipeline Abstraction
|
||||
====================
|
||||
|
||||
.. contents::
|
||||
|
||||
.. module:: qrenderdoc
|
||||
|
||||
Pipeline
|
||||
--------
|
||||
|
||||
.. autoclass:: qrenderdoc.CommonPipelineState
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
Bindings
|
||||
--------
|
||||
|
||||
.. autoclass:: qrenderdoc.BoundResource
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
.. autoclass:: qrenderdoc.BoundVBuffer
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
.. autoclass:: qrenderdoc.BoundCBuffer
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
.. autoclass:: qrenderdoc.VertexInputAttribute
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
.. autoclass:: qrenderdoc.Viewport
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
@@ -0,0 +1,91 @@
|
||||
Windows
|
||||
=======
|
||||
|
||||
.. contents::
|
||||
|
||||
.. module:: qrenderdoc
|
||||
|
||||
MainWindow
|
||||
----------
|
||||
|
||||
.. autoclass:: qrenderdoc.MainWindow
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
EventBrowser
|
||||
------------
|
||||
|
||||
.. autoclass:: qrenderdoc.EventBrowser
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
APIInspector
|
||||
------------
|
||||
|
||||
.. autoclass:: qrenderdoc.APIInspector
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
PipelineStateViewer
|
||||
-------------------
|
||||
|
||||
.. autoclass:: qrenderdoc.PipelineStateViewer
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
TextureViewer
|
||||
-------------
|
||||
|
||||
.. autoclass:: qrenderdoc.TextureViewer
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
BufferViewer
|
||||
------------
|
||||
|
||||
.. autoclass:: qrenderdoc.BufferViewer
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
CaptureDialog
|
||||
-------------
|
||||
|
||||
.. autoclass:: qrenderdoc.CaptureDialog
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
DebugMessageView
|
||||
----------------
|
||||
|
||||
.. autoclass:: qrenderdoc.DebugMessageView
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
StatisticsViewer
|
||||
----------------
|
||||
|
||||
.. autoclass:: qrenderdoc.StatisticsViewer
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
ShaderViewer
|
||||
------------
|
||||
|
||||
.. autoclass:: qrenderdoc.ShaderViewer
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
ConstantBufferPreviewer
|
||||
-----------------------
|
||||
|
||||
.. autoclass:: qrenderdoc.ConstantBufferPreviewer
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
PixelHistoryView
|
||||
----------------
|
||||
|
||||
.. autoclass:: qrenderdoc.PixelHistoryView
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
Reference in New Issue
Block a user