mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-05 01:20:42 +00:00
baldurk
8634d8ff22
* Try to guide people looking for an introduction away from API references and towards actual explanations and documentation.
53 lines
1.3 KiB
ReStructuredText
53 lines
1.3 KiB
ReStructuredText
API Reference: Utilities
|
|
========================
|
|
|
|
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
|
|
|
|
Maths
|
|
-----
|
|
|
|
.. autoclass:: FloatVector
|
|
:members:
|
|
|
|
.. autofunction:: renderdoc.HalfToFloat
|
|
.. autofunction:: renderdoc.FloatToHalf
|
|
|
|
Logging & Versioning
|
|
--------------------
|
|
|
|
.. autofunction:: renderdoc.LogMessage
|
|
.. autofunction:: renderdoc.SetDebugLogFile
|
|
.. autofunction:: renderdoc.GetLogFile
|
|
.. autofunction:: renderdoc.GetCurrentProcessMemoryUsage
|
|
.. autofunction:: renderdoc.DumpObject
|
|
|
|
.. autoclass:: LogType
|
|
:members:
|
|
|
|
|
|
Versioning
|
|
----------
|
|
|
|
.. autofunction:: renderdoc.GetVersionString
|
|
.. autofunction:: renderdoc.GetCommitHash
|
|
.. autofunction:: renderdoc.IsReleaseBuild
|
|
|
|
Settings
|
|
--------
|
|
|
|
.. autofunction:: renderdoc.GetConfigSetting
|
|
.. autofunction:: renderdoc.SetConfigSetting
|
|
.. autofunction:: renderdoc.SaveConfigSettings
|
|
|
|
Self-hosted captures
|
|
--------------------
|
|
|
|
.. autofunction:: renderdoc.CanSelfHostedCapture
|
|
.. autofunction:: renderdoc.StartSelfHostCapture
|
|
.. autofunction:: renderdoc.EndSelfHostCapture
|