sid
/
NazaraEngine
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

VulkanRenderer: Add support for VK_EXT_debug_report 

Some older drivers (Android) don't support VK_EXT_debug_utils
This commit is contained in:
SirLynix 2023-02-26 13:48:25 +01:00
parent 5e6a20f479
commit 20ad93f1c9
10 changed files with 186 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
include/Nazara/VulkanRenderer/Wrapper/DebugReportCallbackEXT.hpp Normal file
View File

@ -0,0 +1,38 @@
// Copyright (C) 2023 Jérôme "Lynix" Leclercq (lynix680@gmail.com)
// This file is part of the "Nazara Engine - Vulkan renderer"
// For conditions of distribution and use, see copyright notice in Config.hpp
#pragma once
#ifndef NAZARA_VULKANRENDERER_WRAPPER_DEBUGREPORTCALLBACKEXT_HPP
#define NAZARA_VULKANRENDERER_WRAPPER_DEBUGREPORTCALLBACKEXT_HPP
#include <Nazara/Prerequisites.hpp>
#include <Nazara/VulkanRenderer/Wrapper/InstanceObject.hpp>
namespace Nz::Vk
{
class DebugReportCallbackEXT : public InstanceObject<DebugReportCallbackEXT, VkDebugReportCallbackEXT, VkDebugReportCallbackCreateInfoEXT, VK_OBJECT_TYPE_DEBUG_REPORT_CALLBACK_EXT>
{
friend InstanceObject;
public:
DebugReportCallbackEXT() = default;
DebugReportCallbackEXT(const DebugReportCallbackEXT&) = delete;
DebugReportCallbackEXT(DebugReportCallbackEXT&&) = default;
~DebugReportCallbackEXT() = default;
DebugReportCallbackEXT& operator=(const DebugReportCallbackEXT&) = delete;
DebugReportCallbackEXT& operator=(DebugReportCallbackEXT&&) = delete;
static inline bool IsSupported(Instance& instance);
private:
static inline VkResult CreateHelper(Instance& instance, const VkDebugReportCallbackCreateInfoEXT* createInfo, const VkAllocationCallbacks* allocator, VkDebugReportCallbackEXT* handle);
static inline void DestroyHelper(Instance& instance, VkDebugReportCallbackEXT handle, const VkAllocationCallbacks* allocator);
};
}
#include <Nazara/VulkanRenderer/Wrapper/DebugReportCallbackEXT.inl>
#endif // NAZARA_VULKANRENDERER_WRAPPER_DEBUGREPORTCALLBACKEXT_HPP

26
include/Nazara/VulkanRenderer/Wrapper/DebugReportCallbackEXT.inl Normal file
View File

@ -0,0 +1,26 @@
// Copyright (C) 2023 Jérôme "Lynix" Leclercq (lynix680@gmail.com)
// This file is part of the "Nazara Engine - Vulkan renderer"
// For conditions of distribution and use, see copyright notice in Config.hpp
#include <Nazara/VulkanRenderer/Wrapper/DebugReportCallbackEXT.hpp>
#include <Nazara/VulkanRenderer/Debug.hpp>
namespace Nz::Vk
{
inline bool DebugReportCallbackEXT::IsSupported(Instance& instance)
{
return instance.vkCreateDebugReportCallbackEXT != nullptr;
}
inline VkResult DebugReportCallbackEXT::CreateHelper(Instance& instance, const VkDebugReportCallbackCreateInfoEXT* createInfo, const VkAllocationCallbacks* allocator, VkDebugReportCallbackEXT* handle)
{
return instance.vkCreateDebugReportCallbackEXT(instance, createInfo, allocator, handle);
}
inline void DebugReportCallbackEXT::DestroyHelper(Instance& instance, VkDebugReportCallbackEXT handle, const VkAllocationCallbacks* allocator)
{
return instance.vkDestroyDebugReportCallbackEXT(instance, handle, allocator);
}
}
#include <Nazara/VulkanRenderer/DebugOff.hpp>

