CommandBuffer.hpp

#pragma once
 
#include <vector>
 
#include <Common/Rect.hpp>
 
#include "Framebuffer.hpp"
 
namespace Grindstone::GraphicsAPI {
    class Buffer;
    class RenderPass;
    class Framebuffer;
    class DescriptorSet;
    class GraphicsPipeline;
    class ComputePipeline;
    class PipelineLayout;
    class VertexArrayObject;
    class DepthStencilTarget;
 
    enum class AccessFlags : uint32_t {
        None = 0,
        IndirectCommandRead = 0x00000001,
        IndexRead = 0x00000002,
        VertexAttributeRead = 0x00000004,
        UniformRead = 0x00000008,
        InputAttachmentRead = 0x00000010,
        ShaderRead = 0x00000020,
        ShaderWrite = 0x00000040,
        ColorAttachmentRead = 0x00000080,
        ColorAttachmentWrite = 0x00000100,
        DepthStencilAttachmentRead = 0x00000200,
        DepthStencilAttachmentWrite = 0x00000400,
        TransferRead = 0x00000800,
        TransferWrite = 0x00001000,
        HostRead = 0x00002000,
        HostWrite = 0x00004000,
        MemoryRead = 0x00008000,
        MemoryWrite = 0x00010000,
        TransformFeedbackWrite = 0x02000000,
        TransformFeedbackCounterRead = 0x04000000,
        TransformFeedbackCounterWrite = 0x08000000,
        ConditionalRenderingRead = 0x00100000,
        ColorAttachmentReadNoncoherent = 0x00080000,
        AccelerationStructureRead = 0x00200000,
        AccelerationStructureWrite = 0x00400000,
        FragmentDensityMapRead = 0x01000000,
        FragmentShadingRateAttachmentRead = 0x00800000,
        CommandPreprocessRead = 0x00020000,
        CommandPreprocessWrite = 0x00040000
    };
 
    struct ImageBarrier {
        Grindstone::GraphicsAPI::Image*             image = nullptr;
        Grindstone::GraphicsAPI::PipelineStageBit   srcStageMask;
        Grindstone::GraphicsAPI::PipelineStageBit   dstStageMask;
        Grindstone::GraphicsAPI::ImageLayout        oldLayout;
        Grindstone::GraphicsAPI::ImageLayout        newLayout;
        Grindstone::GraphicsAPI::AccessFlags        srcAccess;
        Grindstone::GraphicsAPI::AccessFlags        dstAccess;
        Grindstone::GraphicsAPI::ImageAspectBits    imageAspect;
        uint32_t                                    baseMipLevel = 0;
        uint32_t                                    levelCount = 0;
        uint32_t                                    baseArrayLayer = 0;
        uint32_t                                    layerCount = 0;
    };
 
    struct BufferBarrier {
        Grindstone::GraphicsAPI::Buffer*            buffer = nullptr;
        Grindstone::GraphicsAPI::PipelineStageBit   srcStageMask;
        Grindstone::GraphicsAPI::PipelineStageBit   dstStageMask;
        Grindstone::GraphicsAPI::AccessFlags        srcAccess;
        Grindstone::GraphicsAPI::AccessFlags        dstAccess;
        uint32_t                                    offset = 0;
        uint32_t                                    size = 0;
    };
 
    struct BufferCopyRegion {
        uint32_t                                srcOffset = 0;
        uint32_t                                dstOffset = 0;
        uint32_t                                size = 0;
    };
 
    struct RenderAttachment {
        Grindstone::GraphicsAPI::Image*         image = nullptr;
        Grindstone::GraphicsAPI::ImageLayout    imageLayout;
        Grindstone::GraphicsAPI::LoadOp         loadOp = Grindstone::GraphicsAPI::LoadOp::Clear;
        Grindstone::GraphicsAPI::StoreOp        storeOp = Grindstone::GraphicsAPI::StoreOp::Store;
        Grindstone::GraphicsAPI::ClearUnion     clearValue;
    };
 
    struct ClearAttachment {
        // What aspects of the image to clear.
        Grindstone::GraphicsAPI::ImageAspectBits    aspectMask;
        // Index into the bound color attachments, or unused if aspectMask isn't Color.
        uint32_t                                    colorAttachmentIndex;
        Grindstone::GraphicsAPI::ClearUnion         clearValue;
    };
 
    struct ClearRect {
        Grindstone::Math::IntRect2D     rect;
        uint32_t                        baseArrayLayer;
        uint32_t                        layerCount;
    };

    class CommandBuffer {
    public:
        virtual ~CommandBuffer() {};
 
