gfx_device_vulkan.hpp

// Copyright Take Vos 2019-2020.
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
 
#pragma once
 
#include "gfx_device.hpp"
#include "gfx_system_globals.hpp"
#include "gfx_queue_vulkan.hpp"
#include "pipeline_image_device_shared.hpp"
#include "pipeline_box_device_shared.hpp"
#include "pipeline_SDF_device_shared.hpp"
#include "pipeline_tone_mapper_device_shared.hpp"
#include <vulkan/vulkan.hpp>
#include <vk_mem_alloc.h>
 
namespace hi::inline v1 {
class URL;
 
class gfx_device_vulkan final : public gfx_device {
public:
    vk::PhysicalDeviceType deviceType = vk::PhysicalDeviceType::eOther;
    vk::PhysicalDeviceProperties physicalProperties;
 
    std::vector<gfx_queue_vulkan> _queues;
 
    vk::PhysicalDeviceFeatures device_features;
 
    [[nodiscard]] gfx_queue_vulkan const &get_graphics_queue() const noexcept;
 
    [[nodiscard]] gfx_queue_vulkan const &get_graphics_queue(gfx_surface const &surface) const noexcept;
 
    [[nodiscard]] gfx_queue_vulkan const &get_present_queue(gfx_surface const &surface) const noexcept;
 
    [[nodiscard]] vk::SurfaceFormatKHR get_surface_format(gfx_surface const &surface, int *score = nullptr) const noexcept;
 
    [[nodiscard]] vk::PresentModeKHR get_present_mode(gfx_surface const &surface, int *score = nullptr) const noexcept;
 
    vk::Buffer quadIndexBuffer;
    VmaAllocation quadIndexBufferAllocation = {};
 
    std::unique_ptr<pipeline_box::device_shared> boxPipeline;
    std::unique_ptr<pipeline_image::device_shared> imagePipeline;
    std::unique_ptr<pipeline_SDF::device_shared> SDFPipeline;
    std::unique_ptr<pipeline_tone_mapper::device_shared> toneMapperPipeline;
 
    std::vector<const char *> requiredExtensions;
 
    bool supportsLazyTransientImages = false;
    vk::ImageUsageFlags transientImageUsageFlags = vk::ImageUsageFlags{};
    VmaMemoryUsage lazyMemoryUsage = VMA_MEMORY_USAGE_GPU_ONLY;
 
    gfx_device_vulkan(gfx_system &system, vk::PhysicalDevice physicalDevice);
    ~gfx_device_vulkan();
 
    gfx_device_vulkan(const gfx_device_vulkan &) = delete;
    gfx_device_vulkan &operator=(const gfx_device_vulkan &) = delete;
    gfx_device_vulkan(gfx_device_vulkan &&) = delete;
    gfx_device_vulkan &operator=(gfx_device_vulkan &&) = delete;
 
    int score(vk::SurfaceKHR surface) const;
 
    int score(gfx_surface const &surface) const override;
 
    std::vector<std::pair<uint32_t, uint8_t>> find_best_queue_family_indices(vk::SurfaceKHR surface) const;
 
    std::pair<vk::Buffer, VmaAllocation>
    createBuffer(const vk::BufferCreateInfo &bufferCreateInfo, const VmaAllocationCreateInfo &allocationCreateInfo) const;
 
    void destroyBuffer(const vk::Buffer &buffer, const VmaAllocation &allocation) const;
 
    std::pair<vk::Image, VmaAllocation>
    createImage(const vk::ImageCreateInfo &imageCreateInfo, const VmaAllocationCreateInfo &allocationCreateInfo) const;
    void destroyImage(const vk::Image &image, const VmaAllocation &allocation) const;
 
    vk::CommandBuffer beginSingleTimeCommands() const;
    void endSingleTimeCommands(vk::CommandBuffer commandBuffer) const;
 
    static void transition_layout(
        vk::CommandBuffer command_buffer,
        vk::Image image,
        vk::Format format,
        vk::ImageLayout src_layout,
        vk::ImageLayout dst_layout);
    void transition_layout(vk::Image image, vk::Format format, vk::ImageLayout src_layout, vk::ImageLayout dst_layout) const;
 
