diff --git a/docs/python_api/enums_data.rst b/docs/python_api/enums_data.rst index 0ee4d0167..2f6fbd435 100644 --- a/docs/python_api/enums_data.rst +++ b/docs/python_api/enums_data.rst @@ -5,5 +5,4 @@ Enums and Data Structures :members: :undoc-members: :imported-members: - :exclude-members: free_functions__, str - + :exclude-members: free_functions__, enum_constants__, name_match__startswith__D3D11_, name_match__startswith__D3D12_, name_match__startswith__VK_, name_match__startswith__GL_, str, ReplayRenderer, ReplayOutput, TargetControl, RemoteServer diff --git a/docs/python_api/funcs.rst b/docs/python_api/funcs.rst index a5f5d170c..47f6438a2 100644 --- a/docs/python_api/funcs.rst +++ b/docs/python_api/funcs.rst @@ -1,3 +1,33 @@ Functions ========= +.. module:: renderdoc + +.. autofunction:: renderdoc.Maths_FloatToHalf +.. autofunction:: renderdoc.Maths_HalfToFloat +.. autofunction:: renderdoc.Topology_NumVerticesPerPrimitive +.. autofunction:: renderdoc.Topology_VertexOffset + +.. autofunction:: renderdoc.SupportLocalReplay +.. autofunction:: renderdoc.CreateReplayRenderer +.. autofunction:: renderdoc.CreateTargetControl +.. autofunction:: renderdoc.EnumerateRemoteTargets +.. autofunction:: renderdoc.GetDefaultRemoteServerPort +.. autofunction:: renderdoc.CreateRemoteServerConnection +.. autofunction:: renderdoc.BecomeRemoteServer +.. autofunction:: renderdoc.GetDefaultCaptureOptions +.. autofunction:: renderdoc.StartGlobalHook +.. autofunction:: renderdoc.ExecuteAndInject +.. autofunction:: renderdoc.InjectIntoProcess +.. autofunction:: renderdoc.StartSelfHostCapture +.. autofunction:: renderdoc.EndSelfHostCapture +.. autofunction:: renderdoc.SetDebugLogFile +.. autofunction:: renderdoc.GetLogFile +.. autofunction:: renderdoc.GetThumbnail +.. autofunction:: renderdoc.GetVersionString +.. autofunction:: renderdoc.GetCommitHash + +.. autofunction:: renderdoc.IsD3D +.. autofunction:: renderdoc.PatchList_Count +.. autofunction:: renderdoc.PatchList_Topology +.. autofunction:: renderdoc.MaskForStage diff --git a/docs/python_api/index.rst b/docs/python_api/index.rst index 7ffe96f81..a9cf6f22c 100644 --- a/docs/python_api/index.rst +++ b/docs/python_api/index.rst @@ -5,4 +5,5 @@ Python API main_ifaces funcs enums_data + pipelines/index qrenderdoc diff --git a/docs/python_api/main_ifaces.rst b/docs/python_api/main_ifaces.rst index 5b6e29ac0..1b0384d3b 100644 --- a/docs/python_api/main_ifaces.rst +++ b/docs/python_api/main_ifaces.rst @@ -1,4 +1,20 @@ Primary Interfaces ================== +.. module:: renderdoc +.. autoclass:: renderdoc.ReplayRenderer + :members: + :undoc-members: + +.. autoclass:: renderdoc.ReplayOutput + :members: + :undoc-members: + +.. autoclass:: renderdoc.TargetControl + :members: + :undoc-members: + +.. autoclass:: renderdoc.RemoteServer + :members: + :undoc-members: diff --git a/docs/python_api/pipelines/d3d11.rst b/docs/python_api/pipelines/d3d11.rst new file mode 100644 index 000000000..dd6843f61 --- /dev/null +++ b/docs/python_api/pipelines/d3d11.rst @@ -0,0 +1,8 @@ +D3D11 Pipeline State +==================== + +.. automodule:: renderdoc + :members: + :undoc-members: + :imported-members: + :exclude-members: free_functions__, enum_constants__, name_match__include_only__startswith__D3D11_ diff --git a/docs/python_api/pipelines/d3d12.rst b/docs/python_api/pipelines/d3d12.rst new file mode 100644 index 000000000..aff4df66b --- /dev/null +++ b/docs/python_api/pipelines/d3d12.rst @@ -0,0 +1,8 @@ +D3D12 Pipeline State +==================== + +.. automodule:: renderdoc + :members: + :undoc-members: + :imported-members: + :exclude-members: free_functions__, enum_constants__, name_match__include_only__startswith__D3D12_ diff --git a/docs/python_api/pipelines/gl.rst b/docs/python_api/pipelines/gl.rst new file mode 100644 index 000000000..01f90e051 --- /dev/null +++ b/docs/python_api/pipelines/gl.rst @@ -0,0 +1,8 @@ +OpenGL Pipeline State +===================== + +.. automodule:: renderdoc + :members: + :undoc-members: + :imported-members: + :exclude-members: free_functions__, enum_constants__, name_match__include_only__startswith__GL_ diff --git a/docs/python_api/pipelines/index.rst b/docs/python_api/pipelines/index.rst new file mode 100644 index 000000000..8cb3d0ed9 --- /dev/null +++ b/docs/python_api/pipelines/index.rst @@ -0,0 +1,8 @@ +Pipeline State Objects +====================== + +.. toctree:: + d3d11 + d3d12 + gl + vulkan diff --git a/docs/python_api/pipelines/vulkan.rst b/docs/python_api/pipelines/vulkan.rst new file mode 100644 index 000000000..f98a0942c --- /dev/null +++ b/docs/python_api/pipelines/vulkan.rst @@ -0,0 +1,8 @@ +Vulkan Pipeline State +===================== + +.. automodule:: renderdoc + :members: + :undoc-members: + :imported-members: + :exclude-members: free_functions__, enum_constants__, name_match__include_only__startswith__VK_