This is the API reference for the functions, classes, and enums in the renderdoc module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../index`.

.. currentmodule:: renderdoc

.. autofunction:: renderdoc.InitialiseReplay

.. autofunction:: renderdoc.ShutdownReplay

.. autoclass:: renderdoc.GlobalEnvironment
  :members:

.. autoclass:: renderdoc.ResultCode
  :members:

.. autoclass:: renderdoc.ResultDetails
  :members:

.. autofunction:: renderdoc.OpenCaptureFile

.. autoclass:: renderdoc.CaptureAccess
  :members:

.. autoclass:: renderdoc.CaptureFile
  :members:

.. autoclass:: renderdoc.ReplaySupport
  :members:

.. autoclass:: renderdoc.CaptureFileFormat
  :members:

.. autoclass:: renderdoc.SectionProperties
  :members:

.. autoclass:: renderdoc.SectionType
  :members:

.. autoclass:: renderdoc.SectionFlags
  :members:

.. autoclass:: renderdoc.Thumbnail
  :members:

.. autoclass:: renderdoc.GPUDevice
  :members:

.. autoclass:: renderdoc.GPUVendor
  :members:

.. autofunction:: renderdoc.GPUVendorFromPCIVendor

.. autoclass:: renderdoc.GraphicsAPI
  :members:

.. autofunction:: renderdoc.IsD3D

.. autofunction:: renderdoc.GetDriverInformation

.. autoclass:: renderdoc.DriverInformation
  :members:

.. autoclass:: renderdoc.ReplayController
  :members:

.. autoclass:: renderdoc.ReplayOptions
  :members:

.. autoclass:: renderdoc.ReplayOptimisationLevel
  :members:

.. autoclass:: renderdoc.APIProperties
  :members:

.. autoclass:: renderdoc.DeviceProtocolController
  :members:

.. autofunction:: renderdoc.GetSupportedDeviceProtocols

.. autofunction:: renderdoc.GetDeviceProtocolController

.. autoclass:: renderdoc.RemoteServer
  :members:

.. autofunction:: renderdoc.CreateRemoteServerConnection

.. autofunction:: renderdoc.CheckRemoteServerConnection

.. autofunction:: renderdoc.BecomeRemoteServer

.. autoclass:: renderdoc.PathEntry
  :members:

.. autoclass:: renderdoc.PathProperty
  :members: