mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-07-17 13:07:14 +00:00
baldurk
7149302680
* 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.
38 lines
2.1 KiB
ReStructuredText
38 lines
2.1 KiB
ReStructuredText
API Inspector
|
|
=============
|
|
|
|
Although not the most complex part of the RenderDoc's UI, this page details the features and functionality of the API Inspector.
|
|
|
|
UI Elements
|
|
-----------
|
|
|
|
The API Inspector is divided into two sections - the top section is the most common, detailing all of the API calls leading up to and including the current action. The special case for this is the end of the frame where there may not be a final action but the API Inspector lists the API calls that preceded the final flip of the backbuffer that marks the end of RenderDoc's captured frame.
|
|
|
|
The bottom section is less commonly used but shows the callstack from user code into the API entry point, if such a callstack is available and the symbols are resolved. For more information check out the page on :doc:`../how/how_capture_callstack`.
|
|
|
|
API Calls
|
|
---------
|
|
|
|
This section lists the series of API calls made between the preceding action and the currently selected action. The current action is always the last element in this list and is highlighted in bold. By default it is also the selected element.
|
|
|
|
Each API call can be expanded to see the parameters that were passed to it, in the form that they were serialised out to the log file.
|
|
|
|
.. figure:: ../imgs/Screenshots/APIList.png
|
|
|
|
API Calls: A list of API calls made up to the current action.
|
|
|
|
Callstack
|
|
---------
|
|
|
|
The callstack section can be expanded by double clicking on the separator and collapsed in the same way. Once open its size can be adjusted by clicking and dragging on the separator.
|
|
|
|
This section will either show "No callstack available" or "Need to resolve symbols" as appropriate when the callstacks aren't ready for display.
|
|
|
|
The callstack follows the currently selected API call in the other section, and will update both as that selected call change and as the current event changes (as this implicitly changes the API call selected to whichever the current action is).
|
|
|
|
For more information see :doc:`../how/how_capture_callstack`
|
|
|
|
.. figure:: ../imgs/Screenshots/CallstackPanel.png
|
|
|
|
Callstack: The callstack in user code where this API call was made.
|