Draft: Initial debug utils naming implementation

include/vsg/state/GraphicsPipeline.h

@@ -92,7 +92,7 @@ namespace vsg
 
         struct Implementation : public Inherit<Object, Implementation>
         {
-            Implementation(Context& context, Device* device, const RenderPass* renderPass, const PipelineLayout* pipelineLayout, const ShaderStages& shaderStages, const GraphicsPipelineStates& pipelineStates, uint32_t subpass);
+            Implementation(Context& context, Device* device, const RenderPass* renderPass, const PipelineLayout* pipelineLayout, const ShaderStages& shaderStages, const GraphicsPipelineStates& pipelineStates, uint32_t subpass, const GraphicsPipeline& parent);
 
             virtual ~Implementation();
 

include/vsg/state/PipelineLayout.h

@@ -55,7 +55,7 @@ namespace vsg
 
         struct Implementation : public Inherit<Object, Implementation>
         {
-            Implementation(Device* device, const DescriptorSetLayouts& descriptorSetLayouts, const PushConstantRanges& pushConstantRanges, VkPipelineLayoutCreateFlags flags = 0);
+            Implementation(Device* device, const DescriptorSetLayouts& descriptorSetLayouts, const PushConstantRanges& pushConstantRanges, const PipelineLayout& parent, VkPipelineLayoutCreateFlags flags = 0);
 
             virtual ~Implementation();
 

src/vsg/io/glsl.cpp

@@ -58,6 +58,8 @@ ref_ptr<Object> glsl::createShader(const Path& found_filename, std::string& sour
 
     auto sm = ShaderModule::create(source);
 
+    sm->setValue("DebugUtilsName", found_filename.string());
+
     if (stageFlagBits != VK_SHADER_STAGE_ALL)
     {
         return ShaderStage::create(stageFlagBits, "main", sm);

src/vsg/state/GraphicsPipeline.cpp

@@ -188,15 +188,15 @@ void GraphicsPipeline::compile(Context& context)
             shaderStage->compile(context);
         }
 
-        _implementation[viewID] = GraphicsPipeline::Implementation::create(context, context.device, context.renderPass, layout, stages, combined_pipelineStates, subpass);
+        _implementation[viewID] = GraphicsPipeline::Implementation::create(context, context.device, context.renderPass, layout, stages, combined_pipelineStates, subpass, *this);
     }
 }
 
 ////////////////////////////////////////////////////////////////////////
 //
 // GraphicsPipeline::Implementation
 //
-GraphicsPipeline::Implementation::Implementation(Context& context, Device* device, const RenderPass* renderPass, const PipelineLayout* pipelineLayout, const ShaderStages& shaderStages, const GraphicsPipelineStates& pipelineStates, uint32_t subpass) :
+GraphicsPipeline::Implementation::Implementation(Context& context, Device* device, const RenderPass* renderPass, const PipelineLayout* pipelineLayout, const ShaderStages& shaderStages, const GraphicsPipelineStates& pipelineStates, uint32_t subpass, const GraphicsPipeline& parent) :
     _pipelineStates(pipelineStates),
     _device(device)
 {
@@ -238,6 +238,21 @@ GraphicsPipeline::Implementation::Implementation(Context& context, Device* devic
     {
         throw Exception{"Error: vsg::GraphicsPipeline failed to create VkPipeline.", result};
     }
+
+    if (isExtensionSupported(VK_EXT_DEBUG_UTILS_EXTENSION_NAME) && device->getInstance()->getExtensions()->vkSetDebugUtilsObjectNameEXT)
+    {
+        std::string name = "A GraphicsPipeline";
+        parent.getValue("DebugUtilsName", name);
+        std::stringstream nameStream;
+        nameStream << name << " (" << std::hex << _pipeline << ")";
+        name = nameStream.str();
+        VkDebugUtilsObjectNameInfoEXT nameInfo = {};
+        nameInfo.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT;
+        nameInfo.objectType = VK_OBJECT_TYPE_PIPELINE;
+        nameInfo.objectHandle = reinterpret_cast<uint64_t>(_pipeline);
+        nameInfo.pObjectName = name.c_str();
+        device->getInstance()->getExtensions()->vkSetDebugUtilsObjectNameEXT(*device, &nameInfo);
+    }
 }
 
 GraphicsPipeline::Implementation::~Implementation()

src/vsg/state/PipelineLayout.cpp

@@ -107,15 +107,15 @@ void PipelineLayout::compile(Context& context)
         {
             if (dsl) dsl->compile(context);
         }
-        _implementation[context.deviceID] = PipelineLayout::Implementation::create(context.device, setLayouts, pushConstantRanges, flags);
+        _implementation[context.deviceID] = PipelineLayout::Implementation::create(context.device, setLayouts, pushConstantRanges, *this, flags);
     }
 }
 
 //////////////////////////////////////
 //
 // PipelineLayout::Implementation
 //
