[merge] Merge pull request #455 from inexorgame/hanni/vulkan_function_wrappers

Refactoring: Introduce wrapper functions for Vulkan create methods

Author: IAmNotHanni

include/inexor/vulkan-renderer/render_graph.hpp

@@ -70,6 +70,10 @@ class RenderResource : public RenderGraphObject {
 
     RenderResource &operator=(const RenderResource &) = delete;
     RenderResource &operator=(RenderResource &&) = delete;
+
+    [[nodiscard]] const std::string &name() const {
+        return m_name;
+    }
 };
 
 enum class BufferUsage {
@@ -197,6 +201,10 @@ class RenderStage : public RenderGraphObject {
         m_push_constant_ranges.push_back(range);
     }
 
+    [[nodiscard]] const std::string &name() const {
+        return m_name;
+    }
+
     /// @brief Specifies a function that will be called during command buffer recording for this stage
     /// @details This function can be used to specify other vulkan commands during command buffer recording. The most
     /// common use for this is for draw commands.

include/inexor/vulkan-renderer/wrapper/command_pool.hpp

@@ -11,6 +11,7 @@ class Device;
 
 /// @brief RAII wrapper class for VkCommandPool.
 class CommandPool {
+    std::string m_name;
     const Device &m_device;
     VkCommandPool m_command_pool{VK_NULL_HANDLE};
 
@@ -19,9 +20,10 @@ class CommandPool {
     /// @note It is important that the queue family index is specified in the abstraction above this command pool
     /// wrapper. We can't choose one queue family index automatically inside of this wrapper which fits every purpose,
     /// because some wrappers require a queue family index which supports graphics bit, other require transfer bit.
-    /// @param device The const reference to the device RAII wrapper class.
-    /// @param queue_family_index The queue family index which is used by this command pool.
-    CommandPool(const Device &device, std::uint32_t queue_family_index);
+    /// @param device The const reference to the device RAII wrapper class
+    /// @param queue_family_index The queue family index which is used by this command pool
+    /// @param name The internal debug marker name which will be assigned to this command pool
+    CommandPool(const Device &device, std::uint32_t queue_family_index, std::string name);
 
     CommandPool(const CommandPool &) = delete;
     CommandPool(CommandPool &&) noexcept;

include/inexor/vulkan-renderer/wrapper/cpu_texture.hpp

@@ -39,7 +39,7 @@ class CpuTexture {
     CpuTexture &operator=(const CpuTexture &) = delete;
     CpuTexture &operator=(CpuTexture &&) = default;
 
-    [[nodiscard]] std::string name() const {
+    [[nodiscard]] const std::string &name() const {
         return m_name;
     }
 

include/inexor/vulkan-renderer/wrapper/device.hpp

@@ -41,34 +41,32 @@ class Device {
 
 public:
     /// @brief Check if a certain device extension is available for a specific graphics card.
-    /// @param graphics_card The graphics card.
-    /// @param extension The name of the device extension.
-    /// @return ``true`` if the requested device extension is available.
+    /// @param graphics_card The graphics card
+    /// @param extension The name of the device extension
+    /// @return ``true`` if the requested device extension is available
     [[nodiscard]] static bool is_extension_supported(VkPhysicalDevice graphics_card, const std::string &extension);
 
     /// @brief Check if a swapchain is available for a specific graphics card.
-    /// @param graphics_card The graphics card.
-    /// @return ``true`` if swapchain is supported.
+    /// @param graphics_card The graphics card
+    /// @return ``true`` if swapchain is supported
     [[nodiscard]] static bool is_swapchain_supported(VkPhysicalDevice graphics_card);
 
     /// @brief Check if presentation is available for a specific combination of graphics card and surface.
-    /// @param graphics_card The graphics card.
-    /// @param surface The (window) surface.
-    /// @return ``true`` if presentation is supported.
+    /// @param graphics_card The graphics card
+    /// @param surface The window surface
+    /// @return ``true`` if presentation is supported
     [[nodiscard]] static bool is_presentation_supported(VkPhysicalDevice graphics_card, VkSurfaceKHR surface);
 
     /// @brief Default constructor.
-    /// @param instance The instance wrapper from which the device will be created.
-    /// @param surface The surface which will be associated with the device.
-    /// @param enable_vulkan_debug_markers True if Vulkan debug markers should be enabled, false otherwise.
-    /// @param prefer_distinct_transfer_queue True if a distinct data transfer queue (if available) should be
-    /// enabled, false otherwise.
+    /// @param instance The instance wrapper from which the device will be created
+    /// @param surface The surface which will be associated with the device
+    /// @param enable_vulkan_debug_markers ``true`` if Vulkan debug markers should be enabled
+    /// @param prefer_distinct_transfer_queue ``true`` if a distinct data transfer queue should be preferred
     /// @param preferred_physical_device_index The index of the preferred graphics card which should be used,
     /// starting from 0. If the graphics card index is invalid or if the graphics card is unsuitable for the
     /// application's purpose, another graphics card will be selected automatically. See the details of the device
-    /// selection mechanism!
-    /// @todo Add overloaded constructors for VkPhysicalDeviceFeatures and requested device extensions in the
-    /// future!
+    /// selection mechanism.
+    /// TODO: Add overloaded constructors for VkPhysicalDeviceFeatures and requested device extensions
     Device(const wrapper::Instance &instance, VkSurfaceKHR surface, bool enable_vulkan_debug_markers,
            bool prefer_distinct_transfer_queue,
            std::optional<std::uint32_t> preferred_physical_device_index = std::nullopt);
@@ -126,39 +124,131 @@ class Device {
     /// @brief Assign an internal Vulkan debug marker name to a Vulkan object.
     /// This internal name can be seen in external debuggers like RenderDoc.
     /// @note This method is only available in debug mode with ``VK_EXT_debug_marker`` device extension enabled.
-    /// @param object The Vulkan object.
-    /// @param object_type The Vulkan debug report object type.
-    /// @param name The internal name of the Vulkan object.
+    /// @param object The Vulkan object
+    /// @param object_type The Vulkan debug report object type
+    /// @param name The internal name of the Vulkan object
     void set_debug_marker_name(void *object, VkDebugReportObjectTypeEXT object_type, const std::string &name) const;
 
     /// @brief Assigns a block of memory to a Vulkan resource.
     /// This memory block can be seen in external debuggers like RenderDoc.
     /// @note This method is only available in debug mode with ``VK_EXT_debug_marker`` device extension enabled.
-    /// @param object The Vulkan object.
-    /// @param object_type The Vulkan debug report object type.
-    /// @param name The name of the memory block which will be connected to this object.
-    /// @param memory_size The size of the memory block in bytes.
-    /// @param memory_address The memory address to read from.
+    /// @param object The Vulkan object
+    /// @param object_type The Vulkan debug report object type
+    /// @param name The name of the memory block which will be connected to this object
+    /// @param memory_size The size of the memory block in bytes
+    /// @param memory_block The memory block to read from
     void set_memory_block_attachment(void *object, VkDebugReportObjectTypeEXT object_type, std::uint64_t name,
                                      std::size_t memory_size, const void *memory_block) const;
 
-    /// @param color [in] The rgba color of the rendering region.
-    /// @param name [in] The name of the rendering region.
-    /// @param command_buffer [in] The associated command buffer.
-    /// The rendering region will be visible in external debuggers like RenderDoc.
     /// @brief Vulkan debug markers: Annotation of a rendering region.
+    /// The rendering region will be visible in external debuggers like RenderDoc.
+    /// @param command_buffer The associated command buffer
+    /// @param name The name of the rendering region
+    /// @param color The rgba color of the rendering region
     void bind_debug_region(VkCommandBuffer command_buffer, const std::string &name, std::array<float, 4> color) const;
 
-    /// @brief Insert a debug markers into the current renderpass using vkCmdDebugMarkerInsertEXT. This debug
-    /// markers can be seen in external debuggers like RenderDoc.
-    /// @param command_buffer The command buffer which is associated to the debug marker.
-    /// @param name The name of the debug marker.
-    /// @param color An array of red, green, blue and alpha values for the debug region's color.
+    /// @brief Insert a debug markers into the current renderpass using vkCmdDebugMarkerInsertEXT.
+    /// This debug markers can be seen in external debuggers like RenderDoc.
+    /// @param command_buffer The command buffer which is associated to the debug marker
+    /// @param name The name of the debug marker
+    /// @param color An array of red, green, blue and alpha values for the debug region's color
     void insert_debug_marker(VkCommandBuffer command_buffer, const std::string &name, std::array<float, 4> color) const;
 
     /// @brief End the debug region of the current renderpass using vkCmdDebugMarkerEndEXT.
-    /// @param command_buffer The command buffer which is associated to the debug marker.
+    /// @param command_buffer The command buffer which is associated to the debug marker
     void end_debug_region(VkCommandBuffer command_buffer) const;
+
+    /// @brief Call vkCreateCommandPool
+    /// @param command_pool_ci The command pool create info structure
+    /// @param command_pool The command pool to create
+    /// @param name The internal debug marker name which will be assigned to this command pool
+    void create_command_pool(const VkCommandPoolCreateInfo &command_pool_ci, VkCommandPool *command_pool,
+                             const std::string &name) const;
+
+    /// @brief Call vkCreateDescriptorPool
+    /// @param descriptor_pool_ci The descriptor pool create info structure
+    /// @param descriptor_pool The descriptor pool to create
+    /// @param name The internal debug marker name which will be assigned to this command pool
+    void create_descriptor_pool(const VkDescriptorPoolCreateInfo &descriptor_pool_ci, VkDescriptorPool *descriptor_pool,
+                                const std::string &name) const;
+
+    /// @brief Call vkCreateDescriptorSetLayout
+    /// @param descriptor_set_layout_ci The descriptor set layout create info structure
+    /// @param descriptor_set_layout The descriptor set layout to create
+    /// @param name The internal debug marker name which will be assigned to this descriptor set layout
+    void create_descriptor_set_layout(const VkDescriptorSetLayoutCreateInfo &descriptor_set_layout_ci,
+                                      VkDescriptorSetLayout *descriptor_set_layout, const std::string &name) const;
+
+    /// @brief Call vkCreateFence
+    /// @param fence_ci The fence create info structure
+    /// @param fence The fence to create
+    /// @param name The internal debug marker name which will be assigned to this fence
+    void create_fence(const VkFenceCreateInfo &fence_ci, VkFence *fence, const std::string &name) const;
+
+    /// @brief Call vkCreateFramebuffer
+    /// @param framebuffer_ci The framebuffer create info structure
+    /// @param framebuffer The Vulkan framebuffer to create
+    /// @param name The internal debug marker name which will be assigned to this framebuffer
+    void create_framebuffer(const VkFramebufferCreateInfo &framebuffer_ci, VkFramebuffer *framebuffer,
+                            const std::string &name) const;
+
+    /// @brief Call vkCreateGraphicsPipelines
+    /// @param pipeline_ci The graphics pipeline create info structure
+    /// @param pipeline The graphics pipeline to create
+    /// @param name The internal debug marker name which will be assigned to this pipeline
+    // TODO: Offer parameter for Vulkan pipeline caches!
+    // TODO: Use std::span to offer a more general method (creating multiple pipelines with one call)
+    // TODO: We might want to use std::span<std::pair<VkGraphicsPipelineCreateInfo, VkPipeline *>>
+    void create_graphics_pipeline(const VkGraphicsPipelineCreateInfo &pipeline_ci, VkPipeline *pipeline,
+                                  const std::string &name) const;
+
+    /// @brief Call vkCreateImageView
+    /// @param image_view_ci The image view create info structure
+    /// @param image_view The image view to create
+    /// @param name The internal debug marker name which will be assigned to this image view
+    void create_image_view(const VkImageViewCreateInfo &image_view_ci, VkImageView *image_view,
+                           const std::string &name) const;
+
+    /// @brief Call vkCreatePipelineLayout
+    /// @param pipeline_layout_ci The pipeline layout create info structure
+    /// @param pipeline_layout The pipeline layout to create
+    /// @param name The internal debug marker name which will be assigned to this pipeline layout
+    void create_pipeline_layout(const VkPipelineLayoutCreateInfo &pipeline_layout_ci, VkPipelineLayout *pipeline_layout,
+                                const std::string &name) const;
+
+    /// @brief Call vkCreateRenderPass
+    /// @param render_pass_ci The render pass create info structure
+    /// @param render_pass The render pass to create
+    /// @param name The internal debug marker name which will be assigned to this render pass
+    void create_render_pass(const VkRenderPassCreateInfo &render_pass_ci, VkRenderPass *render_pass,
+                            const std::string &name) const;
+
+    /// @brief Call vkCreateSampler
+    /// @param sampler_ci The sampler create info structure
+    /// @param sampler The sampler to create
+    /// @param name The internal debug marker name which will be assigned to this sampler
+    void create_sampler(const VkSamplerCreateInfo &sampler_ci, VkSampler *sampler, const std::string &name) const;
+
+    /// @brief Call vkCreateSemaphore
+    /// @param semaphore_ci The semaphore create info structure
+    /// @param semaphore The semaphore to create
+    /// @param name The internal debug marker name which will be assigned to this semaphore
+    void create_semaphore(const VkSemaphoreCreateInfo &semaphore_ci, VkSemaphore *semaphore,
+                          const std::string &name) const;
+
+    /// @brief Call vkCreateShaderModule
+    /// @param shader_module_ci The shader module create info structure
+    /// @param shader_module The shader module to create
+    /// @param name The internal debug marker name which will be assigned to this shader module
+    void create_shader_module(const VkShaderModuleCreateInfo &shader_module_ci, VkShaderModule *shader_module,
+                              const std::string &name) const;
+
+    /// @brief Call vkCreateSwapchainKHR
+    /// @param swapchain_ci The swapchain_ci create info structure
+    /// @param swapchain The swapchain to create
+    /// @param name The internal debug marker name which will be assigned to this swapchain
+    void create_swapchain(const VkSwapchainCreateInfoKHR &swapchain_ci, VkSwapchainKHR *swapchain,
+                          const std::string &name) const;
 };
 
 } // namespace inexor::vulkan_renderer::wrapper

include/inexor/vulkan-renderer/wrapper/gpu_texture.hpp

@@ -74,7 +74,7 @@ class GpuTexture {
     GpuTexture &operator=(const GpuTexture &) = delete;
     GpuTexture &operator=(GpuTexture &&) = delete;
 
-    [[nodiscard]] std::string name() const {
+    [[nodiscard]] const std::string &name() const {
         return m_name;
     }
 

include/inexor/vulkan-renderer/wrapper/once_command_buffer.hpp

@@ -19,6 +19,7 @@ class Device;
 /// tell the driver about our intent using VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT.
 class OnceCommandBuffer {
     const Device &m_device;
+    std::string m_name;
     // We must store the VkQueue separately since we don't know from
     // the context of the use of this OnceCommandBuffer which queue to use!
     VkQueue m_queue{VK_NULL_HANDLE};
@@ -32,10 +33,11 @@ class OnceCommandBuffer {
     /// @param device The const reference to a device RAII wrapper instance.
     /// @param queue The Vulkan queue to use.
     /// @param queue_family_index The Vulkan queue family index to use.
+    /// @param name The internal debug marker name which will be assigned to this command buffer
     /// @warn We can't determine the queue and queue family index to use automatically using the device wrapper
     /// reference because we might choose a queue which is unsuitable for the requested purpose!
     /// This is the reason we must specify the queue and queue family index in the constructor.
-    OnceCommandBuffer(const Device &device, VkQueue queue, std::uint32_t queue_family_index);
+    OnceCommandBuffer(const Device &device, VkQueue queue, std::uint32_t queue_family_index, const std::string &name);
 
     OnceCommandBuffer(const OnceCommandBuffer &) = delete;
     OnceCommandBuffer(OnceCommandBuffer &&) noexcept;

src/vulkan-renderer/application.cpp

@@ -483,7 +483,8 @@ Application::Application(int argc, char **argv) {
     load_textures();
     load_shaders();
 
-    m_command_pool = std::make_unique<wrapper::CommandPool>(*m_device, m_device->graphics_queue_family_index());
+    m_command_pool =
+        std::make_unique<wrapper::CommandPool>(*m_device, m_device->graphics_queue_family_index(), "command pool");
 
     m_uniform_buffers.emplace_back(*m_device, "matrices uniform buffer", sizeof(UniformBufferObject));