mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-05 09:30:44 +00:00
baldurk
8634d8ff22
* Try to guide people looking for an introduction away from API references and towards actual explanations and documentation.
79 lines
1.5 KiB
ReStructuredText
79 lines
1.5 KiB
ReStructuredText
API Reference: Replay Outputs
|
|
=============================
|
|
|
|
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`.
|
|
|
|
.. contents:: Sections
|
|
:local:
|
|
|
|
.. currentmodule:: renderdoc
|
|
|
|
General
|
|
-------
|
|
|
|
.. autoclass:: ReplayOutput
|
|
:members:
|
|
|
|
.. autoclass:: ReplayOutputType
|
|
:members:
|
|
|
|
.. autofunction:: renderdoc.SetColors
|
|
|
|
Window Configuration
|
|
--------------------
|
|
|
|
.. autoclass:: WindowingData
|
|
:members:
|
|
|
|
.. autoclass:: WindowingSystem
|
|
:members:
|
|
|
|
.. autofunction:: renderdoc.CreateHeadlessWindowingData
|
|
.. autofunction:: renderdoc.CreateWin32WindowingData
|
|
.. autofunction:: renderdoc.CreateXlibWindowingData
|
|
.. autofunction:: renderdoc.CreateXCBWindowingData
|
|
.. autofunction:: renderdoc.CreateWaylandWindowingData
|
|
.. autofunction:: renderdoc.CreateAndroidWindowingData
|
|
.. autofunction:: renderdoc.CreateMacOSWindowingData
|
|
|
|
Texture View
|
|
------------
|
|
|
|
.. autoclass:: TextureDisplay
|
|
:members:
|
|
|
|
.. autoclass:: DebugOverlay
|
|
:members:
|
|
|
|
Mesh View
|
|
---------
|
|
|
|
.. autoclass:: MeshDisplay
|
|
:members:
|
|
|
|
.. autoclass:: MeshDataStage
|
|
:members:
|
|
|
|
.. autoclass:: MeshletSize
|
|
:members:
|
|
|
|
.. autoclass:: TaskGroupSize
|
|
:members:
|
|
|
|
.. autoclass:: MeshFormat
|
|
:members:
|
|
|
|
.. autoclass:: Visualisation
|
|
:members:
|
|
|
|
.. autoclass:: Camera
|
|
:members:
|
|
|
|
.. autoclass:: CameraType
|
|
:members:
|
|
|
|
.. autoclass:: AxisMapping
|
|
:members:
|
|
|
|
.. autofunction:: renderdoc.InitCamera
|