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

Update docs to reference VK_EXT_debug_utils

Browse Source 
* VK_EXT_debug_marker still works fine but is deprecated.
This commit is contained in:
baldurk
2021-01-27 13:03:16 +00:00
parent 3f637e0d9b
commit ae96b674c9
2 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/how/how_view_texture.rst
+8 -8
View File
@@ -45,25 +45,25 @@ In OpenGL this can be done with ``GL_KHR_debug`` - ``glObjectLabel``.
// apply the name, -1 means NULL terminated
glObjectLabel(GL_TEXTURE, tex2d, -1, "Example Texture");
In Vulkan you can enable the ``VK_EXT_debug_marker`` extension, which is provided by RenderDoc, and use the ``vkDebugMarkerSetObjectNameEXT`` function.
In Vulkan you can enable the ``VK_EXT_debug_utils`` extension, which is provided by RenderDoc, and use the ``vkSetDebugUtilsObjectNameEXT`` function.
.. highlight:: c++
.. code:: c++
// At creation time, request the VK_EXT_debug_marker extension and
// use vkGetInstanceProcAddr to obtain vkDebugMarkerSetObjectNameEXT
// At instance creation time, request the VK_EXT_debug_utils extension and
// use vkGetInstanceProcAddr to obtain vkSetDebugUtilsObjectNameEXT
// create the image
VkImage tex2d;
vkCreateImage(device, &createInfo, NULL, &tex2d);
// set the name
VkDebugMarkerObjectNameInfoEXT nameInfo = {};
nameInfo.sType = VK_STRUCTURE_TYPE_DEBUG_MARKER_OBJECT_NAME_INFO_EXT;
nameInfo.objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
nameInfo.object = (uint64_t)tex2d; // this cast may vary by platform/compiler
VkDebugUtilsObjectNameInfoEXT nameInfo = {};
nameInfo.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT;
nameInfo.objectType = VK_OBJECT_TYPE_IMAGE;
nameInfo.objectHandle = (uint64_t)tex2d; // this cast may vary by platform/compiler
nameInfo.pObjectName = "Off-screen color framebuffer";
vkDebugMarkerSetObjectNameEXT(device, &nameInfo);
vkSetDebugUtilsObjectNameEXT(device, &nameInfo);
When this texture is bound to the pipeline it will be listed like so:
docs/window/event_browser.rst
+6 -6
View File
@@ -45,7 +45,7 @@ OpenGL can make use of the ``KHR_debug`` extension:
glPopDebugGroupKHR();
Vulkan can use the ``VK_EXT_debug_marker`` extension:
Vulkan can use the ``VK_EXT_debug_utils`` extension:
.. highlight:: c++
.. code:: c++
@@ -54,14 +54,14 @@ Vulkan can use the ``VK_EXT_debug_marker`` extension:
VkCommandBuffer cmd = ...;
VkDebugMarkerMarkerInfoEXT markerInfo = {};
markerInfo.sType = VK_STRUCTURE_TYPE_DEBUG_MARKER_MARKER_INFO_EXT;
markerInfo.pMarkerName = "Begin Section";
vkCmdDebugMarkerBeginEXT(cmd, &markerInfo);
VkDebugUtilsLabelEXT markerInfo = {};
markerInfo.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT;
markerInfo.pLabelName = "Begin Section";
vkCmdBeginDebugUtilsLabelEXT(cmd, &markerInfo);
// contents of section here
vkCmdDebugMarkerEndEXT(cmd);
vkCmdEndDebugUtilsLabelEXT(cmd);
Selecting available columns
---------------------------