#pragma once // 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 "vulkan/vulkan.hpp" #include #include namespace vk { namespace su { const uint64_t FenceTimeout = 100000000; struct BufferData { BufferData(vk::PhysicalDevice const& physicalDevice, vk::UniqueDevice const& device, vk::DeviceSize size, vk::BufferUsageFlags usage, vk::MemoryPropertyFlags propertyFlags = vk::MemoryPropertyFlagBits::eHostVisible | vk::MemoryPropertyFlagBits::eHostCoherent); template void upload(vk::UniqueDevice const& device, DataType const& data) const { assert((m_propertyFlags & vk::MemoryPropertyFlagBits::eHostCoherent) && (m_propertyFlags & vk::MemoryPropertyFlagBits::eHostVisible)); assert(sizeof(DataType) <= m_size); void* dataPtr = device->mapMemory(*this->deviceMemory, 0, sizeof(DataType)); memcpy(dataPtr, &data, sizeof(DataType)); device->unmapMemory(*this->deviceMemory); } template void upload(vk::UniqueDevice const& device, std::vector const& data, size_t stride = 0) const { assert(m_propertyFlags & vk::MemoryPropertyFlagBits::eHostVisible); size_t elementSize = stride ? stride : sizeof(DataType); assert(sizeof(DataType) <= elementSize); copyToDevice(device, deviceMemory, data.data(), data.size(), elementSize); } template void upload(vk::PhysicalDevice const& physicalDevice, vk::UniqueDevice const& device, vk::UniqueCommandPool const& commandPool, vk::Queue queue, std::vector const& data, size_t stride) const { assert(m_usage & vk::BufferUsageFlagBits::eTransferDst); assert(m_propertyFlags & vk::MemoryPropertyFlagBits::eDeviceLocal); size_t elementSize = stride ? stride : sizeof(DataType); assert(sizeof(DataType) <= elementSize); size_t dataSize = data.size() * elementSize; assert(dataSize <= m_size); vk::su::BufferData stagingBuffer(physicalDevice, device, dataSize, vk::BufferUsageFlagBits::eTransferSrc); copyToDevice(device, stagingBuffer.deviceMemory, data.data(), data.size(), elementSize); vk::su::oneTimeSubmit(device, commandPool, queue, [&](vk::UniqueCommandBuffer const& commandBuffer) { commandBuffer->copyBuffer(*stagingBuffer.buffer, *this->buffer, vk::BufferCopy(0, 0, dataSize)); }); } vk::UniqueBuffer buffer; vk::UniqueDeviceMemory deviceMemory; #if !defined(NDEBUG) private: vk::DeviceSize m_size; vk::BufferUsageFlags m_usage; vk::MemoryPropertyFlags m_propertyFlags; #endif) }; struct ImageData { ImageData(vk::PhysicalDevice const& physicalDevice, vk::UniqueDevice const& device, vk::Format format, vk::Extent2D const& extent, vk::ImageTiling tiling, vk::ImageUsageFlags usage , vk::ImageLayout initialLayout, vk::MemoryPropertyFlags memoryProperties, vk::ImageAspectFlags aspectMask); vk::Format format; vk::UniqueImage image; vk::UniqueDeviceMemory deviceMemory; vk::UniqueImageView imageView; }; struct DepthBufferData : public ImageData { DepthBufferData(vk::PhysicalDevice &physicalDevice, vk::UniqueDevice & device, vk::Format format, vk::Extent2D const& extent); }; struct SurfaceData { SurfaceData(vk::UniqueInstance &instance, std::string const& className, std::string const& windowName, vk::Extent2D const& extent); vk::Extent2D extent; #if defined(VK_USE_PLATFORM_WIN32_KHR) HWND window; #endif vk::UniqueSurfaceKHR surface; }; struct SwapChainData { SwapChainData(vk::PhysicalDevice const& physicalDevice, vk::UniqueDevice const& device, vk::SurfaceKHR const& surface, vk::Extent2D const& extent, vk::ImageUsageFlags usage, vk::UniqueSwapchainKHR const& oldSwapChain, uint32_t graphicsFamilyIndex, uint32_t presentFamilyIndex); vk::Format colorFormat; vk::UniqueSwapchainKHR swapChain; std::vector images; std::vector imageViews; }; class CheckerboardImageGenerator { public: CheckerboardImageGenerator(std::array const& rgb0 = {0, 0, 0}, std::array const& rgb1 = {255, 255, 255}); void operator()(void* data, vk::Extent2D &extent) const; private: std::array const& m_rgb0; std::array const& m_rgb1; }; class MonochromeImageGenerator { public: MonochromeImageGenerator(std::array const& rgb); void operator()(void* data, vk::Extent2D &extent) const; private: std::array const& m_rgb; }; class PixelsImageGenerator { public: PixelsImageGenerator(vk::Extent2D const& extent, size_t channels, unsigned char const* pixels); void operator()(void* data, vk::Extent2D & extent) const; private: vk::Extent2D m_extent; size_t m_channels; unsigned char const* m_pixels; }; struct TextureData { TextureData(vk::PhysicalDevice const& physicalDevice, vk::UniqueDevice const& device, vk::Extent2D const& extent_ = {256, 256}, vk::ImageUsageFlags usageFlags = {}, vk::FormatFeatureFlags formatFeatureFlags = {}, bool anisotropyEnable = false, bool forceStaging = false); template void setImage(vk::UniqueDevice const& device, vk::UniqueCommandBuffer const& commandBuffer, ImageGenerator const& imageGenerator) { void* data = needsStaging ? device->mapMemory(stagingBufferData->deviceMemory.get(), 0, device->getBufferMemoryRequirements(stagingBufferData->buffer.get()).size) : device->mapMemory(imageData->deviceMemory.get(), 0, device->getImageMemoryRequirements(imageData->image.get()).size); imageGenerator(data, extent); device->unmapMemory(needsStaging ? stagingBufferData->deviceMemory.get() : imageData->deviceMemory.get()); if (needsStaging) { // Since we're going to blit to the texture image, set its layout to eTransferDstOptimal vk::su::setImageLayout(commandBuffer, imageData->image.get(), imageData->format, vk::ImageLayout::eUndefined, vk::ImageLayout::eTransferDstOptimal); vk::BufferImageCopy copyRegion(0, extent.width, extent.height, vk::ImageSubresourceLayers(vk::ImageAspectFlagBits::eColor, 0, 0, 1), vk::Offset3D(0, 0, 0), vk::Extent3D(extent, 1)); commandBuffer->copyBufferToImage(stagingBufferData->buffer.get(), imageData->image.get(), vk::ImageLayout::eTransferDstOptimal, copyRegion); // Set the layout for the texture image from eTransferDstOptimal to SHADER_READ_ONLY vk::su::setImageLayout(commandBuffer, imageData->image.get(), imageData->format, vk::ImageLayout::eTransferDstOptimal, vk::ImageLayout::eShaderReadOnlyOptimal); } else { // If we can use the linear tiled image as a texture, just do it vk::su::setImageLayout(commandBuffer, imageData->image.get(), imageData->format, vk::ImageLayout::ePreinitialized, vk::ImageLayout::eShaderReadOnlyOptimal); } } vk::Format format; vk::Extent2D extent; bool needsStaging; std::unique_ptr stagingBufferData; std::unique_ptr imageData; vk::UniqueSampler textureSampler; }; struct UUID { public: UUID(uint8_t const data[VK_UUID_SIZE]); uint8_t m_data[VK_UUID_SIZE]; }; template VULKAN_HPP_INLINE TargetType checked_cast(SourceType value) { static_assert(sizeof(TargetType) <= sizeof(SourceType), "No need to cast from smaller to larger type!"); static_assert(!std::numeric_limits::is_signed, "Only unsigned types supported!"); static_assert(!std::numeric_limits::is_signed, "Only unsigned types supported!"); assert(value <= std::numeric_limits::max()); return static_cast(value); } template void copyToDevice(vk::UniqueDevice const& device, vk::UniqueDeviceMemory const& memory, T const* pData, size_t count, size_t stride = sizeof(T)) { assert(sizeof(T) <= stride); uint8_t* deviceData = static_cast(device->mapMemory(memory.get(), 0, count * stride)); if (stride == sizeof(T)) { memcpy(deviceData, pData, count * sizeof(T)); } else { for (size_t i = 0; i < count; i++) { memcpy(deviceData, &pData[i], sizeof(T)); deviceData += stride; } } device->unmapMemory(memory.get()); } template void copyToDevice(vk::UniqueDevice const& device, vk::UniqueDeviceMemory const& memory, T const& data) { copyToDevice(device, memory, &data, 1); } template VULKAN_HPP_INLINE constexpr const T& clamp(const T& v, const T& lo, const T& hi) { return v < lo ? lo : hi < v ? hi : v; } template void oneTimeSubmit(vk::UniqueCommandBuffer const& commandBuffer, vk::Queue const& queue, Func const& func) { commandBuffer->begin(vk::CommandBufferBeginInfo(vk::CommandBufferUsageFlagBits::eOneTimeSubmit)); func(commandBuffer); commandBuffer->end(); queue.submit(vk::SubmitInfo(0, nullptr, nullptr, 1, &(*commandBuffer)), nullptr); queue.waitIdle(); } template void oneTimeSubmit(vk::UniqueDevice const& device, vk::UniqueCommandPool const& commandPool, vk::Queue const& queue, Func const& func) { vk::UniqueCommandBuffer commandBuffer = std::move(device->allocateCommandBuffersUnique(vk::CommandBufferAllocateInfo(*commandPool, vk::CommandBufferLevel::ePrimary, 1)).front()); oneTimeSubmit(commandBuffer, queue, func); } vk::UniqueDeviceMemory allocateMemory(vk::UniqueDevice const& device, vk::PhysicalDeviceMemoryProperties const& memoryProperties, vk::MemoryRequirements const& memoryRequirements, vk::MemoryPropertyFlags memoryPropertyFlags); bool contains(std::vector const& extensionProperties, std::string const& extensionName); vk::UniqueCommandPool createCommandPool(vk::UniqueDevice &device, uint32_t queueFamilyIndex); vk::UniqueDebugUtilsMessengerEXT createDebugUtilsMessenger(vk::UniqueInstance &instance); vk::UniqueDescriptorPool createDescriptorPool(vk::UniqueDevice &device, std::vector const& poolSizes); vk::UniqueDescriptorSetLayout createDescriptorSetLayout(vk::UniqueDevice const& device, std::vector> const& bindingData, vk::DescriptorSetLayoutCreateFlags flags = {}); vk::UniqueDevice createDevice(vk::PhysicalDevice physicalDevice, uint32_t queueFamilyIndex, std::vector const& extensions = {}, vk::PhysicalDeviceFeatures const* physicalDeviceFeatures = nullptr, void const* pNext = nullptr); std::vector createFramebuffers(vk::UniqueDevice &device, vk::UniqueRenderPass &renderPass, std::vector const& imageViews, vk::UniqueImageView const& depthImageView, vk::Extent2D const& extent); vk::UniquePipeline createGraphicsPipeline(vk::UniqueDevice const& device, vk::UniquePipelineCache const& pipelineCache, std::pair const& vertexShaderData, std::pair const& fragmentShaderData, uint32_t vertexStride, std::vector> const& vertexInputAttributeFormatOffset, vk::FrontFace frontFace, bool depthBuffered, vk::UniquePipelineLayout const& pipelineLayout, vk::UniqueRenderPass const& renderPass); vk::UniqueInstance createInstance(std::string const& appName, std::string const& engineName, std::vector const& layers = {}, std::vector const& extensions = {}, uint32_t apiVersion = VK_API_VERSION_1_0); vk::UniqueRenderPass createRenderPass(vk::UniqueDevice &device, vk::Format colorFormat, vk::Format depthFormat, vk::AttachmentLoadOp loadOp = vk::AttachmentLoadOp::eClear, vk::ImageLayout colorFinalLayout = vk::ImageLayout::ePresentSrcKHR); VkBool32 debugUtilsMessengerCallback(VkDebugUtilsMessageSeverityFlagBitsEXT messageSeverity, VkDebugUtilsMessageTypeFlagsEXT messageTypes, VkDebugUtilsMessengerCallbackDataEXT const * pCallbackData, void * /*pUserData*/); uint32_t findGraphicsQueueFamilyIndex(std::vector const& queueFamilyProperties); std::pair findGraphicsAndPresentQueueFamilyIndex(vk::PhysicalDevice physicalDevice, vk::SurfaceKHR const& surface); uint32_t findMemoryType(vk::PhysicalDeviceMemoryProperties const& memoryProperties, uint32_t typeBits, vk::MemoryPropertyFlags requirementsMask); std::vector getDeviceExtensions(); std::vector getInstanceExtensions(); vk::Format pickDepthFormat(vk::PhysicalDevice const& physicalDevice); vk::PresentModeKHR pickPresentMode(std::vector const& presentModes); vk::SurfaceFormatKHR pickSurfaceFormat(std::vector const& formats); void setImageLayout(vk::UniqueCommandBuffer const& commandBuffer, vk::Image image, vk::Format format, vk::ImageLayout oldImageLayout, vk::ImageLayout newImageLayout); void submitAndWait(vk::UniqueDevice &device, vk::Queue queue, vk::UniqueCommandBuffer &commandBuffer); void updateDescriptorSets(vk::UniqueDevice const& device, vk::UniqueDescriptorSet const& descriptorSet, std::vector> const& bufferData, vk::su::TextureData const& textureData, uint32_t bindingOffset = 0); void updateDescriptorSets(vk::UniqueDevice const& device, vk::UniqueDescriptorSet const& descriptorSet, std::vector> const& bufferData, std::vector const& textureData, uint32_t bindingOffset = 0); #if defined(VK_USE_PLATFORM_WIN32_KHR) HWND initializeWindow(std::string const& className, std::string const& windowName, LONG width, LONG height); #else # error "unhandled platform" #endif } } std::ostream& operator<<(std::ostream& os, vk::su::UUID const& uuid);