mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-15 06:20:41 +00:00
baldurk
8634d8ff22
* Try to guide people looking for an introduction away from API references and towards actual explanations and documentation.
92 lines
1.5 KiB
ReStructuredText
92 lines
1.5 KiB
ReStructuredText
API Reference: Replay Analysis
|
|
==============================
|
|
|
|
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
|
|
|
|
Frame and Actions
|
|
-----------------
|
|
|
|
.. autoclass:: FrameDescription
|
|
:members:
|
|
|
|
.. autoclass:: ActionDescription
|
|
:members:
|
|
|
|
.. autoclass:: ActionFlags
|
|
:members:
|
|
|
|
.. autoclass:: APIEvent
|
|
:members:
|
|
|
|
Debug Messages
|
|
--------------
|
|
|
|
.. autoclass:: DebugMessage
|
|
:members:
|
|
|
|
.. autoclass:: MessageCategory
|
|
:members:
|
|
|
|
.. autoclass:: MessageSeverity
|
|
:members:
|
|
|
|
.. autoclass:: MessageSource
|
|
:members:
|
|
|
|
Resource Usage
|
|
--------------
|
|
|
|
.. autoclass:: EventUsage
|
|
:members:
|
|
|
|
.. autoclass:: ResourceUsage
|
|
:members:
|
|
|
|
.. autofunction:: renderdoc.ResUsage
|
|
.. autofunction:: renderdoc.RWResUsage
|
|
.. autofunction:: renderdoc.CBUsage
|
|
|
|
Texture Saving
|
|
--------------
|
|
|
|
.. autoclass:: TextureSave
|
|
:members:
|
|
|
|
.. autoclass:: FileType
|
|
:members:
|
|
|
|
.. autoclass:: AlphaMapping
|
|
:members:
|
|
|
|
.. autoclass:: TextureComponentMapping
|
|
:members:
|
|
|
|
.. autoclass:: TextureSampleMapping
|
|
:members:
|
|
|
|
.. autoclass:: TextureSliceMapping
|
|
:members:
|
|
|
|
Pixel History
|
|
-------------
|
|
|
|
.. autoclass:: PixelModification
|
|
:members:
|
|
|
|
.. autoclass:: ModificationValue
|
|
:members:
|
|
|
|
.. autoclass:: PixelValue
|
|
:members:
|
|
|
|
Shader Debuging
|
|
---------------
|
|
|
|
.. autoclass:: DebugPixelInputs
|
|
:members:
|