Tidy up python documentation and add examples

2026-07-12 18:47:07 +00:00 · 2018-06-15 19:43:16 +01:00
parent 45c3c27923
commit 11091f1e54
32 changed files with 1860 additions and 16 deletions
@@ -0,0 +1,14 @@
+D3D11 Pipeline State
+====================
+
+.. currentmodule:: renderdoc
+
+.. autoclass:: D3D11State
+  :members:
+  :undoc-members:
+
+.. automodule:: renderdoc
+  :members:
+  :undoc-members:
+  :imported-members:
+  :exclude-members: D3D11State, free_functions__, enum_constants__, name_match__include_only__startswith__D3D11
@@ -0,0 +1,14 @@
+D3D12 Pipeline State
+====================
+
+.. currentmodule:: renderdoc
+
+.. autoclass:: D3D12State
+  :members:
+  :undoc-members:
+
+.. automodule:: renderdoc
+  :members:
+  :undoc-members:
+  :imported-members:
+  :exclude-members: D3D12State, free_functions__, enum_constants__, name_match__include_only__startswith__D3D12
@@ -0,0 +1,14 @@
+OpenGL Pipeline State
+=====================
+
+.. currentmodule:: renderdoc
+
+.. autoclass:: GLState
+  :members:
+  :undoc-members:
+
+.. automodule:: renderdoc
+  :members:
+  :undoc-members:
+  :imported-members:
+  :exclude-members: GLState, free_functions__, enum_constants__, name_match__include_only__startswith__GL
@@ -0,0 +1,8 @@
+Pipeline State Objects
+======================
+
+.. toctree::
+	d3d11
+	d3d12
+	gl
+	vulkan
@@ -0,0 +1,14 @@
+Vulkan Pipeline State
+=====================
+
+.. currentmodule:: renderdoc
+
+.. autoclass:: VKState
+  :members:
+  :undoc-members:
+
+.. automodule:: renderdoc
+  :members:
+  :undoc-members:
+  :imported-members:
+  :exclude-members: VKState, free_functions__, enum_constants__, name_match__include_only__startswith__VK