lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-05-06 01:50:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document the in-application API properly

Browse Source
This commit is contained in:
baldurk
2016-04-23 11:36:17 +02:00
parent c145de9d16
commit b14b771000
4 changed files with 785 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/TipsNTricks.aml
+2 -2
View File
@@ -46,7 +46,7 @@
<listItem><para>You can double click on a thumbnail in the texture viewer to open a
<link xlink:href="32C47E20-0FA2-4F52-B33A-4440EBCCBCE4">locked texture</link> tab</para></listItem>
<listItem><para>You can close tabs by middle clicking on them.</para></listItem>
<listItem><para>You can trigger a capture from code. renderdoc.dll exports an API for this
<listItem><para>You can trigger a capture from code. renderdoc.dll exports an <link xlink:href="b32454b2-9dff-41e3-8d56-a9607702e51c">in-application API</link> for this
purpose, defined in renderdoc_app.h in the distributions:
<code language="cpp">
#include "renderdoc_app.h"
@@ -76,7 +76,7 @@ if(rdoc_api) rdoc_api->TriggerCapture();
<listItem><para>To get API debug or error messages, enable "Create Debug Device" when capturing
then check out the <link xlink:href="1f098896-0e60-485a-b879-900a4a320b80" /> window.</para></listItem>
<listItem><para>Detecting RenderDoc from your code can either be done by trying to load and
use the renderdoc in-program API, or through API specific ways:
use the renderdoc <link xlink:href="b32454b2-9dff-41e3-8d56-a9607702e51c">in-application API</link>, or through API specific ways:
<code language="cpp">
// For D3D11:
ID3D11Device *devicePointer = ...;