VKImage.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "VKCommon.hpp"
 
#include "VKMemoryAllocator.hpp"
 
#include "CeresEngine/DataTypes.hpp"
#include "CeresEngine/Macros.hpp"
 
#include "CeresEngine/Foundation/Container/SmallVector.hpp"
 
#include "CeresEngine/RenderAPI/GPUImage.hpp"
 
namespace CeresEngine {
    class GPUBuffer;
}
 
namespace CeresEngine {
 
    class VKCommandBuffer;
 
    using VKImageViewCache = VKObjectCache<VKImageView, VKImage, GPUImageViewDescriptor>;
 
    class VKImage final : public GPUImage, public VKDeviceObject<VKImage, GPUImage> {
        using super = GPUImage;
        friend class VKImageView;
 
    private:
        const GPUImageDescriptor mDescriptor;
 
        VkImage mImage = VK_NULL_HANDLE;
 
        VKMemoryAllocation mImageMemory;
 
        VkDeviceSize mSize = 0;
 
        VkFormat mFormat [[maybe_unused]];
 
        bool mOwns = true;
 
        VKImageViewCache mImageViews;
 
        SmallVector<VkImageLayout, 10> mLayouts;
 
        VKSwapchain* mSwapchain = nullptr;
 
    public:
        VKImage(VKDevice& device, const GPUImageDescriptor& descriptor);
        VKImage(VKDevice& device, const GPUImageDescriptor& descriptor, VkImage existingImage, VKSwapchain* swapchain);
        ~VKImage() final;
 
        using Allocator = VKObjectAllocator;
 
        static Allocator& getAllocator() noexcept;
 
        static void* operator new(size_t size) noexcept;
 
        static void operator delete(void* p, std::size_t size) noexcept;
 
        [[nodiscard]] CE_EXPLICIT_FALSE operator VkImage() const noexcept { return mImage; }
 
    public:
        GPUImageViewPtr createView(const GPUImageViewDescriptor& descriptor) final;
 
    private:
        void transitionImageLayout(VkCommandBuffer commandBuffer, VkImageLayout oldLayout, VkImageLayout newLayout, UInt32 mipLevel, UInt32 layer);
 
    public:
        void transitionImageLayout(VkCommandBuffer commandBuffer, VkImageLayout newLayout, const GPUImageSubresource& subresource);
 
        void transitionImageLayout(const VkCommandBuffer commandBuffer, const VkImageLayout newLayout, const GPUImageLocation& location) {
            transitionImageLayout(commandBuffer, newLayout,
                GPUImageSubresource{
                    .baseArrayLayer = location.arrayLayer,
                    .numArrayLayers = 1,
                    .baseMipLevel = location.mipLevel,
                    .numMipLevels = 1,
                });
        }
 
        void transitionImageLayout(const VkCommandBuffer commandBuffer, const VkImageLayout newLayout) {
            transitionImageLayout(commandBuffer, newLayout,
                GPUImageSubresource{
                    .baseArrayLayer = 0,
                    .numArrayLayers = descriptor.arrayLayers,
                    .baseMipLevel = 0,
                    .numMipLevels = descriptor.mipLevels,
                });
        }
 
        [[nodiscard]] VkImageLayout getLayout(UInt32 mipLevel, UInt32 layer = 0) const;
 
        void setLayout(VkImageLayout newLayout, UInt32 mipLevel, UInt32 layer = 0);
        void setLayout(VkImageLayout newLayout, const GPUImageSubresource& subresource);
 
        void generateMips(VkCommandBuffer commandBuffer);
 
    public:
        [[nodiscard]] UInt32 getMipLevels() const;
 
        [[nodiscard]] VKSwapchain* getSwapchain() const noexcept { return mSwapchain; }
    };
 
    class VKImageView final : public GPUImageView, public VKDeviceObject<VKImageView, GPUImageView> {
    private:
        const GPUImageViewDescriptor mDescriptor;
 
        VkImageView mImageView;
 
        VKImagePtr mImage;
 
    public:
        VKImageView(VKImage& image, const GPUImageViewDescriptor& descriptor);
        ~VKImageView() final;
 
        void destroy() noexcept final;
 
        using Allocator = VKObjectAllocator;
 
        static Allocator& getAllocator() noexcept;
 
        static void* operator new(size_t size) noexcept;
 
        static void operator delete(void* p, std::size_t size) noexcept;
 
        [[nodiscard]] CE_EXPLICIT_FALSE operator VkImageView() const noexcept { return mImageView; }
    };
 
} // namespace CeresEngine