lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-05-12 21:10:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Re-organise and tidy python API documentation

Browse Source
This commit is contained in:
baldurk
2017-12-22 12:00:42 +00:00
parent 417a811fad
commit 691f91c9aa
11 changed files with 20 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/python_api/base/funcs.rst
+58
View File
@@ -0,0 +1,58 @@
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.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