    void copyImage(
        vk::Image srcImage,
        vk::ImageLayout srcLayout,
        vk::Image dstImage,
        vk::ImageLayout dstLayout,
        vk::ArrayProxy<vk::ImageCopy const> regions) const;
    void clearColorImage(
        vk::Image image,
        vk::ImageLayout layout,
        vk::ClearColorValue const &color,
        vk::ArrayProxy<const vk::ImageSubresourceRange> ranges) const;
 
    template<typename T>
    std::span<T> mapMemory(const VmaAllocation &allocation) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
 
        void *mapping;
        hilet result = static_cast<vk::Result>(vmaMapMemory(allocator, allocation, &mapping));
 
        VmaAllocationInfo allocationInfo;
        vmaGetAllocationInfo(allocator, allocation, &allocationInfo);
 
        // Should we launder the pointer? The GPU has created the objects, not the C++ application.
        T *mappingT = reinterpret_cast<T *>(mapping);
        hilet mappingSpan = std::span<T>(mappingT, allocationInfo.size / sizeof(T));
 
        return vk::createResultValue(result, mappingSpan, "hi::gfx_device_vulkan::mapMemory");
    }
 
    void unmapMemory(const VmaAllocation &allocation) const;
 
    void flushAllocation(const VmaAllocation &allocation, VkDeviceSize offset, VkDeviceSize size) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
 
        hilet alignment = physicalProperties.limits.nonCoherentAtomSize;
 
        hilet alignedOffset = (offset / alignment) * alignment;
        hilet adjustedSize = size + (offset - alignedOffset);
        hilet alignedSize = ((adjustedSize + (alignment - 1)) / alignment) * alignment;
 
