lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-05-04 17:10:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document what RENDERDOC_DevicePointer should be for D3D12

Browse Source
This commit is contained in:
baldurk
2019-04-26 13:57:16 +01:00
parent 1296f92a94
commit af53fdf89a
1 changed files with 1 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/in_application_api.rst
+1
View File
@@ -370,6 +370,7 @@ The path follows the template set in :cpp:func:`SetCaptureFilePathTemplate` so i
``RENDERDOC_DevicePointer`` is a typedef to ``void *``. The contents of it are API specific:
* For D3D11 it must be the ``ID3D11Device`` device object.
* For D3D12 it must be the ``ID3D12Device`` device object.
* For OpenGL it must be the ``HGLRC`` or ``GLXContext`` context object.
* For Vulkan it must be the dispatch table pointer within the ``VkInstance``. This is a pointer-sized value at the location pointed to by the ``VkInstance``. NOTE - this is not the actual ``VkInstance`` pointer itself. You can use the RENDERDOC_DEVICEPOINTER_FROM_VKINSTANCE helper macro defined in the renderdoc header to obtain this pointer from any VkInstance.