Skip to content

Commit ae96b67

Browse files
committed
Update docs to reference VK_EXT_debug_utils
* VK_EXT_debug_marker still works fine but is deprecated.
1 parent 3f637e0 commit ae96b67

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

docs/how/how_view_texture.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,25 +45,25 @@ In OpenGL this can be done with ``GL_KHR_debug`` - ``glObjectLabel``.
4545
// apply the name, -1 means NULL terminated
4646
glObjectLabel(GL_TEXTURE, tex2d, -1, "Example Texture");
4747

48-
In Vulkan you can enable the ``VK_EXT_debug_marker`` extension, which is provided by RenderDoc, and use the ``vkDebugMarkerSetObjectNameEXT`` function.
48+
In Vulkan you can enable the ``VK_EXT_debug_utils`` extension, which is provided by RenderDoc, and use the ``vkSetDebugUtilsObjectNameEXT`` function.
4949

5050
.. highlight:: c++
5151
.. code:: c++
5252

53-
// At creation time, request the VK_EXT_debug_marker extension and
54-
// use vkGetInstanceProcAddr to obtain vkDebugMarkerSetObjectNameEXT
53+
// At instance creation time, request the VK_EXT_debug_utils extension and
54+
// use vkGetInstanceProcAddr to obtain vkSetDebugUtilsObjectNameEXT
5555

5656
// create the image
5757
VkImage tex2d;
5858
vkCreateImage(device, &createInfo, NULL, &tex2d);
5959

6060
// set the name
61-
VkDebugMarkerObjectNameInfoEXT nameInfo = {};
62-
nameInfo.sType = VK_STRUCTURE_TYPE_DEBUG_MARKER_OBJECT_NAME_INFO_EXT;
63-
nameInfo.objectType = VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT;
64-
nameInfo.object = (uint64_t)tex2d; // this cast may vary by platform/compiler
61+
VkDebugUtilsObjectNameInfoEXT nameInfo = {};
62+
nameInfo.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT;
63+
nameInfo.objectType = VK_OBJECT_TYPE_IMAGE;
64+
nameInfo.objectHandle = (uint64_t)tex2d; // this cast may vary by platform/compiler
6565
nameInfo.pObjectName = "Off-screen color framebuffer";
66-
vkDebugMarkerSetObjectNameEXT(device, &nameInfo);
66+
vkSetDebugUtilsObjectNameEXT(device, &nameInfo);
6767

6868
When this texture is bound to the pipeline it will be listed like so:
6969

docs/window/event_browser.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ OpenGL can make use of the ``KHR_debug`` extension:
4545

4646
glPopDebugGroupKHR();
4747

48-
Vulkan can use the ``VK_EXT_debug_marker`` extension:
48+
Vulkan can use the ``VK_EXT_debug_utils`` extension:
4949

5050
.. highlight:: c++
5151
.. code:: c++
@@ -54,14 +54,14 @@ Vulkan can use the ``VK_EXT_debug_marker`` extension:
5454

5555
VkCommandBuffer cmd = ...;
5656

57-
VkDebugMarkerMarkerInfoEXT markerInfo = {};
58-
markerInfo.sType = VK_STRUCTURE_TYPE_DEBUG_MARKER_MARKER_INFO_EXT;
59-
markerInfo.pMarkerName = "Begin Section";
60-
vkCmdDebugMarkerBeginEXT(cmd, &markerInfo);
57+
VkDebugUtilsLabelEXT markerInfo = {};
58+
markerInfo.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT;
59+
markerInfo.pLabelName = "Begin Section";
60+
vkCmdBeginDebugUtilsLabelEXT(cmd, &markerInfo);
6161

6262
// contents of section here
6363

64-
vkCmdDebugMarkerEndEXT(cmd);
64+
vkCmdEndDebugUtilsLabelEXT(cmd);
6565

6666
Selecting available columns
6767
---------------------------

0 commit comments

Comments
 (0)