33
include/Nazara/VulkanRenderer/Wrapper/DebugUtilsMessengerEXT.hpp
View File

@ -10,30 +10,27 @@
#include <Nazara/Prerequisites.hpp>
#include <Nazara/VulkanRenderer/Wrapper/InstanceObject.hpp>
namespace Nz
namespace Nz::Vk
{
namespace Vk
class DebugUtilsMessengerEXT : public InstanceObject<DebugUtilsMessengerEXT, VkDebugUtilsMessengerEXT, VkDebugUtilsMessengerCreateInfoEXT, VK_OBJECT_TYPE_DEBUG_UTILS_MESSENGER_EXT>
{
class DebugUtilsMessengerEXT : public InstanceObject<DebugUtilsMessengerEXT, VkDebugUtilsMessengerEXT, VkDebugUtilsMessengerCreateInfoEXT, VK_OBJECT_TYPE_DEBUG_UTILS_MESSENGER_EXT>
{
friend InstanceObject;
friend InstanceObject;
public:
DebugUtilsMessengerEXT() = default;
DebugUtilsMessengerEXT(const DebugUtilsMessengerEXT&) = delete;
DebugUtilsMessengerEXT(DebugUtilsMessengerEXT&&) = default;
~DebugUtilsMessengerEXT() = default;
public:
DebugUtilsMessengerEXT() = default;
DebugUtilsMessengerEXT(const DebugUtilsMessengerEXT&) = delete;
DebugUtilsMessengerEXT(DebugUtilsMessengerEXT&&) = default;
~DebugUtilsMessengerEXT() = default;
DebugUtilsMessengerEXT& operator=(const DebugUtilsMessengerEXT&) = delete;
DebugUtilsMessengerEXT& operator=(DebugUtilsMessengerEXT&&) = delete;
DebugUtilsMessengerEXT& operator=(const DebugUtilsMessengerEXT&) = delete;
DebugUtilsMessengerEXT& operator=(DebugUtilsMessengerEXT&&) = delete;
static inline bool IsSupported(Instance& instance);
static inline bool IsSupported(Instance& instance);
private:
static inline VkResult CreateHelper(Instance& instance, const VkDebugUtilsMessengerCreateInfoEXT* createInfo, const VkAllocationCallbacks* allocator, VkDebugUtilsMessengerEXT* handle);
static inline void DestroyHelper(Instance& instance, VkDebugUtilsMessengerEXT handle, const VkAllocationCallbacks* allocator);
};
}
private:
static inline VkResult CreateHelper(Instance& instance, const VkDebugUtilsMessengerCreateInfoEXT* createInfo, const VkAllocationCallbacks* allocator, VkDebugUtilsMessengerEXT* handle);
static inline void DestroyHelper(Instance& instance, VkDebugUtilsMessengerEXT handle, const VkAllocationCallbacks* allocator);
};
}
#include <Nazara/VulkanRenderer/Wrapper/DebugUtilsMessengerEXT.inl>

25
include/Nazara/VulkanRenderer/Wrapper/DebugUtilsMessengerEXT.inl
View File

@ -5,24 +5,21 @@
#include <Nazara/VulkanRenderer/Wrapper/DebugUtilsMessengerEXT.hpp>
#include <Nazara/VulkanRenderer/Debug.hpp>
namespace Nz
namespace Nz::Vk
{
namespace Vk
inline bool DebugUtilsMessengerEXT::IsSupported(Instance& instance)
{
inline bool DebugUtilsMessengerEXT::IsSupported(Instance& instance)
{
return instance.vkCreateDebugUtilsMessengerEXT != nullptr;
}
return instance.vkCreateDebugUtilsMessengerEXT != nullptr;
}
inline VkResult DebugUtilsMessengerEXT::CreateHelper(Instance& instance, const VkDebugUtilsMessengerCreateInfoEXT* createInfo, const VkAllocationCallbacks* allocator, VkDebugUtilsMessengerEXT* handle)
{
return instance.vkCreateDebugUtilsMessengerEXT(instance, createInfo, allocator, handle);
}
inline VkResult DebugUtilsMessengerEXT::CreateHelper(Instance& instance, const VkDebugUtilsMessengerCreateInfoEXT* createInfo, const VkAllocationCallbacks* allocator, VkDebugUtilsMessengerEXT* handle)
{
return instance.vkCreateDebugUtilsMessengerEXT(instance, createInfo, allocator, handle);
}
inline void DebugUtilsMessengerEXT::DestroyHelper(Instance& instance, VkDebugUtilsMessengerEXT handle, const VkAllocationCallbacks* allocator)
{
return instance.vkDestroyDebugUtilsMessengerEXT(instance, handle, allocator);
}
inline void DebugUtilsMessengerEXT::DestroyHelper(Instance& instance, VkDebugUtilsMessengerEXT handle, const VkAllocationCallbacks* allocator)
{
return instance.vkDestroyDebugUtilsMessengerEXT(instance, handle, allocator);
}
}

2
include/Nazara/VulkanRenderer/Wrapper/DeviceObject.inl
View File

@ -41,7 +41,7 @@ namespace Nz::Vk
m_lastErrorCode = C::CreateHelper(*m_device, &createInfo, allocator, &m_handle);
if (m_lastErrorCode != VkResult::VK_SUCCESS)
{
NazaraError("Failed to create Vulkan object: " + TranslateVulkanError(m_lastErrorCode));
NazaraError("Failed to create Vulkan device object: " + TranslateVulkanError(m_lastErrorCode));
return false;
}

6
include/Nazara/VulkanRenderer/Wrapper/InstanceFunctions.hpp
View File

@ -55,6 +55,12 @@ NAZARA_VULKANRENDERER_INSTANCE_EXT_BEGIN(VK_KHR_surface)
NAZARA_VULKANRENDERER_INSTANCE_FUNCTION(vkGetPhysicalDeviceSurfaceSupportKHR)
NAZARA_VULKANRENDERER_INSTANCE_EXT_END()
NAZARA_VULKANRENDERER_INSTANCE_EXT_BEGIN(VK_EXT_debug_report)
NAZARA_VULKANRENDERER_INSTANCE_FUNCTION(vkCreateDebugReportCallbackEXT)
NAZARA_VULKANRENDERER_INSTANCE_FUNCTION(vkDestroyDebugReportCallbackEXT)
NAZARA_VULKANRENDERER_INSTANCE_FUNCTION(vkDebugReportMessageEXT)
NAZARA_VULKANRENDERER_INSTANCE_EXT_END()
NAZARA_VULKANRENDERER_INSTANCE_EXT_BEGIN(VK_EXT_debug_utils)
NAZARA_VULKANRENDERER_INSTANCE_FUNCTION(vkCreateDebugUtilsMessengerEXT)
NAZARA_VULKANRENDERER_INSTANCE_FUNCTION(vkDestroyDebugUtilsMessengerEXT)

2
include/Nazara/VulkanRenderer/Wrapper/InstanceObject.inl
View File

@ -40,7 +40,7 @@ namespace Nz
m_lastErrorCode = C::CreateHelper(*m_instance, &createInfo, allocator, &m_handle);
if (m_lastErrorCode != VkResult::VK_SUCCESS)
{
NazaraError("Failed to create Vulkan object: " + TranslateVulkanError(m_lastErrorCode));
NazaraError("Failed to create Vulkan instance object: " + TranslateVulkanError(m_lastErrorCode));
return false;
}

2
include/Nazara/VulkanRenderer/Wrapper/Pipeline.inl
View File

@ -75,7 +75,7 @@ namespace Nz
m_lastErrorCode = result;
if (m_lastErrorCode != VkResult::VK_SUCCESS)
{
NazaraError("Failed to create Vulkan object: " + TranslateVulkanError(m_lastErrorCode));
NazaraError("Failed to create Vulkan pipeline: " + TranslateVulkanError(m_lastErrorCode));
return false;
}

2
src/Nazara/VulkanRenderer/Vulkan.cpp
View File

@ -251,6 +251,8 @@ namespace Nz
if (availableExtensions.count(VK_EXT_DEBUG_UTILS_EXTENSION_NAME))
enabledExtensions.push_back(VK_EXT_DEBUG_UTILS_EXTENSION_NAME);
else if (availableExtensions.count(VK_EXT_DEBUG_REPORT_EXTENSION_NAME))
enabledExtensions.push_back(VK_EXT_DEBUG_REPORT_EXTENSION_NAME);
}
std::vector<std::string> additionalExtensions; // Just to keep the String alive

102
src/Nazara/VulkanRenderer/Wrapper/Instance.cpp
View File

@ -7,6 +7,7 @@
#include <Nazara/Core/ErrorFlags.hpp>
#include <Nazara/Core/Log.hpp>
#include <Nazara/VulkanRenderer/Utils.hpp>
#include <Nazara/VulkanRenderer/Wrapper/DebugReportCallbackEXT.hpp>
#include <Nazara/VulkanRenderer/Wrapper/DebugUtilsMessengerEXT.hpp>
#include <sstream>
#include <Nazara/VulkanRenderer/Debug.hpp>
@ -17,7 +18,7 @@ namespace Nz
{
namespace
{
VKAPI_ATTR VkBool32 VKAPI_CALL DebugCallback(
VKAPI_ATTR VkBool32 VKAPI_CALL DebugMessengerCallback(
VkDebugUtilsMessageSeverityFlagBitsEXT messageSeverity,
VkDebugUtilsMessageTypeFlagsEXT messageTypes,
const VkDebugUtilsMessengerCallbackDataEXT* pCallbackData,
@ -77,10 +78,55 @@ namespace Nz
return VK_FALSE; //< Should the Vulkan call be aborted
}
VKAPI_ATTR VkBool32 VKAPI_CALL DebugReportCallback(
VkDebugReportFlagsEXT flags,
VkDebugReportObjectTypeEXT /*objectType*/,
uint64_t /*object*/,
size_t /*location*/,
int32_t messageCode,
const char* pLayerPrefix,
const char* pMessage,
void* /*pUserData*/)
{
std::stringstream ss;
ss << "Vulkan log: ";
if (flags & VK_DEBUG_REPORT_INFORMATION_BIT_EXT)
ss << "[Info]";
if (flags & VK_DEBUG_REPORT_WARNING_BIT_EXT)
ss << "[Warning]";
if (flags & VK_DEBUG_REPORT_ERROR_BIT_EXT)
ss << "[Error]";
if (flags & VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT)
ss << "[Performance]";
if (flags & VK_DEBUG_REPORT_DEBUG_BIT_EXT)
ss << "[Debug]";
ss << "[" << messageCode << "]";
if (pLayerPrefix)
ss << "[layer " << pLayerPrefix << "]";
ss << ": " << pMessage;
if (flags & VK_DEBUG_REPORT_ERROR_BIT_EXT)
NazaraError(ss.str());
else if (flags & VK_DEBUG_REPORT_WARNING_BIT_EXT)
NazaraWarning(ss.str());
else
NazaraNotice(ss.str());
return VK_FALSE; //< Should the Vulkan call be aborted
}
}
struct Instance::InternalData
{
DebugReportCallbackEXT debugCallback;
DebugUtilsMessengerEXT debugMessenger;
};
@ -125,9 +171,12 @@ namespace Nz
{
ErrorFlags flags(ErrorMode::ThrowException, true);
#define NAZARA_VULKANRENDERER_INSTANCE_EXT_BEGIN(ext) if (IsExtensionLoaded(#ext)) {
#define NAZARA_VULKANRENDERER_INSTANCE_EXT_BEGIN(ext) if (IsExtensionLoaded(#ext)) { \
NazaraDebug(#ext " extension is supported");
#define NAZARA_VULKANRENDERER_INSTANCE_EXT_END() }
#define NAZARA_VULKANRENDERER_INSTANCE_FUNCTION(func) func = reinterpret_cast<PFN_##func>(GetProcAddr(#func));
#define NAZARA_VULKANRENDERER_INSTANCE_FUNCTION(func) func = reinterpret_cast<PFN_##func>(GetProcAddr(#func)); \
if (!func) \
NazaraWarning("failed to get a function pointer for " #func " despite its being reported as supported");
#define NAZARA_VULKANRENDERER_INSTANCE_CORE_EXT_FUNCTION(func, coreVersion, suffix, extName) \
if (m_apiVersion >= coreVersion) \
@ -226,24 +275,43 @@ namespace Nz
{
NazaraAssert(m_internalData, "Instance must be created before callbacks are installed");
if (!Vk::DebugUtilsMessengerEXT::IsSupported(*this))
if (Vk::DebugUtilsMessengerEXT::IsSupported(*this))
{
NazaraWarning(VK_EXT_DEBUG_UTILS_EXTENSION_NAME " is not supported, cannot install debug message callback");
VkDebugUtilsMessengerCreateInfoEXT callbackCreateInfo = {};
callbackCreateInfo.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT;
callbackCreateInfo.messageSeverity = VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXT;
callbackCreateInfo.messageType = VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT;
callbackCreateInfo.pfnUserCallback = &DebugMessengerCallback;
callbackCreateInfo.pUserData = this;
if (!m_internalData->debugMessenger.Create(*this, callbackCreateInfo))
{
NazaraWarning("failed to install debug message callback");
return;
}
}
else if (Vk::DebugReportCallbackEXT::IsSupported(*this))
{
NazaraWarning(VK_EXT_DEBUG_UTILS_EXTENSION_NAME " is not supported, falling back on " VK_EXT_DEBUG_REPORT_EXTENSION_NAME);
VkDebugReportCallbackCreateInfoEXT callbackCreateInfo = {};
callbackCreateInfo.sType = VK_STRUCTURE_TYPE_DEBUG_REPORT_CREATE_INFO_EXT;
callbackCreateInfo.flags = VK_DEBUG_REPORT_WARNING_BIT_EXT | VK_DEBUG_REPORT_ERROR_BIT_EXT | VK_DEBUG_REPORT_INFORMATION_BIT_EXT;
callbackCreateInfo.pfnCallback = &DebugReportCallback;
callbackCreateInfo.pUserData = this;
if (!m_internalData->debugCallback.Create(*this, callbackCreateInfo))
{
NazaraWarning("failed to install debug message callback");
return;
}
}
else
{
NazaraWarning(VK_EXT_DEBUG_UTILS_EXTENSION_NAME " nor " VK_EXT_DEBUG_REPORT_EXTENSION_NAME " are not supported, cannot install debug message callback");
return;
}
VkDebugUtilsMessengerCreateInfoEXT callbackCreateInfo = {};
callbackCreateInfo.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_MESSENGER_CREATE_INFO_EXT;
callbackCreateInfo.messageSeverity = VK_DEBUG_UTILS_MESSAGE_SEVERITY_WARNING_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_SEVERITY_ERROR_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_SEVERITY_INFO_BIT_EXT;
callbackCreateInfo.messageType = VK_DEBUG_UTILS_MESSAGE_TYPE_GENERAL_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_TYPE_VALIDATION_BIT_EXT | VK_DEBUG_UTILS_MESSAGE_TYPE_PERFORMANCE_BIT_EXT;
callbackCreateInfo.pfnUserCallback = &DebugCallback;
callbackCreateInfo.pUserData = this;
if (!m_internalData->debugMessenger.Create(*this, callbackCreateInfo))
{
NazaraWarning("failed to install debug message callback");
return;
}
}
void Instance::DestroyInstance()