Add support for debug labels and query if tool cares about it.

Author: Themaister

vulkan/command_buffer.cpp

@@ -3086,35 +3086,52 @@ void CommandBuffer::end()
 		device->request_staging_block_nolock(staging_block, 0);
 }
 
-void CommandBuffer::begin_region(const char *name, const float *color)
+void CommandBuffer::insert_label(const char *name, const float *color)
 {
-	if (device->ext.supports_debug_utils)
-	{
-		VkDebugUtilsLabelEXT info = { VK_STRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT };
-		if (color)
-		{
-			for (unsigned i = 0; i < 4; i++)
-				info.color[i] = color[i];
-		}
-		else
-		{
-			for (unsigned i = 0; i < 4; i++)
-				info.color[i] = 1.0f;
-		}
+	if (!device->ext.supports_debug_utils || !vkCmdInsertDebugUtilsLabelEXT)
+		return;
 
-		info.pLabelName = name;
-		if (vkCmdBeginDebugUtilsLabelEXT)
-			vkCmdBeginDebugUtilsLabelEXT(cmd, &info);
+	VkDebugUtilsLabelEXT info = { VK_STRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT };
+	if (color)
+	{
+		for (unsigned i = 0; i < 4; i++)
+			info.color[i] = color[i];
+	}
+	else
+	{
+		for (unsigned i = 0; i < 4; i++)
+			info.color[i] = 1.0f;
 	}
+
+	info.pLabelName = name;
+	vkCmdInsertDebugUtilsLabelEXT(cmd, &info);
 }
 
-void CommandBuffer::end_region()
+void CommandBuffer::begin_region(const char *name, const float *color)
 {
-	if (device->ext.supports_debug_utils)
+	if (!device->ext.supports_debug_utils || !vkCmdBeginDebugUtilsLabelEXT)
+		return;
+
+	VkDebugUtilsLabelEXT info = { VK_STRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT };
+	if (color)
+	{
+		for (unsigned i = 0; i < 4; i++)
+			info.color[i] = color[i];
+	}
+	else
 	{
-		if (vkCmdEndDebugUtilsLabelEXT)
-			vkCmdEndDebugUtilsLabelEXT(cmd);
+		for (unsigned i = 0; i < 4; i++)
+			info.color[i] = 1.0f;
 	}
+
+	info.pLabelName = name;
+	vkCmdBeginDebugUtilsLabelEXT(cmd, &info);
+}
+
+void CommandBuffer::end_region()
+{
+	if (device->ext.supports_debug_utils && vkCmdEndDebugUtilsLabelEXT)
+		vkCmdEndDebugUtilsLabelEXT(cmd);
 }
 
 void CommandBuffer::enable_profiling()

vulkan/command_buffer.hpp

@@ -301,6 +301,7 @@ class CommandBuffer : public Util::IntrusivePtrEnabled<CommandBuffer, CommandBuf
 	}
 
 	void begin_region(const char *name, const float *color = nullptr);
+	void insert_label(const char *name, const float *color = nullptr);
 	void end_region();
 
 	Device &get_device()

vulkan/device.cpp

@@ -912,6 +912,12 @@ void Device::init_workarounds()
 				LOGI("Detected non-profiling tracing tool, forcing host cached memory types for performance.\n");
 				workarounds.force_host_cached = true;
 			}
+
+			if (!debug_marker_sensitive && (t.purposes & VK_TOOL_PURPOSE_DEBUG_MARKERS_BIT_EXT) != 0)
+			{
+				LOGI("Detected tool which cares about debug markers.\n");
+				debug_marker_sensitive = true;
+			}
 		}
 	}
 }

vulkan/device.hpp

@@ -479,6 +479,11 @@ class Device
 		return ext;
 	}
 
+	bool consumes_debug_markers() const
+	{
+		return debug_marker_sensitive;
+	}
+
 	bool swapchain_touched() const;
 
 	double convert_device_timestamp_delta(uint64_t start_ticks, uint64_t end_ticks) const;
@@ -544,6 +549,7 @@ class Device
 	VkPhysicalDeviceProperties gpu_props;
 
 	DeviceFeatures ext;
+	bool debug_marker_sensitive = false;
 	void init_stock_samplers();
 	void init_stock_sampler(StockSampler sampler, float max_aniso, float lod_bias);
 	void init_timeline_semaphores();