Files
renderdoc/docs/python_api/renderdoc/counters.rst
T
baldurk 8634d8ff22 Add page titles and header texts for all python API ref documentation
* Try to guide people looking for an introduction away from API references and
  towards actual explanations and documentation.
2024-12-17 14:32:54 +00:00

44 lines
1.0 KiB
ReStructuredText

API Reference: Performance Counters
===================================
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
Counters
--------
.. autoclass:: renderdoc.CounterDescription
:members:
.. autoclass:: renderdoc.CounterUnit
:members:
.. autoclass:: renderdoc.Uuid
:members:
Counter Types
-------------
.. autoclass:: renderdoc.GPUCounter
:members:
.. autofunction:: renderdoc.IsAMDCounter
.. autofunction:: renderdoc.IsARMCounter
.. autofunction:: renderdoc.IsGenericCounter
.. autofunction:: renderdoc.IsIntelCounter
.. autofunction:: renderdoc.IsNvidiaCounter
.. autofunction:: renderdoc.IsVulkanExtendedCounter
Results
-------
.. autoclass:: renderdoc.CounterResult
:members:
.. autoclass:: renderdoc.CounterValue
:members: