// 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/Core/StringExt.hpp>
#include <Nazara/VulkanRenderer/Utils.hpp>
#include <Nazara/VulkanRenderer/Debug.hpp>

namespace Nz
{
	std::string TranslateVulkanError(VkResult code)
	{
		// From https://www.khronos.org/registry/vulkan/specs/1.0-wsi_extensions/xhtml/vkspec.html#VkResult
		switch (code)
		{
			case VK_SUCCESS:
				return "No error";

			case VK_NOT_READY:
				return "A fence or query has not yet completed";

			case VK_TIMEOUT:
				return "A wait operation has not completed in the specified time";

			case VK_EVENT_SET:
				return "An event is signaled";

			case VK_EVENT_RESET:
				return "An event is unsignaled";

			case VK_INCOMPLETE:
				return "A return array was too small for the result";

			case VK_ERROR_OUT_OF_HOST_MEMORY:
				return "A host memory allocation has failed";

			case VK_ERROR_OUT_OF_DEVICE_MEMORY:
				return "A device memory allocation has failed";

			case VK_ERROR_INITIALIZATION_FAILED:
				return "Initialization of an object could not be completed for implementation-specific reasons";

			case VK_ERROR_DEVICE_LOST:
				return "The logical or physical device has been lost";

			case VK_ERROR_MEMORY_MAP_FAILED:
				return "Mapping of the memory object has failed";

			case VK_ERROR_LAYER_NOT_PRESENT:
				return "A requested layer is not present or could not be loaded";

			case VK_ERROR_EXTENSION_NOT_PRESENT:
				return "A requested extension is not supported";

			case VK_ERROR_FEATURE_NOT_PRESENT:
				return "A requested feature is not supported";

			case VK_ERROR_INCOMPATIBLE_DRIVER:
				return "The requested version of Vulkan is not supported by the driver or is otherwise incompatible for implementation-specific reasons";

			case VK_ERROR_TOO_MANY_OBJECTS:
				return "Too many objects of the type have already been created";

			case VK_ERROR_FORMAT_NOT_SUPPORTED:
				return "A requested format is not supported on this device";

			case VK_ERROR_FRAGMENTED_POOL:
				return "A requested pool allocation has failed due to fragmentation of the pool’s memory";

			case VK_ERROR_SURFACE_LOST_KHR:
				return "A surface is no longer available";

			case VK_ERROR_NATIVE_WINDOW_IN_USE_KHR:
				return "The requested window is already connected to a VkSurfaceKHR, or to some other non-Vulkan API";

			case VK_SUBOPTIMAL_KHR:
				return "A swapchain no longer matches the surface properties exactly, but can still be used to present to the surface successfully";

			case VK_ERROR_OUT_OF_DATE_KHR:
				return "A surface has changed in such a way that it is no longer compatible with the swapchain, and further presentation requests using the swapchain will fail. Applications must query the new surface properties and recreate their swapchain if they wish to continue presenting to the surface";

			case VK_ERROR_INCOMPATIBLE_DISPLAY_KHR:
				return "The display used by a swapchain does not use the same presentable image layout, or is incompatible in a way that prevents sharing an image";

			case VK_ERROR_VALIDATION_FAILED_EXT:
				return "A validation layer found an error";

			case VK_ERROR_INVALID_SHADER_NV:
				return "One or more shaders failed to compile or link";

			case VK_ERROR_OUT_OF_POOL_MEMORY_KHR:
				return "A requested pool allocation has failed";

			case VK_ERROR_INVALID_EXTERNAL_HANDLE:
				return "An external handle is not a valid handle of the specified type";

			default:
				break;
		}

		return "Unknown Vulkan error (0x" + NumberToString(code, 16) + ')';
	}
}
