From 9df5e5a03f7ce5096ceae08b9801e143101e550f Mon Sep 17 00:00:00 2001 From: Tim Moore Date: Tue, 28 Nov 2023 17:10:14 +0000 Subject: [PATCH 1/9] Add support for VK_EXT_debug_utils extension Load pointer to its functions into the vsg::Instance object --- include/vsg/app/WindowTraits.h | 3 ++- include/vsg/vk/Instance.h | 13 ++++++++++++- src/vsg/app/WindowTraits.cpp | 9 +++++++-- src/vsg/vk/Instance.cpp | 22 ++++++++++++++++++++++ 4 files changed, 43 insertions(+), 4 deletions(-) diff --git a/include/vsg/app/WindowTraits.h b/include/vsg/app/WindowTraits.h index 1441b3a5d7..4f6b063dc4 100644 --- a/include/vsg/app/WindowTraits.h +++ b/include/vsg/app/WindowTraits.h @@ -91,7 +91,8 @@ namespace vsg std::any nativeWindow; std::any systemConnection; - + // Load function pointers for the VK_EXT_debug_utils extension, if it is available. + bool debugUtils = false; protected: virtual ~WindowTraits() {} }; diff --git a/include/vsg/vk/Instance.h b/include/vsg/vk/Instance.h index 2b8fce3c68..6b5e551c7c 100644 --- a/include/vsg/vk/Instance.h +++ b/include/vsg/vk/Instance.h @@ -78,7 +78,18 @@ namespace vsg if (pNameFallback) procAddress = reinterpret_cast(vkGetInstanceProcAddr(_instance, pNameFallback)); return (procAddress); } - + // VK_EXT_debug_utils + PFN_vkSetDebugUtilsObjectNameEXT vkSetDebugUtilsObjectNameEXT = nullptr; + PFN_vkSetDebugUtilsObjectTagEXT vkSetDebugUtilsObjectTagEXT = nullptr; + PFN_vkQueueBeginDebugUtilsLabelEXT vkQueueBeginDebugUtilsLabelEXT = nullptr; + PFN_vkQueueEndDebugUtilsLabelEXT vkQueueEndDebugUtilsLabelEXT = nullptr; + PFN_vkQueueInsertDebugUtilsLabelEXT vkQueueInsertDebugUtilsLabelEXT = nullptr; + PFN_vkCmdBeginDebugUtilsLabelEXT vkCmdBeginDebugUtilsLabelEXT = nullptr; + PFN_vkCmdEndDebugUtilsLabelEXT vkCmdEndDebugUtilsLabelEXT = nullptr; + PFN_vkCmdInsertDebugUtilsLabelEXT vkCmdInsertDebugUtilsLabelEXT = nullptr; + PFN_vkCreateDebugUtilsMessengerEXT vkCreateDebugUtilsMessengerEXT = nullptr; + PFN_vkDestroyDebugUtilsMessengerEXT vkDestroyDebugUtilsMessengerEXT = nullptr; + PFN_vkSubmitDebugUtilsMessageEXT vkSubmitDebugUtilsMessageEXT = nullptr; protected: virtual ~Instance(); diff --git a/src/vsg/app/WindowTraits.cpp b/src/vsg/app/WindowTraits.cpp index fc6f809a78..fa27f25021 100644 --- a/src/vsg/app/WindowTraits.cpp +++ b/src/vsg/app/WindowTraits.cpp @@ -13,6 +13,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI #include #include #include +#include #include using namespace vsg; @@ -50,7 +51,8 @@ WindowTraits::WindowTraits(const WindowTraits& traits) : deviceExtensionNames(traits.deviceExtensionNames), deviceTypePreferences(traits.deviceTypePreferences), deviceFeatures(traits.deviceFeatures), - samples(traits.samples) /*, + samples(traits.samples), + debugUtils(traits.debugUtils) /*, nativeWindow(traits.nativeWindow), systemConnection(traits.systemConnection)*/ { @@ -104,7 +106,10 @@ void WindowTraits::validate() { instanceExtensionNames.push_back(VK_EXT_DEBUG_REPORT_EXTENSION_NAME); } - + if (debugUtils && isExtensionSupported(VK_EXT_DEBUG_UTILS_EXTENSION_NAME)) + { + instanceExtensionNames.push_back(VK_EXT_DEBUG_UTILS_EXTENSION_NAME); + } if (debugLayer) requestedLayers.push_back("VK_LAYER_KHRONOS_validation"); if (apiDumpLayer) requestedLayers.push_back("VK_LAYER_LUNARG_api_dump"); if (synchronizationLayer) requestedLayers.push_back("VK_LAYER_KHRONOS_synchronization2"); diff --git a/src/vsg/vk/Instance.cpp b/src/vsg/vk/Instance.cpp index 0d89bc56cc..8d97d2b861 100644 --- a/src/vsg/vk/Instance.cpp +++ b/src/vsg/vk/Instance.cpp @@ -17,7 +17,9 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI #include #include +#include #include +#include using namespace vsg; @@ -129,6 +131,26 @@ Instance::Instance(Names instanceExtensions, Names layers, uint32_t vulkanApiVer { _physicalDevices.emplace_back(new PhysicalDevice(this, device)); } + if (isExtensionSupported(VK_EXT_DEBUG_UTILS_EXTENSION_NAME) + && std::any_of(instanceExtensions.begin(), instanceExtensions.end(), + [](auto&& extName) + { + return !strncmp(extName, VK_EXT_DEBUG_UTILS_EXTENSION_NAME, + VK_MAX_EXTENSION_NAME_SIZE); + })) + { + getProcAddr(vkSetDebugUtilsObjectNameEXT, "vkSetDebugUtilsObjectNameEXT"); + getProcAddr(vkSetDebugUtilsObjectTagEXT, "vkSetDebugUtilsObjectTagEXT"); + getProcAddr(vkQueueBeginDebugUtilsLabelEXT, "vkQueueBeginDebugUtilsLabelEXT"); + getProcAddr(vkQueueEndDebugUtilsLabelEXT, "vkQueueEndDebugUtilsLabelEXT"); + getProcAddr(vkQueueInsertDebugUtilsLabelEXT, "vkQueueInsertDebugUtilsLabelEXT"); + getProcAddr(vkCmdBeginDebugUtilsLabelEXT, "vkCmdBeginDebugUtilsLabelEXT"); + getProcAddr(vkCmdEndDebugUtilsLabelEXT, "vkCmdEndDebugUtilsLabelEXT"); + getProcAddr(vkCmdInsertDebugUtilsLabelEXT, "vkCmdInsertDebugUtilsLabelEXT"); + getProcAddr(vkCreateDebugUtilsMessengerEXT, "vkCreateDebugUtilsMessengerEXT"); + getProcAddr(vkDestroyDebugUtilsMessengerEXT, "vkDestroyDebugUtilsMessengerEXT"); + getProcAddr(vkSubmitDebugUtilsMessageEXT, "vkSubmitDebugUtilsMessageEXT"); + } } else { From fcb9e0bed90741705d05649c8027f551c49b207c Mon Sep 17 00:00:00 2001 From: Tim Moore Date: Tue, 28 Nov 2023 17:45:42 +0000 Subject: [PATCH 2/9] Add VK_EXT_debug_utils definitions to vulkan.h I don't know when this extension was added, but it is fairly new. --- include/vsg/vk/vulkan.h | 82 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) diff --git a/include/vsg/vk/vulkan.h b/include/vsg/vk/vulkan.h index b25ab3a9c5..0aefd7c46e 100644 --- a/include/vsg/vk/vulkan.h +++ b/include/vsg/vk/vulkan.h @@ -838,3 +838,85 @@ typedef struct VkPhysicalDevicePortabilitySubsetPropertiesKHR { uint32_t minVertexInputBindingStrideAlignment; } VkPhysicalDevicePortabilitySubsetPropertiesKHR; #endif + +#ifndef VK_EXT_debug_utils +#define VK_EXT_debug_utils 1 +VK_DEFINE_NON_DISPATCHABLE_HANDLE(VkDebugUtilsMessengerEXT) +#define VK_EXT_DEBUG_UTILS_SPEC_VERSION 2 +#define VK_EXT_DEBUG_UTILS_EXTENSION_NAME "VK_EXT_debug_utils" +typedef VkFlags VkDebugUtilsMessengerCallbackDataFlagsEXT; + +typedef enum VkDebugUtilsMessageSeverityFlagBitsEXT { + VK_DEBUG_UTILS_MESSAGE_SEVERITY_VERBOSE_BIT_EXT = 0x00000001, + VK_DEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXT = 0x00000010, + VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT = 0x00000100, + VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT = 0x00001000, + VK_DEBUG_UTILS_MESSAGE_SEVERITY_FLAG_BITS_MAX_ENUM_EXT = 0x7FFFFFFF +} VkDebugUtilsMessageSeverityFlagBitsEXT; + +typedef enum VkDebugUtilsMessageTypeFlagBitsEXT { + VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT = 0x00000001, + VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT = 0x00000002, + VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT = 0x00000004, + VK_DEBUG_UTILS_MESSAGE_TYPE_DEVICE_ADDRESS_BINDING_BIT_EXT = 0x00000008, + VK_DEBUG_UTILS_MESSAGE_TYPE_FLAG_BITS_MAX_ENUM_EXT = 0x7FFFFFFF +} VkDebugUtilsMessageTypeFlagBitsEXT; +typedef VkFlags VkDebugUtilsMessageTypeFlagsEXT; +typedef VkFlags VkDebugUtilsMessageSeverityFlagsEXT; +typedef VkFlags VkDebugUtilsMessengerCreateFlagsEXT; +typedef struct VkDebugUtilsLabelEXT { + VkStructureType sType; + const void* pNext; + const char* pLabelName; + float color[4]; +} VkDebugUtilsLabelEXT; + +typedef struct VkDebugUtilsObjectNameInfoEXT { + VkStructureType sType; + const void* pNext; + VkObjectType objectType; + uint64_t objectHandle; + const char* pObjectName; +} VkDebugUtilsObjectNameInfoEXT; + +typedef struct VkDebugUtilsMessengerCallbackDataEXT { + VkStructureType sType; + const void* pNext; + VkDebugUtilsMessengerCallbackDataFlagsEXT flags; + const char* pMessageIdName; + int32_t messageIdNumber; + const char* pMessage; + uint32_t queueLabelCount; + const VkDebugUtilsLabelEXT* pQueueLabels; + uint32_t cmdBufLabelCount; + const VkDebugUtilsLabelEXT* pCmdBufLabels; + uint32_t objectCount; + const VkDebugUtilsObjectNameInfoEXT* pObjects; +} VkDebugUtilsMessengerCallbackDataEXT; + +typedef VkBool32 (VKAPI_PTR *PFN_vkDebugUtilsMessengerCallbackEXT)( + VkDebugUtilsMessageSeverityFlagBitsEXT messageSeverity, + VkDebugUtilsMessageTypeFlagsEXT messageTypes, + const VkDebugUtilsMessengerCallbackDataEXT* pCallbackData, + void* pUserData); + +typedef struct VkDebugUtilsMessengerCreateInfoEXT { + VkStructureType sType; + const void* pNext; + VkDebugUtilsMessengerCreateFlagsEXT flags; + VkDebugUtilsMessageSeverityFlagsEXT messageSeverity; + VkDebugUtilsMessageTypeFlagsEXT messageType; + PFN_vkDebugUtilsMessengerCallbackEXT pfnUserCallback; + void* pUserData; +} VkDebugUtilsMessengerCreateInfoEXT; + +typedef struct VkDebugUtilsObjectTagInfoEXT { + VkStructureType sType; + const void* pNext; + VkObjectType objectType; + uint64_t objectHandle; + uint64_t tagName; + size_t tagSize; + const void* pTag; +} VkDebugUtilsObjectTagInfoEXT; +#endif From 3709868ed6dc163c48fed991122db3b1a3001a74 Mon Sep 17 00:00:00 2001 From: Robert Osfield Date: Wed, 29 Nov 2023 10:39:55 +0000 Subject: [PATCH 3/9] Repositioned to add readability and added comments --- include/vsg/app/WindowTraits.h | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/include/vsg/app/WindowTraits.h b/include/vsg/app/WindowTraits.h index 4f6b063dc4..bd26478bcd 100644 --- a/include/vsg/app/WindowTraits.h +++ b/include/vsg/app/WindowTraits.h @@ -69,9 +69,11 @@ namespace vsg std::vector queuePiorities{1.0, 0.0}; VkPipelineStageFlagBits imageAvailableSemaphoreWaitFlag = VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT; - bool debugLayer = false; - bool synchronizationLayer = false; - bool apiDumpLayer = false; + // hints to which extenstion to enable during Instance/Device setup + bool debugLayer = false; // VK_LAYER_KHRONOS_validation + bool synchronizationLayer = false; // VK_LAYER_KHRONOS_synchronization2 + bool apiDumpLayer = false; // VK_LAYER_LUNARG_api_dump + bool debugUtils = false; // VK_EXT_debug_utils // Device to use, if not assigned use the device preferences below ref_ptr device; @@ -91,8 +93,7 @@ namespace vsg std::any nativeWindow; std::any systemConnection; - // Load function pointers for the VK_EXT_debug_utils extension, if it is available. - bool debugUtils = false; + protected: virtual ~WindowTraits() {} }; From bbaca13fdfce53c5aa13070183eb972f77f3c4d9 Mon Sep 17 00:00:00 2001 From: Robert Osfield Date: Wed, 29 Nov 2023 10:43:07 +0000 Subject: [PATCH 4/9] Chaned ordering to reflect new ordering of members variables --- src/vsg/app/WindowTraits.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/vsg/app/WindowTraits.cpp b/src/vsg/app/WindowTraits.cpp index fa27f25021..04b704f485 100644 --- a/src/vsg/app/WindowTraits.cpp +++ b/src/vsg/app/WindowTraits.cpp @@ -45,14 +45,14 @@ WindowTraits::WindowTraits(const WindowTraits& traits) : imageAvailableSemaphoreWaitFlag(traits.imageAvailableSemaphoreWaitFlag), debugLayer(traits.debugLayer), apiDumpLayer(traits.apiDumpLayer), + debugUtils(traits.debugUtils), device(traits.device), instanceExtensionNames(traits.instanceExtensionNames), requestedLayers(traits.requestedLayers), deviceExtensionNames(traits.deviceExtensionNames), deviceTypePreferences(traits.deviceTypePreferences), deviceFeatures(traits.deviceFeatures), - samples(traits.samples), - debugUtils(traits.debugUtils) /*, + samples(traits.samples)/*, nativeWindow(traits.nativeWindow), systemConnection(traits.systemConnection)*/ { From 7b1d597ce43b137376339da835e13c01c2e64567 Mon Sep 17 00:00:00 2001 From: Robert Osfield Date: Wed, 29 Nov 2023 11:03:19 +0000 Subject: [PATCH 5/9] Moved the instance extensions into a dedicated InstanceExtensions struct --- include/vsg/vk/Device.h | 1 + include/vsg/vk/Extensions.h | 1 + include/vsg/vk/Instance.h | 18 ++++++------------ src/vsg/CMakeLists.txt | 1 + src/vsg/vk/Instance.cpp | 22 ++-------------------- 5 files changed, 11 insertions(+), 32 deletions(-) diff --git a/include/vsg/vk/Device.h b/include/vsg/vk/Device.h index 1171a4d71a..ea643e3747 100644 --- a/include/vsg/vk/Device.h +++ b/include/vsg/vk/Device.h @@ -57,6 +57,7 @@ namespace vsg ref_ptr getQueue(uint32_t queueFamilyIndex, uint32_t queueIndex = 0); + /// get the extensions structure that holds a range of function pointers to vkInstance extensions const Extensions* getExtensions() const { return _extensions.get(); } /// get the address of specified function using vkGetDeviceProcAddr diff --git a/include/vsg/vk/Extensions.h b/include/vsg/vk/Extensions.h index c29c3906e1..6d9773dbfb 100644 --- a/include/vsg/vk/Extensions.h +++ b/include/vsg/vk/Extensions.h @@ -52,5 +52,6 @@ namespace vsg PFN_vkCmdDrawMeshTasksIndirectEXT vkCmdDrawMeshTasksIndirectEXT = nullptr; PFN_vkCmdDrawMeshTasksIndirectCountEXT vkCmdDrawMeshTasksIndirectCountEXT = nullptr; }; + VSG_type_name(vsg::Extensions); } // namespace vsg diff --git a/include/vsg/vk/Instance.h b/include/vsg/vk/Instance.h index 6b5e551c7c..d21c72b4bb 100644 --- a/include/vsg/vk/Instance.h +++ b/include/vsg/vk/Instance.h @@ -14,6 +14,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI #include #include +#include #include @@ -68,6 +69,9 @@ namespace vsg /// get a PhysicalDevice and queue family index that supports the specified queueFlags, and presentation of specified surface if one is provided. std::tuple, int, int> getPhysicalDeviceAndQueueFamily(VkQueueFlags queueFlags, Surface* surface, const PhysicalDeviceTypes& deviceTypePreferences = {}) const; + /// get the extensions structure that holds a range of function pointers to vkInstance extensions + const InstanceExtensions* getExtensions() const { return _extensions.get(); } + /// get the address of specified function using vkGetInstanceProcAddr. template bool getProcAddr(T& procAddress, const char* pName, const char* pNameFallback = nullptr) const @@ -78,18 +82,6 @@ namespace vsg if (pNameFallback) procAddress = reinterpret_cast(vkGetInstanceProcAddr(_instance, pNameFallback)); return (procAddress); } - // VK_EXT_debug_utils - PFN_vkSetDebugUtilsObjectNameEXT vkSetDebugUtilsObjectNameEXT = nullptr; - PFN_vkSetDebugUtilsObjectTagEXT vkSetDebugUtilsObjectTagEXT = nullptr; - PFN_vkQueueBeginDebugUtilsLabelEXT vkQueueBeginDebugUtilsLabelEXT = nullptr; - PFN_vkQueueEndDebugUtilsLabelEXT vkQueueEndDebugUtilsLabelEXT = nullptr; - PFN_vkQueueInsertDebugUtilsLabelEXT vkQueueInsertDebugUtilsLabelEXT = nullptr; - PFN_vkCmdBeginDebugUtilsLabelEXT vkCmdBeginDebugUtilsLabelEXT = nullptr; - PFN_vkCmdEndDebugUtilsLabelEXT vkCmdEndDebugUtilsLabelEXT = nullptr; - PFN_vkCmdInsertDebugUtilsLabelEXT vkCmdInsertDebugUtilsLabelEXT = nullptr; - PFN_vkCreateDebugUtilsMessengerEXT vkCreateDebugUtilsMessengerEXT = nullptr; - PFN_vkDestroyDebugUtilsMessengerEXT vkDestroyDebugUtilsMessengerEXT = nullptr; - PFN_vkSubmitDebugUtilsMessageEXT vkSubmitDebugUtilsMessageEXT = nullptr; protected: virtual ~Instance(); @@ -97,6 +89,8 @@ namespace vsg ref_ptr _allocator; PhysicalDevices _physicalDevices; + + ref_ptr _extensions; }; VSG_type_name(vsg::Instance); diff --git a/src/vsg/CMakeLists.txt b/src/vsg/CMakeLists.txt index 188cfbe244..c959fb3ffd 100644 --- a/src/vsg/CMakeLists.txt +++ b/src/vsg/CMakeLists.txt @@ -204,6 +204,7 @@ set(SOURCES vk/Fence.cpp vk/Framebuffer.cpp vk/Instance.cpp + vk/InstanceExtensions.cpp vk/MemoryBufferPools.cpp vk/PhysicalDevice.cpp vk/Queue.cpp diff --git a/src/vsg/vk/Instance.cpp b/src/vsg/vk/Instance.cpp index 8d97d2b861..e8d132a300 100644 --- a/src/vsg/vk/Instance.cpp +++ b/src/vsg/vk/Instance.cpp @@ -131,31 +131,13 @@ Instance::Instance(Names instanceExtensions, Names layers, uint32_t vulkanApiVer { _physicalDevices.emplace_back(new PhysicalDevice(this, device)); } - if (isExtensionSupported(VK_EXT_DEBUG_UTILS_EXTENSION_NAME) - && std::any_of(instanceExtensions.begin(), instanceExtensions.end(), - [](auto&& extName) - { - return !strncmp(extName, VK_EXT_DEBUG_UTILS_EXTENSION_NAME, - VK_MAX_EXTENSION_NAME_SIZE); - })) - { - getProcAddr(vkSetDebugUtilsObjectNameEXT, "vkSetDebugUtilsObjectNameEXT"); - getProcAddr(vkSetDebugUtilsObjectTagEXT, "vkSetDebugUtilsObjectTagEXT"); - getProcAddr(vkQueueBeginDebugUtilsLabelEXT, "vkQueueBeginDebugUtilsLabelEXT"); - getProcAddr(vkQueueEndDebugUtilsLabelEXT, "vkQueueEndDebugUtilsLabelEXT"); - getProcAddr(vkQueueInsertDebugUtilsLabelEXT, "vkQueueInsertDebugUtilsLabelEXT"); - getProcAddr(vkCmdBeginDebugUtilsLabelEXT, "vkCmdBeginDebugUtilsLabelEXT"); - getProcAddr(vkCmdEndDebugUtilsLabelEXT, "vkCmdEndDebugUtilsLabelEXT"); - getProcAddr(vkCmdInsertDebugUtilsLabelEXT, "vkCmdInsertDebugUtilsLabelEXT"); - getProcAddr(vkCreateDebugUtilsMessengerEXT, "vkCreateDebugUtilsMessengerEXT"); - getProcAddr(vkDestroyDebugUtilsMessengerEXT, "vkDestroyDebugUtilsMessengerEXT"); - getProcAddr(vkSubmitDebugUtilsMessageEXT, "vkSubmitDebugUtilsMessageEXT"); - } } else { throw Exception{"Error: vsg::Instance::create(...) failed to create VkInstance.", result}; } + + _extensions = InstanceExtensions::create(this); } Instance::~Instance() From 1c8e282506e15076233656c5b703916bea2057b7 Mon Sep 17 00:00:00 2001 From: Robert Osfield Date: Wed, 29 Nov 2023 11:11:00 +0000 Subject: [PATCH 6/9] Added InstanceExtensions header and source. --- include/vsg/vk/InstanceExtensions.h | 43 +++++++++++++++++++++++++++++ src/vsg/vk/InstanceExtensions.cpp | 40 +++++++++++++++++++++++++++ 2 files changed, 83 insertions(+) create mode 100644 include/vsg/vk/InstanceExtensions.h create mode 100644 src/vsg/vk/InstanceExtensions.cpp diff --git a/include/vsg/vk/InstanceExtensions.h b/include/vsg/vk/InstanceExtensions.h new file mode 100644 index 0000000000..e1df36d658 --- /dev/null +++ b/include/vsg/vk/InstanceExtensions.h @@ -0,0 +1,43 @@ +#pragma once + +/* + +Copyright(c) 2023 Robert Osfield + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + */ + +#include + +namespace vsg +{ + class Instance; + + /// Extensions manages a set of Vulkan extension function pointers. + /// The vsg::Device "has a" Extensions object that can be accessed via device->getExtensions(). + class VSG_DECLSPEC InstanceExtensions : public Inherit + { + public: + explicit InstanceExtensions(Instance* instance); + + // VK_EXT_debug_utils + PFN_vkSetDebugUtilsObjectNameEXT vkSetDebugUtilsObjectNameEXT = nullptr; + PFN_vkSetDebugUtilsObjectTagEXT vkSetDebugUtilsObjectTagEXT = nullptr; + PFN_vkQueueBeginDebugUtilsLabelEXT vkQueueBeginDebugUtilsLabelEXT = nullptr; + PFN_vkQueueEndDebugUtilsLabelEXT vkQueueEndDebugUtilsLabelEXT = nullptr; + PFN_vkQueueInsertDebugUtilsLabelEXT vkQueueInsertDebugUtilsLabelEXT = nullptr; + PFN_vkCmdBeginDebugUtilsLabelEXT vkCmdBeginDebugUtilsLabelEXT = nullptr; + PFN_vkCmdEndDebugUtilsLabelEXT vkCmdEndDebugUtilsLabelEXT = nullptr; + PFN_vkCmdInsertDebugUtilsLabelEXT vkCmdInsertDebugUtilsLabelEXT = nullptr; + PFN_vkCreateDebugUtilsMessengerEXT vkCreateDebugUtilsMessengerEXT = nullptr; + PFN_vkDestroyDebugUtilsMessengerEXT vkDestroyDebugUtilsMessengerEXT = nullptr; + PFN_vkSubmitDebugUtilsMessageEXT vkSubmitDebugUtilsMessageEXT = nullptr; + }; + VSG_type_name(vsg::InstanceExtensions); + +} // namespace vsg diff --git a/src/vsg/vk/InstanceExtensions.cpp b/src/vsg/vk/InstanceExtensions.cpp new file mode 100644 index 0000000000..572bfe118e --- /dev/null +++ b/src/vsg/vk/InstanceExtensions.cpp @@ -0,0 +1,40 @@ +/* + +Copyright(c) 2018 Robert Osfield + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + */ + +#include +#include +#include +#include +#include + +#include +#include +#include + +using namespace vsg; + + +InstanceExtensions::InstanceExtensions(Instance* instance) +{ + // VK_EXT_DEBUG_UTILS_EXTENSION_NAME + instance->getProcAddr(vkSetDebugUtilsObjectNameEXT, "vkSetDebugUtilsObjectNameEXT"); + instance->getProcAddr(vkSetDebugUtilsObjectTagEXT, "vkSetDebugUtilsObjectTagEXT"); + instance->getProcAddr(vkQueueBeginDebugUtilsLabelEXT, "vkQueueBeginDebugUtilsLabelEXT"); + instance->getProcAddr(vkQueueEndDebugUtilsLabelEXT, "vkQueueEndDebugUtilsLabelEXT"); + instance->getProcAddr(vkQueueInsertDebugUtilsLabelEXT, "vkQueueInsertDebugUtilsLabelEXT"); + instance->getProcAddr(vkCmdBeginDebugUtilsLabelEXT, "vkCmdBeginDebugUtilsLabelEXT"); + instance->getProcAddr(vkCmdEndDebugUtilsLabelEXT, "vkCmdEndDebugUtilsLabelEXT"); + instance->getProcAddr(vkCmdInsertDebugUtilsLabelEXT, "vkCmdInsertDebugUtilsLabelEXT"); + instance->getProcAddr(vkCreateDebugUtilsMessengerEXT, "vkCreateDebugUtilsMessengerEXT"); + instance->getProcAddr(vkDestroyDebugUtilsMessengerEXT, "vkDestroyDebugUtilsMessengerEXT"); + instance->getProcAddr(vkSubmitDebugUtilsMessageEXT, "vkSubmitDebugUtilsMessageEXT"); +} From 8e43eb8c48e8bdad3dfcc7a98b54f29a913955c8 Mon Sep 17 00:00:00 2001 From: Robert Osfield Date: Wed, 29 Nov 2023 11:25:06 +0000 Subject: [PATCH 7/9] Added incldue for Windows build --- src/vsg/vk/InstanceExtensions.cpp | 1 + 1 file changed, 1 insertion(+) diff --git a/src/vsg/vk/InstanceExtensions.cpp b/src/vsg/vk/InstanceExtensions.cpp index 572bfe118e..fcdf26e783 100644 --- a/src/vsg/vk/InstanceExtensions.cpp +++ b/src/vsg/vk/InstanceExtensions.cpp @@ -15,6 +15,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI #include #include #include +#include #include #include From d53b0c3b8f2cd6a3fd8c0741e5797a4b0d85af48 Mon Sep 17 00:00:00 2001 From: Robert Osfield Date: Wed, 29 Nov 2023 11:39:18 +0000 Subject: [PATCH 8/9] Improved extension name --- src/vsg/vk/InstanceExtensions.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/vsg/vk/InstanceExtensions.cpp b/src/vsg/vk/InstanceExtensions.cpp index fcdf26e783..e930f71d1d 100644 --- a/src/vsg/vk/InstanceExtensions.cpp +++ b/src/vsg/vk/InstanceExtensions.cpp @@ -26,7 +26,7 @@ using namespace vsg; InstanceExtensions::InstanceExtensions(Instance* instance) { - // VK_EXT_DEBUG_UTILS_EXTENSION_NAME + // VK_EXT_debug_utils instance->getProcAddr(vkSetDebugUtilsObjectNameEXT, "vkSetDebugUtilsObjectNameEXT"); instance->getProcAddr(vkSetDebugUtilsObjectTagEXT, "vkSetDebugUtilsObjectTagEXT"); instance->getProcAddr(vkQueueBeginDebugUtilsLabelEXT, "vkQueueBeginDebugUtilsLabelEXT"); From 913631896d5fffb70420617622b1df8db6f98c97 Mon Sep 17 00:00:00 2001 From: Robert Osfield Date: Wed, 29 Nov 2023 11:40:57 +0000 Subject: [PATCH 9/9] Ran clang-format --- include/vsg/app/WindowTraits.h | 6 +++--- include/vsg/vk/Instance.h | 1 + src/vsg/app/WindowTraits.cpp | 2 +- src/vsg/vk/Instance.cpp | 2 +- src/vsg/vk/InstanceExtensions.cpp | 5 ++--- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/include/vsg/app/WindowTraits.h b/include/vsg/app/WindowTraits.h index bd26478bcd..0d6ac8f5ed 100644 --- a/include/vsg/app/WindowTraits.h +++ b/include/vsg/app/WindowTraits.h @@ -70,10 +70,10 @@ namespace vsg VkPipelineStageFlagBits imageAvailableSemaphoreWaitFlag = VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT; // hints to which extenstion to enable during Instance/Device setup - bool debugLayer = false; // VK_LAYER_KHRONOS_validation + bool debugLayer = false; // VK_LAYER_KHRONOS_validation bool synchronizationLayer = false; // VK_LAYER_KHRONOS_synchronization2 - bool apiDumpLayer = false; // VK_LAYER_LUNARG_api_dump - bool debugUtils = false; // VK_EXT_debug_utils + bool apiDumpLayer = false; // VK_LAYER_LUNARG_api_dump + bool debugUtils = false; // VK_EXT_debug_utils // Device to use, if not assigned use the device preferences below ref_ptr device; diff --git a/include/vsg/vk/Instance.h b/include/vsg/vk/Instance.h index d21c72b4bb..30ac17c9ac 100644 --- a/include/vsg/vk/Instance.h +++ b/include/vsg/vk/Instance.h @@ -82,6 +82,7 @@ namespace vsg if (pNameFallback) procAddress = reinterpret_cast(vkGetInstanceProcAddr(_instance, pNameFallback)); return (procAddress); } + protected: virtual ~Instance(); diff --git a/src/vsg/app/WindowTraits.cpp b/src/vsg/app/WindowTraits.cpp index 04b704f485..47a6b9b75c 100644 --- a/src/vsg/app/WindowTraits.cpp +++ b/src/vsg/app/WindowTraits.cpp @@ -52,7 +52,7 @@ WindowTraits::WindowTraits(const WindowTraits& traits) : deviceExtensionNames(traits.deviceExtensionNames), deviceTypePreferences(traits.deviceTypePreferences), deviceFeatures(traits.deviceFeatures), - samples(traits.samples)/*, + samples(traits.samples) /*, nativeWindow(traits.nativeWindow), systemConnection(traits.systemConnection)*/ { diff --git a/src/vsg/vk/Instance.cpp b/src/vsg/vk/Instance.cpp index e8d132a300..a53d866311 100644 --- a/src/vsg/vk/Instance.cpp +++ b/src/vsg/vk/Instance.cpp @@ -18,8 +18,8 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI #include #include -#include #include +#include using namespace vsg; diff --git a/src/vsg/vk/InstanceExtensions.cpp b/src/vsg/vk/InstanceExtensions.cpp index e930f71d1d..14f85b8fe6 100644 --- a/src/vsg/vk/InstanceExtensions.cpp +++ b/src/vsg/vk/InstanceExtensions.cpp @@ -13,17 +13,16 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI #include #include #include -#include #include +#include #include #include -#include #include +#include using namespace vsg; - InstanceExtensions::InstanceExtensions(Instance* instance) { // VK_EXT_debug_utils