lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-08-23 15:06:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename 'create debug device' capture option to 'API validation'

Browse Source 
* More appropriate for non-D3D11 APIs and will cause less confusion.
This commit is contained in:
baldurk
2016-05-17 21:16:17 +02:00
parent 3539b06899
commit 4b7e068703
16 changed files with 57 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/getting_started/tips_tricks.rst
+1 -1
View File
@@ -48,7 +48,7 @@ This page is a random hodge-podge of different tips and tricks that might not be
You can also use the ``RENDERDOC_StartFrameCapture()`` and ``RENDERDOC_EndFrameCapture()`` functions to precisely define the period to be captured. For more information look at the :doc:`../in_application_api` documentation or the ``renderdoc_app.h`` header.
#. When you have right clicked to select a pixel in the texture viewer, you can perform precise refinements with the arrow keys to nudge the selection in each direction.
#. To get API debug or error messages, enable "Create Debug Device" when capturing then check out the :doc:`../window/debug_messages` window.
#. To get API debug or error messages, enable "Enable API validation" when capturing then check out the :doc:`../window/debug_messages` window.
#. Detecting RenderDoc from your code can either be done by trying to load and use the renderdoc :doc:`../in_application_api`, or through API specific ways:
.. highlight:: c++
docs/window/capture_log_attach.rst
+2 -2
View File
@@ -80,9 +80,9 @@ This option modifies the above capturing of callstacks to only be saved for draw
----------
| ``Create Debug Device`` Default: ``Disabled``
| ``Enable API validation`` Default: ``Disabled``
Create Debug Device causes RenderDoc to enable the API's built-in debugging, and where possible serialise this out and include it in the logfile for later inspection in the :doc:`debug_messages` window.
Enable API validation causes RenderDoc to enable the API's built-in debugging, and where possible serialise this out and include it in the logfile for later inspection in the :doc:`debug_messages` window.
* On D3D11 this will activate the D3D debug layer and save out any messages.
* For OpenGL this means ``ARB_debug_output`` is automatically enabled.
docs/window/debug_messages.rst
+1 -1
View File
@@ -8,7 +8,7 @@ RenderDoc will alert you if there are any debug messages to show from the log, b
Capturing with debug messages included
--------------------------------------
To include these debug messages in a log, check on the "Create Debug Device" option in the capture options. For more information see :doc:`capture_log_attach`
To include these debug messages in a log, check on the "Enable API validation" option in the capture options. For more information see :doc:`capture_log_attach`
Debug Messages
--------------