Tidy up python documentation and add examples

docs/python_api/renderdoc/enums_data.rst

@@ -0,0 +1,8 @@
+Enums and Data Structures
+=========================
+
+.. automodule:: renderdoc
+  :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, name_match__startswith__rdcarray_of, rdcstr, bytebuf, ReplayController, ReplayOutput, TargetControl, RemoteServer, CaptureFile

docs/python_api/renderdoc/funcs.rst

@@ -0,0 +1,62 @@
+Functions
+=========
+
+.. contents::
+
+.. module:: renderdoc
+
+Capture File Access
+-------------------
+
+.. autofunction:: renderdoc.OpenCaptureFile
+
+Target Control
+--------------
+
+.. autofunction:: renderdoc.EnumerateRemoteTargets
+.. autofunction:: renderdoc.CreateTargetControl
+
+Remote Servers
+--------------
+
+.. autofunction:: renderdoc.CreateRemoteServerConnection
+.. autofunction:: renderdoc.GetDefaultRemoteServerPort
+.. autofunction:: renderdoc.BecomeRemoteServer
+
+Local Execution & Injection
+---------------------------
+
+.. autofunction:: renderdoc.GetDefaultCaptureOptions
+.. autofunction:: renderdoc.ExecuteAndInject
+.. autofunction:: renderdoc.InjectIntoProcess
+.. autofunction:: renderdoc.StartGlobalHook
+.. autofunction:: renderdoc.StopGlobalHook
+.. autofunction:: renderdoc.IsGlobalHookActive
+.. autofunction:: renderdoc.CanGlobalHook
+
+Logging & Versioning
+--------------------
+
+.. autofunction:: renderdoc.SetDebugLogFile
+.. autofunction:: renderdoc.GetLogFile
+.. autofunction:: renderdoc.GetVersionString
+
+Maths & Utilities
+-----------------
+
+.. autofunction:: renderdoc.CreateWin32WindowingData
+.. autofunction:: renderdoc.CreateXlibWindowingData
+.. autofunction:: renderdoc.CreateXCBWindowingData
+.. autofunction:: renderdoc.CreateAndroidWindowingData
+.. autofunction:: renderdoc.InitCamera
+.. autofunction:: renderdoc.HalfToFloat
+.. autofunction:: renderdoc.FloatToHalf
+.. autofunction:: renderdoc.NumVerticesPerPrimitive
+.. autofunction:: renderdoc.VertexOffset
+.. autofunction:: renderdoc.PatchList_Count
+.. autofunction:: renderdoc.PatchList_Topology
+.. autofunction:: renderdoc.IsStrip
+.. autofunction:: renderdoc.IsD3D
+.. autofunction:: renderdoc.MaskForStage
+.. autofunction:: renderdoc.StartSelfHostCapture
+.. autofunction:: renderdoc.EndSelfHostCapture

docs/python_api/renderdoc/index.rst

@@ -0,0 +1,15 @@
+renderdoc API Reference
+=======================
+
+.. toctree::
+	:hidden:
+
+	main_ifaces
+	funcs
+	enums_data
+	pipelines/index
+
+* :doc:`main_ifaces`
+* :doc:`funcs`
+* :doc:`enums_data`
+* :doc:`pipelines/index`

docs/python_api/renderdoc/main_ifaces.rst

@@ -0,0 +1,41 @@
+Primary Interfaces
+==================
+
+.. contents::
+
+.. module:: renderdoc
+
+ReplayController
+----------------
+
+.. autoclass:: renderdoc.ReplayController
+  :members:
+  :undoc-members:
+
+ReplayOutput
+------------
+
+.. autoclass:: renderdoc.ReplayOutput
+  :members:
+  :undoc-members:
+
+TargetControl
+-------------
+
+.. autoclass:: renderdoc.TargetControl
+  :members:
+  :undoc-members:
+
+RemoteServer
+------------
+
+.. autoclass:: renderdoc.RemoteServer
+  :members:
+  :undoc-members:
+
+CaptureFile
+-----------
+
+.. autoclass:: renderdoc.CaptureFile
+  :members:
+  :undoc-members:

docs/python_api/renderdoc/pipelines/d3d11.rst

@@ -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

docs/python_api/renderdoc/pipelines/d3d12.rst

@@ -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

docs/python_api/renderdoc/pipelines/gl.rst

@@ -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

docs/python_api/renderdoc/pipelines/index.rst

@@ -0,0 +1,8 @@
+Pipeline State Objects
+======================
+
+.. toctree::
+	d3d11
+	d3d12
+	gl
+	vulkan

docs/python_api/renderdoc/pipelines/vulkan.rst

@@ -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