        virtual void BeginCommandBuffer() = 0;
        virtual void BindRenderPass(
            RenderPass* renderPass,
            Framebuffer* framebuffer,
            Grindstone::Math::IntRect2D rect,
            ClearColor* colorClearValues,
            uint32_t colorClearCount,
            ClearDepthStencil depthStencilClearValue
        ) = 0;
        virtual void UnbindRenderPass() = 0;
        virtual void BeginRendering(
            const char* name,
            Grindstone::Math::IntRect2D rect,
            RenderAttachment* colorAttachments,
            uint32_t colorAttachmentCount,
            RenderAttachment* depthAttachment = nullptr,
            RenderAttachment* stencilAttachment = nullptr,
            float* debugColor = nullptr
        ) = 0;
        virtual void EndRendering() = 0;
        virtual void BeginDebugLabelSection(const char* name, float color[4] = nullptr) = 0;
        virtual void EndDebugLabelSection() = 0;
        virtual void BindGraphicsDescriptorSet(
            const GraphicsAPI::PipelineLayout* pipelineLayout,
            const DescriptorSet* const* descriptorSets,
            uint32_t descriptorSetOffset,
            uint32_t descriptorSetCount
        ) = 0;
        virtual void BindComputeDescriptorSet(
            const GraphicsAPI::PipelineLayout* pipelineLayout,
            const DescriptorSet* const* descriptorSets,
            uint32_t descriptorSetOffset,
            uint32_t descriptorSetCount
        ) = 0;
        virtual void ClearAttachments(ClearAttachment* attachments, uint32_t attachmentCount, ClearRect* rects, uint32_t rectCount) = 0;
        virtual void CopyBufferRegions(GraphicsAPI::Buffer* srcBuffer, GraphicsAPI::Buffer* dstBuffer, BufferCopyRegion* regions, uint32_t regionCount) = 0;
        virtual void CopyBufferRegion(GraphicsAPI::Buffer* srcBuffer, GraphicsAPI::Buffer* dstBuffer, uint64_t size = 0, uint32_t srcOffset = 0, uint32_t dstOffset = 0) = 0;
 
        virtual void BindCommandBuffers(CommandBuffer** commandBuffers, uint32_t commandBuffersCount) = 0;
        virtual void SetViewport(float offsetX, float offsetY, float width, float height, float depthMin = 0.0f, float depthMax = 1.0f) = 0;
        virtual void SetScissor(int32_t offsetX, int32_t offsetY, uint32_t width, uint32_t height) = 0;
        virtual void SetDepthBias(float biasConstantFactor, float biasSlopeFactor) = 0;
        virtual void BindGraphicsPipeline(const GraphicsPipeline* pipeline) = 0;
        virtual void BindComputePipeline(const ComputePipeline* pipeline) = 0;
        virtual void BindVertexArrayObject(const VertexArrayObject* vertexArrayObject) = 0;
        virtual void BindVertexBuffers(const Buffer* const * vb, uint32_t count) = 0;
        virtual void BindIndexBuffer(Buffer* indexBuffer) = 0;
        virtual void DrawVertices(uint32_t vertexCount, uint32_t firstInstance, uint32_t instanceCount, int32_t vertexOffset) = 0;
        virtual void DrawIndices(uint32_t firstIndex, uint32_t indexCount, uint32_t firstInstance, uint32_t instanceCount, int32_t vertexOffset) = 0;
        virtual void DispatchCompute(uint32_t groupCountX, uint32_t groupCountY, uint32_t groupCountZ) = 0;
        virtual void BlitImage(
            Grindstone::GraphicsAPI::Image* src,
            Grindstone::GraphicsAPI::Image* dst,
            Grindstone::GraphicsAPI::ImageLayout oldLayout,
            Grindstone::GraphicsAPI::ImageLayout newLayout,
            Grindstone::GraphicsAPI::TextureFilter filter,
            Grindstone::Math::IntBox3D srcRegion,
            Grindstone::Math::IntBox3D dstRegion
        ) = 0;
 
        virtual void PipelineBarrier(
            const GraphicsAPI::BufferBarrier* bufferBarriers, uint32_t bufferBarrierCount,
            const GraphicsAPI::ImageBarrier* imageBarriers, uint32_t imageBarrierCount
        ) = 0;
 
        virtual void EndCommandBuffer() = 0;
 
        struct CommandBufferSecondaryInfo {
            bool isSecondary = false;
            Framebuffer *framebuffer = nullptr;
            RenderPass *renderPass = nullptr;
        };
 
        struct CreateInfo {
            const char* debugName = nullptr;
            CommandBufferSecondaryInfo secondaryInfo{};
        };
    };
}
 
GS_ENUM_FLAGS_FUNCS(Grindstone::GraphicsAPI::AccessFlags)