-PipelineLayout::Implementation::Implementation(Device* device, const DescriptorSetLayouts& descriptorSetLayouts, const PushConstantRanges& pushConstantRanges, VkPipelineLayoutCreateFlags flags) :
+PipelineLayout::Implementation::Implementation(Device* device, const DescriptorSetLayouts& descriptorSetLayouts, const PushConstantRanges& pushConstantRanges, const PipelineLayout& parent, VkPipelineLayoutCreateFlags flags) :
     _device(device)
 {
     std::vector<VkDescriptorSetLayout> layouts;
@@ -140,6 +140,21 @@ PipelineLayout::Implementation::Implementation(Device* device, const DescriptorS
     {
         throw Exception{"Error: Failed to create PipelineLayout.", result};
     }
+
+    if (isExtensionSupported(VK_EXT_DEBUG_UTILS_EXTENSION_NAME) && device->getInstance()->getExtensions()->vkSetDebugUtilsObjectNameEXT)
+    {
+        std::string name = "A PipelineLayout";
+        parent.getValue("DebugUtilsName", name);
+        std::stringstream nameStream;
+        nameStream << name << " (" << std::hex << _pipelineLayout << ")";
+        name = nameStream.str();
+        VkDebugUtilsObjectNameInfoEXT nameInfo = {};
+        nameInfo.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT;
+        nameInfo.objectType = VK_OBJECT_TYPE_PIPELINE_LAYOUT;
+        nameInfo.objectHandle = reinterpret_cast<uint64_t>(_pipelineLayout);
+        nameInfo.pObjectName = name.c_str();
+        device->getInstance()->getExtensions()->vkSetDebugUtilsObjectNameEXT(*device, &nameInfo);
+    }
 }
 
 PipelineLayout::Implementation::~Implementation()

src/vsg/state/ShaderModule.cpp

@@ -166,6 +166,35 @@ ShaderModule::Implementation::Implementation(Device* device, ShaderModule* shade
     {
         throw Exception{"Error: vsg::ShaderModule::create(...) failed to create shader module.", result};
     }
+
+    if (isExtensionSupported(VK_EXT_DEBUG_UTILS_EXTENSION_NAME) && device->getInstance()->getExtensions()->vkSetDebugUtilsObjectNameEXT)
+    {
+        std::string name = "A shader module";
+        shaderModule->getValue("DebugUtilsName", name);
+        std::stringstream nameStream;
+        nameStream << name;
+        if (shaderModule->hints && !shaderModule->hints->defines.empty())
+        {
+            nameStream << " with defines: ";
+            for (const auto& define : shaderModule->hints->defines)
+            {
+                nameStream << define << " ";
+            }
+        }
+        else
+        {
+            nameStream << " ";
+        }
+        nameStream << "(" << std::hex << _shaderModule << ")";
+        name = nameStream.str();
+
+        VkDebugUtilsObjectNameInfoEXT nameInfo = {};
+        nameInfo.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT;
+        nameInfo.objectType = VK_OBJECT_TYPE_SHADER_MODULE;
+        nameInfo.objectHandle = reinterpret_cast<uint64_t>(_shaderModule);
+        nameInfo.pObjectName = name.c_str();
+        device->getInstance()->getExtensions()->vkSetDebugUtilsObjectNameEXT(*device, &nameInfo);
+    }
 }
 
 ShaderModule::Implementation::~Implementation()