DirectXDescriptor.h

#pragma once
 
// Standard.
#include <memory>
#include <optional>
#include <variant>
 
// Custom.
#include "DirectXDescriptorType.hpp"
#include "misc/Error.h"
 
namespace ne {
    class DirectXDescriptorHeap;
    class ContinuousDirectXDescriptorRange;
    class DirectXResource;
 
    class DirectXDescriptor {
        // We notify the heap about descriptor being no longer used in destructor.
        friend class DirectXDescriptorHeap;
 
    public:
        DirectXDescriptor() = delete;
 
        ~DirectXDescriptor();
 
        DirectXDescriptor(const DirectXDescriptor& other) = delete;
        DirectXDescriptor& operator=(const DirectXDescriptor& other) = delete;
 
        // Intentionally disable `move` because heap stores raw pointers to descriptors
        // and wraps descriptors into unique ptr to provide move functionality.
        DirectXDescriptor(DirectXDescriptor&& other) noexcept = delete;
        DirectXDescriptor& operator=(DirectXDescriptor&& other) noexcept = delete;
 
        int getOffsetInDescriptorsOnCurrentFrame() const { return iDescriptorOffsetInDescriptors; }
 
        std::variant<unsigned int, Error> getOffsetFromRangeStartOnCurrentFrame();
 
        DirectXDescriptorHeap* getDescriptorHeap() const { return pHeap; }
 
        std::shared_ptr<ContinuousDirectXDescriptorRange> getDescriptorRange() const { return pRange; }
 
        DirectXResource* getOwnerResource() const;
 
    protected:
        DirectXDescriptor(
            DirectXDescriptorHeap* pHeap,
            DirectXDescriptorType descriptorType,
            DirectXResource* pResource,
            int iDescriptorOffsetInDescriptors,
            std::optional<size_t> referencedCubemapFaceIndex,
            const std::shared_ptr<ContinuousDirectXDescriptorRange>& pRange = nullptr);
 
    private:
        int iDescriptorOffsetInDescriptors;
 
        DirectXResource* pResource = nullptr;
 
        DirectXDescriptorHeap* const pHeap = nullptr;
 
        std::shared_ptr<ContinuousDirectXDescriptorRange> const pRange = nullptr;
 
        const std::optional<size_t> referencedCubemapFaceIndex;
 
        const DirectXDescriptorType descriptorType;
    };
} // namespace ne