Move capture-file handling functions into a single interface

* This allows us to return complex types like byte arrays or pairs of
  status & render handle.
* Also in future more introspection of the capture file will be possible
  and this provides an easy extension to that without adding new entry
  points.
This commit is contained in:
baldurk
2017-04-07 14:03:53 +01:00
parent dd1e090040
commit a7ab0d9300
13 changed files with 492 additions and 249 deletions
+1 -1
View File
@@ -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, ReplayRenderer, ReplayOutput, TargetControl, RemoteServer
: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, CaptureFile
+42 -21
View File
@@ -1,33 +1,54 @@
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
Logging & Versioning
--------------------
.. autofunction:: renderdoc.SetDebugLogFile
.. autofunction:: renderdoc.GetLogFile
.. autofunction:: renderdoc.GetVersionString
.. autofunction:: renderdoc.GetCommitHash
Maths & Utilities
-----------------
.. 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.IsD3D
.. autofunction:: renderdoc.MaskForStage
.. autofunction:: renderdoc.StartSelfHostCapture
.. autofunction:: renderdoc.EndSelfHostCapture
+21
View File
@@ -1,20 +1,41 @@
Primary Interfaces
==================
.. contents::
.. module:: renderdoc
ReplayRenderer
--------------
.. autoclass:: renderdoc.ReplayRenderer
: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: