Files
renderdoc/docs/renderdoc.hhk
T
baldurk fb95285ca1 Put all annotation docs into the same 'how do I' page. Refs #2285
* This page now documents both how to annotate things from code in the
  application, as well as at runtime in the UI.
2021-06-01 13:29:09 +01:00

447 lines
18 KiB
Plaintext

<UL>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Analytics">
<param name="Local" value="behind_scenes/analytics.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Android">
<param name="Local" value="how/how_android_capture.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="API Calls">
<param name="Local" value="window/api_inspector.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="API Callstacks">
<param name="Local" value="window/api_inspector.html#callstack">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="API Errors">
<param name="Local" value="window/debug_messages.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Bound Resources">
<param name="Local" value="window/pipeline_state.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Buffer Contents">
<param name="Local" value="window/buffer_viewer.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Capture all Processes">
<param name="Local" value="window/capture_attach.html#global-process-hook">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Capture Options">
<param name="Local" value="window/capture_attach.html#capture-options">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Code Integration">
<param name="Local" value="in_application_api.html">
</OBJECT>
<UL>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Naming resources">
<param name="Local" value="how/how_annotate_capture.html#application-provided-object-names">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Event marker annotations">
<param name="Local" value="how/how_annotate_capture.html#application-provided-marker-regions">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Integrating RenderDoc functionality">
<param name="Local" value="in_application_api.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Manually triggered frame capture">
<param name="Local" value="in_application_api.html#_CPPv217StartFrameCapture23RENDERDOC_DevicePointer22RENDERDOC_WindowHandle">
</OBJECT>
</UL>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Constant Buffer Contents">
<param name="Local" value="how/how_object_details.html#viewing-constant-buffers">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Contact RenderDoc's Creator">
<param name="Local" value="introduction.html#contact-info-feedback-bug-reports">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Counters">
<param name="Local" value="window/performance_counter_viewer.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Current API State">
<param name="Local" value="window/pipeline_state.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Custom Shader Display">
<param name="Local" value="how/how_custom_visualisation.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="D3D12">
<param name="Local" value="behind_scenes/d3d12_support.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Drawcall Timings">
<param name="Local" value="window/event_browser.html#timing-drawcalls">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Event Hierarchy">
<param name="Local" value="window/event_browser.html#timing-drawcalls">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="FAQ">
<param name="Local" value="getting_started/faq.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Features Supported">
<param name="Local" value="getting_started/features.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Find Event">
<param name="Local" value="window/event_browser.html#searching-and-jumping">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Global Hook">
<param name="Local" value="window/capture_attach.html#global-process-hook">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Hardware Counters">
<param name="Local" value="window/performance_counter_viewer.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Hot-reload Shaders">
<param name="Local" value="how/how_edit_shader.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="How To">
<param name="Local" value="how/index.html">
</OBJECT>
<UL>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Annotate a capture">
<param name="Local" value="how/how_annotate_capture.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Capture a Frame">
<param name="Local" value="how/how_capture_frame.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Capture across a network">
<param name="Local" value="how/how_network_capture_replay">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Capture from Android">
<param name="Local" value="how/how_android_capture.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Debug a Shader">
<param name="Local" value="how/how_debug_shader.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Edit a custom visualisation shader">
<param name="Local" value="how/how_edit_shader.html#how-to-edit-a-custom-shader">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Edit a shader in the capture">
<param name="Local" value="how/how_edit_shader.html#how-to-edit-a-scene-shader">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Find a texture by name">
<param name="Local" value="how/how_view_texture.html#texture-list-in-texture-viewer">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Generate an RGP profile">
<param name="Local" value="how/how_rgp_profile.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Import or Export a capture">
<param name="Local" value="how/how_import_export.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Inspect a pixel value">
<param name="Local" value="how/how_inspect_pixel.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Manually trigger a capture in code">
<param name="Local" value="in_application_api.html#_CPPv214TriggerCapturev">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Show a specific texture">
<param name="Local" value="how/how_view_texture.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Take multiple captures">
<param name="Local" value="window/capture_connection.html#capture-connection-window">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Use custom visualisation">
<param name="Local" value="ow/how_custom_visualisation.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="View API errors and messages">
<param name="Local" value="window/debug_messages.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="View a constant buffer">
<param name="Local" value="how/how_object_details.html#viewing-constant-buffers">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="View an image file on disk">
<param name="Local" value="getting_started/tips_tricks.html#view-image-files">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="View an object's details">
<param name="Local" value="how/how_object_details.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="View a buffer's contents">
<param name="Local" value="how/how_object_details.html#viewing-buffers">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="View a shader's source">
<param name="Local" value="how/how_object_details.html#viewing-shaders">
</OBJECT>
</UL>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Image Viewer">
<param name="Local" value="getting_started/tips_tricks.html#view-image-files">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Interface for Applications">
<param name="Local" value="in_application_api.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Introduction">
<param name="Local" value="introduction.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Jump to Event">
<param name="Local" value="window/event_browser.html#searching-and-jumping">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Known Issues">
<param name="Local" value="getting_started/gotchas_known_issues.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="License">
<param name="Local" value="introduction.html#license">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Locking a view of a texture">
<param name="Local" value="how/how_view_texture.html#locked-tab-of-a-texture">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Manual Capture">
<param name="Local" value="in_application_api.html#_CPPv214TriggerCapturev">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="OpenGL">
<param name="Local" value="behind_scenes/opengl_support.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Performance Counters">
<param name="Local" value="window/performance_counter_viewer.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Pixel History">
<param name="Local" value="how/how_inspect_pixel.html#pixel-history">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Pixel Picking">
<param name="Local" value="how/how_inspect_pixel.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Planned Features">
<param name="Local" value="behind_scenes/planned_features.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Preferences">
<param name="Local" value="window/settings_window.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Python Scripting">
<param name="Local" value="window/python_shell.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Quick Start">
<param name="Local" value="getting_started/quick_start.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Radeon GPU Profiler">
<param name="Local" value="how/how_rgp_profile.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Raw Buffer View">
<param name="Local" value="window/buffer_viewer.html#raw-buffer-viewer">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="RenderDoc API">
<param name="Local" value="in_application_api.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="RenderDoc Internals">
<param name="Local" value="behind_scenes/how_works.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Resource Dependencies">
<param name="Local" value="window/timeline_bar.html#resource-usage-display">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="RGP">
<param name="Local" value="how/how_rgp_profile.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Python Scripting">
<param name="Local" value="python_api/index.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Scripting the UI">
<param name="Local" value="window/python_shell.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Settings">
<param name="Local" value="window/settings_window.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Shader Debugging">
<param name="Local" value="how/how_debug_shader.html">
</OBJECT>
<UL>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Compute Shader Debugging">
<param name="Local" value="how/how_debug_shader.html#debugging-a-compute-thread">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="HLSL Debugging">
<param name="Local" value="how/how_debug_shader.html#hlsl-debugging">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Inspecting Shader Variables">
<param name="Local" value="how/how_debug_shader.html#debugging-displays">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Stepping through Shaders">
<param name="Local" value="how/how_debug_shader.html#debugging-controls">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Pixel Shader Debugging">
<param name="Local" value="how/how_debug_shader.html#debugging-a-pixel">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Vertex Shader Debugging">
<param name="Local" value="how/how_debug_shader.html#debugging-a-vertex">
</OBJECT>
</UL>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Shader Editing">
<param name="Local" value="how/how_edit_shader.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="SSBO Contents">
<param name="Local" value="window/buffer_viewer.html#raw-buffer-viewer">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Texture List">
<param name="Local" value="how/how_view_texture.html#texture-list-in-texture-viewer">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Thanks &amp; Acknowledgements">
<param name="Local" value="html/credits_acknowledgements.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Timing drawcalls">
<param name="Local" value="window/event_browser.html#timing-drawcalls">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Tips &amp; Tricks">
<param name="Local" value="getting_started/tips_tricks.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="UAV Contents">
<param name="Local" value="window/buffer_viewer.html#raw-buffer-viewer">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Vulkan">
<param name="Local" value="behind_scenes/vulkan_support.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Welcome">
<param name="Local" value="introduction.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Window">
<param name="Local" value="window/index.html">
</OBJECT>
<UL>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="API Inspector">
<param name="Local" value="window/api_inspector.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Capture Comments">
<param name="Local" value="window/capture_comments.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Capture Connection">
<param name="Local" value="window/capture_connection.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Capture Dialog">
<param name="Local" value="window/capture_attach.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Debug Messages">
<param name="Local" value="window/debug_messages.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Event Browser">
<param name="Local" value="window/event_browser.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Settings Window">
<param name="Local" value="window/settings_window.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Mesh Output">
<param name="Local" value="window/buffer_viewer.html#mesh-viewer">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Mesh Viewer">
<param name="Local" value="window/buffer_viewer.html#mesh-viewer">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Performance Counter Viewer">
<param name="Local" value="window/performance_counter_viewer.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Pipeline State">
<param name="Local" value="window/pipeline_state.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Python Shell">
<param name="Local" value="window/python_shell.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Raw Buffer Viewer">
<param name="Local" value="window/buffer_viewer.html#raw-buffer-viewer">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Resource Inspector">
<param name="Local" value="window/resource_inspector.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Shader Viewer">
<param name="Local" value="window/shader_viewer.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Texture Viewer">
<param name="Local" value="window/texture_viewer.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Keyword" value="Timeline Bar">
<param name="Local" value="window/timeline_bar.html">
</OBJECT>
</UL>
</UL>