// Copyright(c) 2019, NVIDIA CORPORATION. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // #include "utils.hpp" #include "vulkan/vulkan.hpp" PFN_vkCreateDebugReportCallbackEXT pfnVkCreateDebugReportCallbackEXT; PFN_vkDestroyDebugReportCallbackEXT pfnVkDestroyDebugReportCallbackEXT; VKAPI_ATTR VkResult VKAPI_CALL vkCreateDebugReportCallbackEXT(VkInstance instance, const VkDebugReportCallbackCreateInfoEXT* pCreateInfo, const VkAllocationCallbacks* pAllocator, VkDebugReportCallbackEXT* pCallback) { return pfnVkCreateDebugReportCallbackEXT(instance, pCreateInfo, pAllocator, pCallback); } VKAPI_ATTR void VKAPI_CALL vkDestroyDebugReportCallbackEXT(VkInstance instance, VkDebugReportCallbackEXT callback, const VkAllocationCallbacks* pAllocator) { pfnVkDestroyDebugReportCallbackEXT(instance, callback, pAllocator); } namespace vk { namespace su { vk::UniqueDeviceMemory allocateMemory(vk::UniqueDevice &device, vk::PhysicalDeviceMemoryProperties const& memoryProperties, vk::MemoryRequirements const& memoryRequirements, vk::MemoryPropertyFlags memoryPropertyFlags) { uint32_t memoryTypeBits = memoryRequirements.memoryTypeBits; uint32_t memoryTypeIndex = static_cast(~0); for (uint32_t i = 0; i < memoryProperties.memoryTypeCount; i++) { if ((memoryTypeBits & 1) == 1) { if ((memoryProperties.memoryTypes[i].propertyFlags & memoryPropertyFlags) == memoryPropertyFlags) { memoryTypeIndex = i; break; } } memoryTypeBits >>= 1; } assert(memoryTypeIndex != ~0); return device->allocateMemoryUnique(vk::MemoryAllocateInfo(memoryRequirements.size, memoryTypeIndex)); } vk::UniqueDebugReportCallbackEXT createDebugReportCallback(vk::UniqueInstance &instance) { vk::DebugReportFlagsEXT flags(vk::DebugReportFlagBitsEXT::eWarning | vk::DebugReportFlagBitsEXT::ePerformanceWarning | vk::DebugReportFlagBitsEXT::eError); return instance->createDebugReportCallbackEXTUnique(vk::DebugReportCallbackCreateInfoEXT(flags, &vk::su::debugReportCallback)); } vk::UniqueDescriptorSetLayout createDescriptorSetLayout(vk::UniqueDevice &device) { vk::DescriptorSetLayoutBinding descriptorSetLayoutBinding(0, vk::DescriptorType::eUniformBuffer, 1, vk::ShaderStageFlagBits::eVertex); return device->createDescriptorSetLayoutUnique(vk::DescriptorSetLayoutCreateInfo({}, 1, &descriptorSetLayoutBinding)); } vk::UniqueDevice createDevice(vk::PhysicalDevice physicalDevice, uint32_t queueFamilyIndex, std::vector const& extensions) { std::vector enabledExtensions; enabledExtensions.reserve(extensions.size()); for (auto const& ext : extensions) { enabledExtensions.push_back(ext.data()); } // create a UniqueDevice float queuePriority = 0.0f; vk::DeviceQueueCreateInfo deviceQueueCreateInfo(vk::DeviceQueueCreateFlags(), queueFamilyIndex, 1, &queuePriority); vk::DeviceCreateInfo deviceCreateInfo(vk::DeviceCreateFlags(), 1, &deviceQueueCreateInfo, 0, nullptr, checked_cast(enabledExtensions.size()), enabledExtensions.data()); return physicalDevice.createDeviceUnique(deviceCreateInfo); } vk::UniqueInstance createInstance(std::string const& appName, std::string const& engineName, std::vector const& extensions) { std::vector enabledLayers; #if !defined(NDEBUG) // Enable standard validation layer to find as much errors as possible! enabledLayers.push_back("VK_LAYER_LUNARG_standard_validation"); #endif std::vector enabledExtensions; enabledExtensions.reserve(extensions.size()); for (auto const& ext : extensions) { enabledExtensions.push_back(ext.data()); } #if !defined(NDEBUG) if (std::find(extensions.begin(), extensions.end(), VK_EXT_DEBUG_REPORT_EXTENSION_NAME) == extensions.end()) { enabledExtensions.push_back(VK_EXT_DEBUG_REPORT_EXTENSION_NAME); } #endif // create a UniqueInstance vk::ApplicationInfo applicationInfo(appName.c_str(), 1, engineName.c_str(), 1, VK_API_VERSION_1_1); vk::UniqueInstance instance = vk::createInstanceUnique(vk::InstanceCreateInfo({}, &applicationInfo, checked_cast(enabledLayers.size()), enabledLayers.data(), checked_cast(enabledExtensions.size()), enabledExtensions.data())); #if !defined(NDEBUG) static bool initialized = false; if (!initialized) { pfnVkCreateDebugReportCallbackEXT = reinterpret_cast(instance->getProcAddr("vkCreateDebugReportCallbackEXT")); pfnVkDestroyDebugReportCallbackEXT = reinterpret_cast(instance->getProcAddr("vkDestroyDebugReportCallbackEXT")); assert(pfnVkCreateDebugReportCallbackEXT && pfnVkDestroyDebugReportCallbackEXT); initialized = true; } #endif return instance; } VkBool32 debugReportCallback(VkDebugReportFlagsEXT flags, VkDebugReportObjectTypeEXT /*objectType*/, uint64_t /*object*/, size_t /*location*/, int32_t /*messageCode*/, const char* /*pLayerPrefix*/, const char* pMessage, void* /*pUserData*/) { switch (flags) { case VK_DEBUG_REPORT_INFORMATION_BIT_EXT: std::cerr << "INFORMATION: "; break; case VK_DEBUG_REPORT_WARNING_BIT_EXT: std::cerr << "WARNING: "; break; case VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT: std::cerr << "PERFORMANCE WARNING: "; break; case VK_DEBUG_REPORT_ERROR_BIT_EXT: std::cerr << "ERROR: "; break; case VK_DEBUG_REPORT_DEBUG_BIT_EXT: std::cerr << "DEBUG: "; break; default: std::cerr << "unknown flag (" << flags << "): "; break; } std::cerr << pMessage << std::endl; return VK_TRUE; } uint32_t findGraphicsQueueFamilyIndex(std::vector const& queueFamilyProperties) { // get the first index into queueFamiliyProperties which supports graphics size_t graphicsQueueFamilyIndex = std::distance(queueFamilyProperties.begin(), std::find_if(queueFamilyProperties.begin(), queueFamilyProperties.end(), [](vk::QueueFamilyProperties const& qfp) { return qfp.queueFlags & vk::QueueFlagBits::eGraphics; })); assert(graphicsQueueFamilyIndex < queueFamilyProperties.size()); return checked_cast(graphicsQueueFamilyIndex); } std::pair findGraphicsAndPresentQueueFamilyIndex(vk::PhysicalDevice physicalDevice, vk::UniqueSurfaceKHR & surface) { std::vector queueFamilyProperties = physicalDevice.getQueueFamilyProperties(); assert(queueFamilyProperties.size() < std::numeric_limits::max()); uint32_t graphicsQueueFamilyIndex = findGraphicsQueueFamilyIndex(queueFamilyProperties); if (physicalDevice.getSurfaceSupportKHR(graphicsQueueFamilyIndex, surface.get())) { return std::make_pair(graphicsQueueFamilyIndex, graphicsQueueFamilyIndex); // the first graphicsQueueFamilyIndex does also support presents } // the graphicsQueueFamilyIndex doesn't support present -> look for an other family index that supports both graphics and present for (size_t i = 0; i < queueFamilyProperties.size(); i++) { if ((queueFamilyProperties[i].queueFlags & vk::QueueFlagBits::eGraphics) && physicalDevice.getSurfaceSupportKHR(static_cast(i), surface.get())) { return std::make_pair(static_cast(i), static_cast(i)); } } // there's nothing like a single family index that supports both graphics and present -> look for an other family index that supports present for (size_t i = 0; i < queueFamilyProperties.size(); i++) { if (physicalDevice.getSurfaceSupportKHR(static_cast(i), surface.get())) { return std::make_pair(graphicsQueueFamilyIndex, static_cast(i)); } } throw std::runtime_error("Could not find queues for both graphics or present -> terminating"); } std::vector getDeviceExtensions() { return{ VK_KHR_SWAPCHAIN_EXTENSION_NAME }; } std::vector getInstanceExtensions() { std::vector extensions; extensions.push_back(VK_KHR_SURFACE_EXTENSION_NAME); #if defined(VK_USE_PLATFORM_ANDROID_KHR) extensions.push_back(VK_KHR_ANDROID_SURFACE_EXTENSION_NAME); #elif defined(VK_USE_PLATFORM_IOS_MVK) extensions.push_back(VK_MVK_IOS_SURFACE_EXTENSION_NAME); #elif defined(VK_USE_PLATFORM_MACOS_MVK) extensions.push_back(VK_MVK_MACOS_SURFACE_EXTENSION_NAME); #elif defined(VK_USE_PLATFORM_MIR_KHR) extensions.push_back(VK_KHR_MIR_SURFACE_EXTENSION_NAME); #elif defined(VK_USE_PLATFORM_VI_NN) extensions.push_back(VK_NN_VI_SURFACE_EXTENSION_NAME); #elif defined(VK_USE_PLATFORM_WAYLAND_KHR) extensions.push_back(VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME); #elif defined(VK_USE_PLATFORM_WIN32_KHR) extensions.push_back(VK_KHR_WIN32_SURFACE_EXTENSION_NAME); #elif defined(VK_USE_PLATFORM_XCB_KHR) extensions.push_back(VK_KHR_XCB_SURFACE_EXTENSION_NAME); #elif defined(VK_USE_PLATFORM_XLIB_KHR) extensions.push_back(VK_KHR_XLIB_SURFACE_EXTENSION_NAME); #elif defined(VK_USE_PLATFORM_XLIB_XRANDR_EXT) extensions.push_back(VK_EXT_ACQUIRE_XLIB_DISPLAY_EXTENSION_NAME); #endif return extensions; } vk::Format pickColorFormat(std::vector const& formats) { assert(!formats.empty()); return (formats[0].format == vk::Format::eUndefined) ? vk::Format::eB8G8R8A8Unorm : formats[0].format; } #if defined(VK_USE_PLATFORM_WIN32_KHR) LRESULT CALLBACK WindowProc(HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam) { switch (uMsg) { case WM_CLOSE: PostQuitMessage(0); break; default: break; } return (DefWindowProc(hWnd, uMsg, wParam, lParam)); } HWND initializeWindow(std::string const& className, std::string const& windowName, LONG width, LONG height) { WNDCLASSEX windowClass; memset(&windowClass, 0, sizeof(WNDCLASSEX)); HINSTANCE instance = GetModuleHandle(nullptr); windowClass.cbSize = sizeof(WNDCLASSEX); windowClass.style = CS_HREDRAW | CS_VREDRAW; windowClass.lpfnWndProc = WindowProc; windowClass.hInstance = instance; windowClass.hIcon = LoadIcon(NULL, IDI_APPLICATION); windowClass.hCursor = LoadCursor(NULL, IDC_ARROW); windowClass.hbrBackground = (HBRUSH)GetStockObject(WHITE_BRUSH); windowClass.lpszClassName = className.c_str(); windowClass.hIconSm = LoadIcon(NULL, IDI_WINLOGO); if (!RegisterClassEx(&windowClass)) { throw std::runtime_error("Failed to register WNDCLASSEX -> terminating"); } RECT windowRect = { 0, 0, width, height }; AdjustWindowRect(&windowRect, WS_OVERLAPPEDWINDOW, FALSE); HWND window = CreateWindowEx(0, className.c_str(), windowName.c_str(), WS_OVERLAPPEDWINDOW | WS_VISIBLE | WS_SYSMENU, 100, 100, windowRect.right - windowRect.left, windowRect.bottom - windowRect.top, nullptr, nullptr, instance, nullptr); if (!window) { throw std::runtime_error("Failed to create window -> terminating"); } return window; } #else #pragma error "unhandled platform" #endif } }