RenderPass.hpp

Go to the documentation of this file.

#pragma once
#include <RHICore/Command.hpp>
#include <RHICore/Descriptor.hpp>
#include <RHICore/Device.hpp>
#include <RHICore/PipelineState.hpp>
namespace Foundation::RenderCore
{
    using namespace RHI;
    class Renderer;
    using PassHandle = Handle; // Index in the pass definitions vector
    using ResourceHandle = Handle; // Index in the resource definitions vector
    class RenderPass : public RHIObject
    {
    public:
        RenderPass() = default;
        virtual void Setup(PassHandle self, Renderer* r) = 0;
        virtual void Record(PassHandle self, Renderer* r, RHICommandList* cmd) = 0;
    };
    struct FSetupDefault
    {
        void operator()(PassHandle, Renderer*) const { /* nop */ }
    };
    struct FRecordDefault
    {
        void operator()(PassHandle, Renderer*, RHICommandList*) const { /* nop */ }
    };
    template <typename FSetup, typename FRecord>
    struct LambdaPass : RenderPass
    {
        FSetup mSetup;
        FRecord mRecord;
        LambdaPass(FSetup&& setup, FRecord&& record) :
            mSetup(std::forward<FSetup>(setup)), mRecord(std::forward<FRecord>(record))
        {
        }
        void Setup(PassHandle self, Renderer* r) override { mSetup(self, r); }
        void Record(PassHandle self, Renderer* r, RHICommandList* cmd) override { mRecord(self, r, cmd); }
    };
    struct TrackedPass
    {
        String name;
        PassHandle handle; // Index to tracked passes
        int priority{0}; // Higher priority passes are scheduled earlier
        // The queue to run this pass on
        RHIDeviceQueueType queue;
        bool used{false}; // Culled?
        // Backbuffer specializations
        Optional<RHIPipelineState::PipelineStateDesc::Attachment::Blending> backbufferRTV{}; // opt: blending mode
        Optional<int> backbufferUAV; // opt: set index
        // Uses compute shader? (not necessarily in a compute queue)
        // Should be mutually exclusive with write_backbuffer and other graphics states
        bool isComputePass{false};
        // Uses RayGen/RayHit/RayMiss at all?
        // Should be compatible with most graphics states, and can be run on either queue
        bool isRayTracingPass{false};
        // Local size for compute/mesh shaders        
        Tuple<uint32_t, uint32_t, uint32_t> groupLocalSize{};
        size_t depth{}; // Depth in RG
        size_t ord{}; // Execution order
        size_t frameExec{}; // Last frame this pass is executed
        /* -- Resources -- */
        Vector<PassHandle> bindPasses; // Referenced, explicit pass execute-before.
        Vector<Tuple<ResourceHandle, RHIResourceAccess, RHIPipelineStage, RHITextureSubresourceRange,
                     RHITextureLayout>>
            textureUsages; // Referenced texture sub resources
        Vector<Tuple<ResourceHandle, RHIResourceAccess,
                     RHIPipelineStage>> bufferUsages; // Referenced buffers
        Vector<Tuple<ResourceHandle, RHIResourceAccess,
             RHIPipelineStage>> asUsages; // Referenced Acceleration Structures
        // Unique referenced resources (tex/buf/AS)
        Vector<ResourceHandle> resources;
        // Unique texture views
        Vector<ResourceHandle> texviews;
        /* -- Pipeline -- */
        // Shader [path, entry point, stage, specialization data, RT hit group, RT hit group type]
        Vector<Tuple<String, String, RHIShaderStage, Vector<char>, uint32_t,
                     RHIPipelineState::PipelineStateDesc::RayTracingHitGroupType>> shaders;
        // Bind points [view(tex) or buffer(buf), desc type, binding point]
        Vector<Tuple<ResourceHandle, RHIDescriptorType, String>> textureBindings, bufferBindings, asBindings;
        // External Bind Sets [binding point, layout ptr, set index (set when built)]
        // Sorted lexicographically if the pipeline is built.
        Vector<Tuple<String, RHIDeviceDescriptorSetLayout*, int>> externalBindings;
        // Samplers
        Vector<Pair<ResourceHandle, String>> samplers;
        // Push Constant
        Vector<RHIPipelineState::PipelineStateDesc::PushConstant> pushConstants;
        // Specialization Constants by [stage, offset, value]
        Vector<Tuple<RHIShaderStage, size_t, Vector<char>>> specializationConstants;
        // (Graphics Only) Render Target View[s], Blending Op
        Vector<Pair<ResourceHandle, RHIPipelineState::PipelineStateDesc::Attachment::Blending>> rtvs;
        // (Graphics Only) Depth Stencil View
        ResourceHandle dsv{kInvalidHandle};
        // (Graphics Only) Vertex Input assembly
        Vector<RHIPipelineState::PipelineStateDesc::VertexInput::Binding> vertexInputBindings;
        Vector<RHIVertexAttribute> vertexInputAttributes;
        /* --- */
        UniquePtr<RenderPass> pass;
        TrackedPass(Allocator* alloc, PassHandle handle, StringView name, RHIDeviceQueueType queue,
                    UniquePtr<RenderPass> renderPass, size_t priority);
        /* -- Pipeline states (built at PSO setup) -- */
        int groupIndex{}; // executionGroup index
        // All stages used in this pass
        RHIPipelineStageBits piplineStages{};
        // Pipeline states for the entire pass
        RHIDeviceScopedHandle<RHIPipelineState> pso;
        // PSO Creation parameters
        RHIPipelineState::PipelineStateDesc::Rasterizer psoRasterizer{};
        RHIPipelineState::PipelineStateDesc::DepthStencil psoDepthStencil{};
        RHIPipelineState::PipelineStateDesc::Topology psoTopology{
            RHIPipelineState::PipelineStateDesc::TriangleList};
        // Layouts created by ourselves
        Vector<RHIDeviceScopedHandle<RHIDeviceDescriptorSetLayout>> descriptorLayouts;
        // Pointers. Can also contain external sets
        Vector<RHIDeviceDescriptorSetLayout*> pDescriptorLayouts;
        // Sets created by ourselves
        Vector<RHIDeviceDescriptorPoolScopedHandle<RHIDeviceDescriptorSet>> descriptorSets;
        // Pointers. Can also contain external sets
        Vector<RHIDeviceDescriptorSet*> pDescriptorSets;
        // [Set Index, Set, Layout], correspond to externalBindings
        Vector<Tuple<size_t, RHIDeviceDescriptorSetLayout*>> pExternalDescriptorSets;
 
 
        RHIDevicePipelineType GetPipelineType() const
        {
            if (isComputePass) return RHIDevicePipelineType::Compute;
            if (isRayTracingPass) return RHIDevicePipelineType::RayTracing;
            return RHIDevicePipelineType::Graphics;
        }
        void ResetPipeline();
    };
}