        vmaFlushAllocation(allocator, allocation, alignedOffset, alignedSize);
    }
 
    vk::ShaderModule loadShader(uint32_t const *data, std::size_t size) const;
 
    vk::ShaderModule loadShader(std::span<std::byte const> shaderObjectBytes) const;
 
    vk::ShaderModule loadShader(URL const &shaderObjectLocation) const;
 
    void waitIdle() const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.waitIdle();
    }
 
    vk::Result waitForFences(vk::ArrayProxy<const vk::Fence> fences, vk::Bool32 waitAll, uint64_t timeout) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.waitForFences(fences, waitAll, timeout);
    }
 
    vk::Result acquireNextImageKHR(
        vk::SwapchainKHR swapchain,
        uint64_t timeout,
        vk::Semaphore semaphore,
        vk::Fence fence,
        uint32_t *pImageIndex) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.acquireNextImageKHR(swapchain, timeout, semaphore, fence, pImageIndex);
    }
 
    void resetFences(vk::ArrayProxy<const vk::Fence> fences) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.resetFences(fences);
    }
 
    vk::Result createSwapchainKHR(
        const vk::SwapchainCreateInfoKHR *pCreateInfo,
        const vk::AllocationCallbacks *pAllocator,
        vk::SwapchainKHR *pSwapchain) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.createSwapchainKHR(pCreateInfo, pAllocator, pSwapchain);
    }
 
    std::vector<vk::Image> getSwapchainImagesKHR(vk::SwapchainKHR swapchain) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.getSwapchainImagesKHR(swapchain);
    }
 
    vk::ImageView createImageView(const vk::ImageViewCreateInfo &createInfo) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.createImageView(createInfo);
    }
 
    vk::Framebuffer createFramebuffer(const vk::FramebufferCreateInfo &createInfo) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.createFramebuffer(createInfo);
    }
 
    vk::RenderPass createRenderPass(const vk::RenderPassCreateInfo &createInfo) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.createRenderPass(createInfo);
    }
 
    vk::Extent2D getRenderAreaGranularity(const vk::RenderPass &render_pass) const noexcept
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        vk::Extent2D r;
        intrinsic.getRenderAreaGranularity(render_pass, &r);
        return r;
    }
 
    vk::Semaphore createSemaphore(const vk::SemaphoreCreateInfo &createInfo) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.createSemaphore(createInfo);
    }
 
    vk::Fence createFence(const vk::FenceCreateInfo &createInfo) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.createFence(createInfo);
    }
 
    vk::DescriptorSetLayout createDescriptorSetLayout(const vk::DescriptorSetLayoutCreateInfo &createInfo) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.createDescriptorSetLayout(createInfo);
    }
 
    vk::DescriptorPool createDescriptorPool(const vk::DescriptorPoolCreateInfo &createInfo) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.createDescriptorPool(createInfo);
    }
 
    vk::PipelineLayout createPipelineLayout(const vk::PipelineLayoutCreateInfo &createInfo) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.createPipelineLayout(createInfo);
    }
 
    vk::Pipeline createGraphicsPipeline(vk::PipelineCache pipelineCache, const vk::GraphicsPipelineCreateInfo &createInfo) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.createGraphicsPipeline(pipelineCache, createInfo).value;
    }
 
    vk::Sampler createSampler(const vk::SamplerCreateInfo &createInfo) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.createSampler(createInfo);
    }
 
    std::vector<vk::DescriptorSet> allocateDescriptorSets(const vk::DescriptorSetAllocateInfo &allocateInfo) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.allocateDescriptorSets(allocateInfo);
    }
 
    std::vector<vk::CommandBuffer> allocateCommandBuffers(const vk::CommandBufferAllocateInfo &allocateInfo) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.allocateCommandBuffers(allocateInfo);
    }
 
    void updateDescriptorSets(
        vk::ArrayProxy<const vk::WriteDescriptorSet> descriptorWrites,
        vk::ArrayProxy<const vk::CopyDescriptorSet> descriptorCopies) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.updateDescriptorSets(descriptorWrites, descriptorCopies);
    }
 
    void freeCommandBuffers(vk::CommandPool commandPool, vk::ArrayProxy<const vk::CommandBuffer> commandBuffers) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return intrinsic.freeCommandBuffers(commandPool, commandBuffers);
    }
 
    void setDebugUtilsObjectNameEXT(vk::DebugUtilsObjectNameInfoEXT const &name_info) const;
 
    void setDebugUtilsObjectNameEXT(vk::Image image, char const *name) const
    {
        return setDebugUtilsObjectNameEXT(
            vk::DebugUtilsObjectNameInfoEXT{vk::ObjectType::eImage, std::bit_cast<uint64_t>(image), name});
    }
 
    void setDebugUtilsObjectNameEXT(vk::Buffer buffer, char const *name) const
    {
        return setDebugUtilsObjectNameEXT(
            vk::DebugUtilsObjectNameInfoEXT{vk::ObjectType::eBuffer, std::bit_cast<uint64_t>(buffer), name});
    }
 
    void setDebugUtilsObjectNameEXT(vk::Sampler sampler, char const *name) const
    {
        return setDebugUtilsObjectNameEXT(
            vk::DebugUtilsObjectNameInfoEXT{vk::ObjectType::eSampler, std::bit_cast<uint64_t>(sampler), name});
    }
 
    void setDebugUtilsObjectNameEXT(vk::ShaderModule shader_module, char const *name) const
    {
        return setDebugUtilsObjectNameEXT(
            vk::DebugUtilsObjectNameInfoEXT{vk::ObjectType::eShaderModule, std::bit_cast<uint64_t>(shader_module), name});
    }
 
    void cmdBeginDebugUtilsLabelEXT(vk::CommandBuffer buffer, vk::DebugUtilsLabelEXT const &create_info) const;
    void cmdEndDebugUtilsLabelEXT(vk::CommandBuffer buffer) const;
 
    void cmdBeginDebugUtilsLabelEXT(vk::CommandBuffer buffer, char const *name) const
    {
        return cmdBeginDebugUtilsLabelEXT(buffer, vk::DebugUtilsLabelEXT{name});
    }
 
    template<typename T>
    void destroy(T x) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        intrinsic.destroy(x);
    }
 
    vk::SurfaceCapabilitiesKHR getSurfaceCapabilitiesKHR(vk::SurfaceKHR surface) const
    {
        hi_axiom(gfx_system_mutex.recurse_lock_count());
        return physicalIntrinsic.getSurfaceCapabilitiesKHR(surface);
    }
 
    void log_memory_usage() const noexcept override;
 
protected:
    vk::PhysicalDevice physicalIntrinsic;
    vk::Device intrinsic;
    VmaAllocator allocator;
 
private:
    [[nodiscard]] std::vector<vk::DeviceQueueCreateInfo> make_device_queue_create_infos() const noexcept;
    void initialize_queues(std::vector<vk::DeviceQueueCreateInfo> const &device_queue_create_infos) noexcept;
    void initialize_device();
    void initialize_quad_index_buffer();
    void destroy_quad_index_buffer();
};
 
} // namespace hi::inline v1