mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-05 01:20:42 +00:00
Normalise and make python/public interface more consistent
* We enforce a naming scheme more strongly - types, member functions, and enum values must be UpperCaseCamel, and member variables must be lowerCaseCamel. No underscores allowed. * eventId not eventID or EID, and Id preferred to ID in general. Also for resourceId. * Removed some lingering hungarian m_Foo naming. * Some pipeline state structs that are almost identical between the different APIs are pulled out into common structs. Where something doesn't make sense (e.g. viewport enable for vulkan) it will just be set to a sensible default (in that case always true). * Changed scissors to be x/y & width/height instead of sometimes left/top/right/bottom * Abbreviations are discouraged, e.g. operation not op, function not func.
This commit is contained in:
@@ -5,4 +5,4 @@ Enums and Data Structures
|
||||
:members:
|
||||
:undoc-members:
|
||||
:imported-members:
|
||||
:exclude-members: free_functions__, enum_constants__, name_match__startswith__D3D11_, name_match__startswith__D3D12_, name_match__startswith__VK_, name_match__startswith__GL_, str, ReplayController, ReplayOutput, TargetControl, RemoteServer, CaptureFile
|
||||
:exclude-members: free_functions__, enum_constants__, name_match__startswith__D3D11, name_match__startswith__D3D12, name_match__startswith__VK, name_match__startswith__GL, str, ReplayController, ReplayOutput, TargetControl, RemoteServer, CaptureFile
|
||||
|
||||
@@ -1,15 +1,14 @@
|
||||
D3D11 Pipeline State
|
||||
====================
|
||||
|
||||
.. module:: renderdoc
|
||||
.. currentmodule:: renderdoc
|
||||
|
||||
.. autoclass:: D3D11_State
|
||||
.. autoclass:: D3D11State
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
.. automodule:: renderdoc
|
||||
:members:
|
||||
:noindex:
|
||||
:undoc-members:
|
||||
:imported-members:
|
||||
:exclude-members: D3D11_State, free_functions__, enum_constants__, name_match__include_only__startswith__D3D11_
|
||||
:exclude-members: D3D11State, free_functions__, enum_constants__, name_match__include_only__startswith__D3D11
|
||||
|
||||
@@ -1,15 +1,14 @@
|
||||
D3D12 Pipeline State
|
||||
====================
|
||||
|
||||
.. module:: renderdoc
|
||||
.. currentmodule:: renderdoc
|
||||
|
||||
.. autoclass:: D3D12_State
|
||||
.. autoclass:: D3D12State
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
.. automodule:: renderdoc
|
||||
:members:
|
||||
:noindex:
|
||||
:undoc-members:
|
||||
:imported-members:
|
||||
:exclude-members: D3D12_State, free_functions__, enum_constants__, name_match__include_only__startswith__D3D12_
|
||||
:exclude-members: D3D12State, free_functions__, enum_constants__, name_match__include_only__startswith__D3D12
|
||||
|
||||
@@ -1,15 +1,14 @@
|
||||
OpenGL Pipeline State
|
||||
=====================
|
||||
|
||||
.. module:: renderdoc
|
||||
.. currentmodule:: renderdoc
|
||||
|
||||
.. autoclass:: GL_State
|
||||
.. autoclass:: GLState
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
.. automodule:: renderdoc
|
||||
:members:
|
||||
:noindex:
|
||||
:undoc-members:
|
||||
:imported-members:
|
||||
:exclude-members: GL_State, free_functions__, enum_constants__, name_match__include_only__startswith__GL_
|
||||
:exclude-members: GLState, free_functions__, enum_constants__, name_match__include_only__startswith__GL
|
||||
|
||||
@@ -1,15 +1,14 @@
|
||||
Vulkan Pipeline State
|
||||
=====================
|
||||
|
||||
.. module:: renderdoc
|
||||
.. currentmodule:: renderdoc
|
||||
|
||||
.. autoclass:: VK_State
|
||||
.. autoclass:: VKState
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
.. automodule:: renderdoc
|
||||
:members:
|
||||
:noindex:
|
||||
:undoc-members:
|
||||
:imported-members:
|
||||
:exclude-members: VK_State, free_functions__, enum_constants__, name_match__include_only__startswith__VK_
|
||||
:exclude-members: VKState, free_functions__, enum_constants__, name_match__include_only__startswith__VK
|
||||
|
||||
@@ -3,7 +3,7 @@ Persistant Config
|
||||
|
||||
.. contents::
|
||||
|
||||
.. module:: qrenderdoc
|
||||
.. currentmodule:: qrenderdoc
|
||||
|
||||
Config
|
||||
------
|
||||
@@ -14,6 +14,15 @@ Config
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
.. autoclass:: qrenderdoc.BugReport
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
.. autoclass:: qrenderdoc.TimeUnit
|
||||
:members:
|
||||
:undoc-members:
|
||||
:exclude-members: enum_constants__,
|
||||
|
||||
Remote Host
|
||||
-----------
|
||||
|
||||
|
||||
@@ -19,8 +19,8 @@ Replay Manager
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
LogViewer Interface
|
||||
-------------------
|
||||
CaptureViewer Interface
|
||||
------------------------
|
||||
|
||||
.. autoclass:: qrenderdoc.CaptureViewer
|
||||
:members:
|
||||
@@ -34,7 +34,16 @@ Utilities
|
||||
:undoc-members:
|
||||
:exclude-members: enum_constants__,
|
||||
|
||||
.. autoclass:: qrenderdoc.CaptureModifications
|
||||
:members:
|
||||
:undoc-members:
|
||||
:exclude-members: enum_constants__,
|
||||
|
||||
.. autoclass:: qrenderdoc.CaptureSettings
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
.. autoclass:: qrenderdoc.EventBookmark
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ Pipeline Abstraction
|
||||
|
||||
.. contents::
|
||||
|
||||
.. module:: qrenderdoc
|
||||
.. currentmodule:: qrenderdoc
|
||||
|
||||
Pipeline
|
||||
--------
|
||||
@@ -23,7 +23,7 @@ Bindings
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
.. autoclass:: qrenderdoc.BoundBuffer
|
||||
.. autoclass:: qrenderdoc.BoundVBuffer
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
@@ -35,7 +35,3 @@ Bindings
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
.. autoclass:: qrenderdoc.Viewport
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
|
||||
@@ -3,87 +3,122 @@ Windows
|
||||
|
||||
.. contents::
|
||||
|
||||
.. module:: qrenderdoc
|
||||
.. currentmodule:: qrenderdoc
|
||||
|
||||
MainWindow
|
||||
----------
|
||||
Main Window
|
||||
-----------
|
||||
|
||||
.. autoclass:: qrenderdoc.MainWindow
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
EventBrowser
|
||||
------------
|
||||
Event Browser
|
||||
-------------
|
||||
|
||||
.. autoclass:: qrenderdoc.EventBrowser
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
APIInspector
|
||||
------------
|
||||
API Inspector
|
||||
-------------
|
||||
|
||||
.. autoclass:: qrenderdoc.APIInspector
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
PipelineStateViewer
|
||||
-------------------
|
||||
Pipeline State
|
||||
--------------
|
||||
|
||||
.. autoclass:: qrenderdoc.PipelineStateViewer
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
TextureViewer
|
||||
-------------
|
||||
Texture Viewer
|
||||
--------------
|
||||
|
||||
.. autoclass:: qrenderdoc.TextureViewer
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
BufferViewer
|
||||
------------
|
||||
Buffer Viewer
|
||||
-------------
|
||||
|
||||
.. autoclass:: qrenderdoc.BufferViewer
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
CaptureDialog
|
||||
-------------
|
||||
Resource Inspector
|
||||
------------------
|
||||
|
||||
.. autoclass:: qrenderdoc.ResourceInspector
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
Capture Dialog
|
||||
--------------
|
||||
|
||||
.. autoclass:: qrenderdoc.CaptureDialog
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
DebugMessageView
|
||||
----------------
|
||||
Debug Messages
|
||||
--------------
|
||||
|
||||
.. autoclass:: qrenderdoc.DebugMessageView
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
StatisticsViewer
|
||||
----------------
|
||||
Comment View
|
||||
------------
|
||||
|
||||
.. autoclass:: qrenderdoc.CommentView
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
Statistics Viewer
|
||||
-----------------
|
||||
|
||||
.. autoclass:: qrenderdoc.StatisticsViewer
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
ShaderViewer
|
||||
Timeline Bar
|
||||
------------
|
||||
|
||||
.. autoclass:: qrenderdoc.TimelineBar
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
Performance Counter Viewer
|
||||
--------------------------
|
||||
|
||||
.. autoclass:: qrenderdoc.PerformanceCounterViewer
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
Python Shell
|
||||
------------
|
||||
|
||||
.. autoclass:: qrenderdoc.PythonShell
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
Shader Viewer
|
||||
-------------
|
||||
|
||||
.. autoclass:: qrenderdoc.ShaderViewer
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
ConstantBufferPreviewer
|
||||
-----------------------
|
||||
Constant Buffer Previewer
|
||||
-------------------------
|
||||
|
||||
.. autoclass:: qrenderdoc.ConstantBufferPreviewer
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
PixelHistoryView
|
||||
----------------
|
||||
Pixel History
|
||||
-------------
|
||||
|
||||
.. autoclass:: qrenderdoc.PixelHistoryView
|
||||
:members:
|
||||
|
||||
Reference in New Issue
Block a user