ShadowMapHandle.h

#pragma once
 
// Standard.
#include <functional>
#include <mutex>
 
// Custom.
#include "ShadowMapType.hpp"
 
// External.
#include "vulkan/vulkan_core.h"
 
namespace ne {
    class ShadowMapManager;
    class GpuResource;
 
    class ShadowMapHandle {
        // Only manager can create and update objects of this class.
        friend class ShadowMapManager;
 
        // Index manager updates array index.
        friend class ShadowMapArrayIndexManager;
 
    public:
        struct InternalResources {
            InternalResources() = default;
 
            GpuResource* pDepthTexture = nullptr;
 
            GpuResource* pColorTexture = nullptr;
 
            std::vector<VkFramebuffer> vShadowMappingFramebuffers;
        };
 
        ShadowMapHandle() = delete;
 
        ShadowMapHandle(const ShadowMapHandle&) = delete;
        ShadowMapHandle& operator=(const ShadowMapHandle&) = delete;
 
        // Intentionally disallow `move` because manager wraps handles to `std::unique_ptr`
        // to store raw pointer to shadow map handle and we need to make sure nobody will
        // accidentally `move` the handle which will cause the manager's raw pointer to be invalid.
        ShadowMapHandle(ShadowMapHandle&& other) noexcept = delete;
        ShadowMapHandle& operator=(ShadowMapHandle&& other) noexcept = delete;
 
        ~ShadowMapHandle();
 
        inline std::pair<std::recursive_mutex, InternalResources>* getResources() { return &mtxResources; }
 
        inline ShadowMapType getShadowMapType() const { return shadowMapType; }
 
        inline size_t getShadowMapSize() const { return iShadowMapSize; }
 
    private:
        ShadowMapHandle(
            ShadowMapManager* pManager,
            GpuResource* pDepthTexture,
            ShadowMapType type,
            size_t iTextureSize,
            const std::function<void(unsigned int)>& onArrayIndexChanged,
            GpuResource* pColorTexture = nullptr);
 
        void changeArrayIndex(unsigned int iNewArrayIndex);
 
        void setUpdatedResources(
            GpuResource* pDepthTexture, size_t iShadowMapSize, GpuResource* pColorTexture = nullptr);
 
        void recreateFramebuffers();
 
        ShadowMapManager* pManager = nullptr;
 
        std::pair<std::recursive_mutex, InternalResources> mtxResources;
 
        size_t iShadowMapSize = 0;
 
        const std::function<void(unsigned int)> onArrayIndexChanged;
 
        const ShadowMapType shadowMapType = ShadowMapType::DIRECTIONAL;
    };
}