#pragma once #include "core/device.hpp" #include #include namespace LSFG::Core { /// /// C++ wrapper class for a Vulkan image. /// /// This class manages the lifetime of a Vulkan image. /// class Image { public: Image() noexcept = default; /// /// Create the image. /// /// @param device Vulkan device /// @param extent Extent of the image in pixels. /// @param format Vulkan format of the image /// @param usage Usage flags for the image /// @param aspectFlags Aspect flags for the image view /// /// @throws LSFG::vulkan_error if object creation fails. /// Image(const Core::Device& device, VkExtent2D extent, VkFormat format = VK_FORMAT_R8G8B8A8_UNORM, VkImageUsageFlags usage = VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_SAMPLED_BIT, VkImageAspectFlags aspectFlags = VK_IMAGE_ASPECT_COLOR_BIT); /// /// Create the image with shared backing memory. /// /// @param device Vulkan device /// @param extent Extent of the image in pixels. /// @param format Vulkan format of the image /// @param usage Usage flags for the image /// @param aspectFlags Aspect flags for the image view /// @param fd File descriptor for shared memory. /// /// @throws LSFG::vulkan_error if object creation fails. /// Image(const Core::Device& device, VkExtent2D extent, VkFormat format, VkImageUsageFlags usage, VkImageAspectFlags aspectFlags, int fd); /// Get the Vulkan handle. [[nodiscard]] auto handle() const { return *this->image; } /// Get the Vulkan device memory handle. [[nodiscard]] auto getMemory() const { return *this->memory; } /// Get the Vulkan image view handle. [[nodiscard]] auto getView() const { return *this->view; } /// Get the extent of the image. [[nodiscard]] VkExtent2D getExtent() const { return this->extent; } /// Get the format of the image. [[nodiscard]] VkFormat getFormat() const { return this->format; } /// Get the aspect flags of the image. [[nodiscard]] VkImageAspectFlags getAspectFlags() const { return this->aspectFlags; } /// Set the layout of the image. void setLayout(VkImageLayout layout) { *this->layout = layout; } /// Get the current layout of the image. [[nodiscard]] VkImageLayout getLayout() const { return *this->layout; } /// Trivially copyable, moveable and destructible Image(const Image&) noexcept = default; Image& operator=(const Image&) noexcept = default; Image(Image&&) noexcept = default; Image& operator=(Image&&) noexcept = default; ~Image() = default; private: std::shared_ptr image; std::shared_ptr memory; std::shared_ptr view; std::shared_ptr layout; VkExtent2D extent{}; VkFormat format{}; VkImageAspectFlags aspectFlags{}; }; }