Files
renderdoc/docs/python_api/renderdoc/analysis.rst
T
baldurk 7149302680 Rename 'draw' or 'drawcall' to action
* There's not a good accepted terminology for this kind of event, and for
  historical reasons 'drawcall' has been the accepted term, even though
  that can be quite confusing when a dispatch or a copy is a 'drawcall'.
* This is particularly highlighted by the event browser filters where
  $draw() includes draws and dispatches, but $dispatch() only includes
  dispatches, it's hard to intuitively understand why $draw() matches all
  of these calls.
* As a result we've defined the term 'action' to cover these types of
  events in the same way that we defined 'event' in the first place to
  mean a single atomic API call.
2021-07-01 15:15:05 +01:00

83 lines
1.1 KiB
ReStructuredText

Replay Analysis
===============
.. contents::
.. 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: