From 046ca0ad122dbb95b18f451ff938f8dc871f0be7 Mon Sep 17 00:00:00 2001 From: baldurk Date: Fri, 5 Oct 2018 17:55:28 +0100 Subject: [PATCH] Document RenderDoc controlling API validation while active. Closes #1121 --- docs/getting_started/faq.rst | 11 ++++++++++- docs/window/capture_attach.rst | 2 ++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/getting_started/faq.rst b/docs/getting_started/faq.rst index 07c39f26d..adb6bb7eb 100644 --- a/docs/getting_started/faq.rst +++ b/docs/getting_started/faq.rst @@ -236,4 +236,13 @@ If you don't want this to happen and you'd prefer OpenGL ES to be ignored during .. note:: - This toggle only has effect on windows. On other platforms GLES is always natively captured as it is expected to have system-level support rather than being emulated. \ No newline at end of file + This toggle only has effect on windows. On other platforms GLES is always natively captured as it is expected to have system-level support rather than being emulated. + +When I launch my application through RenderDoc, why can't I access the API validation? +-------------------------------------------------------------------------------------- + +API validation layers are controlled by RenderDoc when it's active. This means that enabling the API validation from your application will have no effect, it will be controlled by the ``Enable API Validation`` capture option. For more information see :ref:`capture-options`. + +.. note:: + + On D3D11 if you know what you are doing you can access the underlying ``ID3D11InfoQueue`` using the separate UUID ``{3FC4E618-3F70-452A-8B8F-A73ACCB58E3D}``. Be aware that accessing this interface is done at your own risk and may break the RenderDoc capture. If you need to use the API validation directly it's recommended that you do so without RenderDoc active. diff --git a/docs/window/capture_attach.rst b/docs/window/capture_attach.rst index fdf800f4c..9728f493a 100644 --- a/docs/window/capture_attach.rst +++ b/docs/window/capture_attach.rst @@ -56,6 +56,8 @@ A list of processes is fetched once when the dialog is opened, but this can be r Injecting: Injecting into an already-running process via RenderDoc. +.. _capture-options: + Capture Options ---------------