RenderGraphImage.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 "Forward.hpp"
 
#include "RenderGraphResource.hpp"
 
#include "CeresEngine/DataTypes.hpp"
 
#include "CeresEngine/RenderAPI/GPUImage.hpp"
 
namespace CeresEngine::RenderGraph2 {
 
    class RenderGraph;
 
    enum class RenderGraphImageSizeClass {
        Absolute,
 
        SwapChainRelative,
 
        InputRelative
    };
 
    struct RenderGraphImageDescriptor final {
        GPUImageType type = GPUImageType::Image2D;
 
        GPUImageUsage usage = GPUImageUsageFlags::Sample | GPUImageUsageFlags::Attachment;
 
        Format format = Format::Undefined;
 
        RenderGraphImageSizeClass sizeClass = RenderGraphImageSizeClass::SwapChainRelative;
 
        Extent3 extent = {1, 1, 1};
 
        UInt32 arrayLayers = 1;
 
        UInt32 mipLevels = 1;
 
        UInt32 samples = 1;
 
        bool persistent = false;
    };
 
    class RenderGraphImage : public RenderGraphResource {
    protected:
        RenderGraphImageDescriptor mDescriptor;
 
        GPUImagePtr mImage;
 
    public:
        explicit RenderGraphImage(RenderGraph& graph, const RenderGraphImageDescriptor& descriptor) : RenderGraphResource(graph), mDescriptor(descriptor) {}
 
    public:
        [[nodiscard]] const RenderGraphImageDescriptor getDescriptor() const noexcept { return mDescriptor; }
 
        [[nodiscard]] const GPUImagePtr getImage() const noexcept { return mImage; }
 
        void setImage(const GPUImagePtr image);
 
    public: // RenderGraphResource interface
        [[nodiscard]] RenderGraphResourceType getType() const noexcept final { return RenderGraphResourceType::Image; }
    };
 
    using RenderGraphImagePtr = RC<RenderGraphImage>;
 
} // namespace CeresEngine::RenderGraph2