vulkan_builders.hpp

#pragma once
 
#include <litefx/rendering_builders.hpp>
#include "vulkan_api.hpp"
#include "vulkan.hpp"
 
#if defined(BUILD_DEFINE_BUILDERS)
namespace LiteFX::Rendering::Backends {
    using namespace LiteFX::Math;
    using namespace LiteFX::Rendering;
 
    class LITEFX_VULKAN_API VulkanShaderProgramBuilder : public ShaderProgramBuilder<VulkanShaderProgramBuilder, VulkanShaderProgram> {
        LITEFX_IMPLEMENTATION(VulkanShaderProgramBuilderImpl);
 
    public:
        explicit VulkanShaderProgramBuilder(const VulkanDevice& device);
        VulkanShaderProgramBuilder(const VulkanShaderProgramBuilder&) = delete;
        VulkanShaderProgramBuilder(VulkanShaderProgramBuilder&&) = delete;
        virtual ~VulkanShaderProgramBuilder() noexcept;
 
        // Builder interface.
    protected:
        virtual void build() override;
 
        // ShaderProgramBuilder interface.
    public:
        virtual VulkanShaderProgramBuilder& withShaderModule(const ShaderStage& type, const String& fileName, const String& entryPoint = "main") override;
 
        virtual VulkanShaderProgramBuilder& withShaderModule(const ShaderStage& type, std::istream& stream, const String& name, const String& entryPoint = "main") override;
 
        virtual VulkanShaderProgramBuilder& withVertexShaderModule(const String& fileName, const String& entryPoint = "main") override;
 
        virtual VulkanShaderProgramBuilder& withVertexShaderModule(std::istream& stream, const String& name, const String& entryPoint = "main") override;
 
        virtual VulkanShaderProgramBuilder& withTessellationControlShaderModule(const String& fileName, const String& entryPoint = "main") override;
 
        virtual VulkanShaderProgramBuilder& withTessellationControlShaderModule(std::istream& stream, const String& name, const String& entryPoint = "main") override;
 
        virtual VulkanShaderProgramBuilder& withTessellationEvaluationShaderModule(const String& fileName, const String& entryPoint = "main") override;
 
        virtual VulkanShaderProgramBuilder& withTessellationEvaluationShaderModule(std::istream& stream, const String& name, const String& entryPoint = "main") override;
 
        virtual VulkanShaderProgramBuilder& withGeometryShaderModule(const String& fileName, const String& entryPoint = "main") override;
 
        virtual VulkanShaderProgramBuilder& withGeometryShaderModule(std::istream& stream, const String& name, const String& entryPoint = "main") override;
 
        virtual VulkanShaderProgramBuilder& withFragmentShaderModule(const String& fileName, const String& entryPoint = "main") override;
 
        virtual VulkanShaderProgramBuilder& withFragmentShaderModule(std::istream& stream, const String& name, const String& entryPoint = "main") override;
 
        virtual VulkanShaderProgramBuilder& withComputeShaderModule(const String& fileName, const String& entryPoint = "main") override;
 
        virtual VulkanShaderProgramBuilder& withComputeShaderModule(std::istream& stream, const String& name, const String& entryPoint = "main") override;
    };
 
    class LITEFX_VULKAN_API VulkanRasterizerBuilder : public RasterizerBuilder<VulkanRasterizerBuilder, VulkanRasterizer> {
        LITEFX_IMPLEMENTATION(VulkanRasterizerBuilderImpl);
 
    public:
        explicit VulkanRasterizerBuilder() noexcept;
        VulkanRasterizerBuilder(const VulkanRasterizerBuilder&) noexcept = delete;
        VulkanRasterizerBuilder(VulkanRasterizerBuilder&&) noexcept = delete;
        virtual ~VulkanRasterizerBuilder() noexcept;
 
        // Builder interface.
    public:
        virtual void build() override;
 
        // RasterizerBuilder interface.
    public:
        virtual VulkanRasterizerBuilder& polygonMode(const PolygonMode& mode = PolygonMode::Solid) noexcept override;
 
        virtual VulkanRasterizerBuilder& cullMode(const CullMode& cullMode = CullMode::BackFaces) noexcept override;
 
        virtual VulkanRasterizerBuilder& cullOrder(const CullOrder& cullOrder = CullOrder::CounterClockWise) noexcept override;
 
        virtual VulkanRasterizerBuilder& lineWidth(const Float& lineWidth = 1.f) noexcept override;
 
        virtual VulkanRasterizerBuilder& depthBias(const DepthStencilState::DepthBias& depthBias) noexcept override;
 
        virtual VulkanRasterizerBuilder& depthState(const DepthStencilState::DepthState& depthState) noexcept override;
 
        virtual VulkanRasterizerBuilder& stencilState(const DepthStencilState::StencilState& stencilState) noexcept override;
    };
 
    class LITEFX_VULKAN_API VulkanVertexBufferLayoutBuilder : public VertexBufferLayoutBuilder<VulkanVertexBufferLayoutBuilder, VulkanVertexBufferLayout, VulkanInputAssemblerBuilder> {
    public:
        using VertexBufferLayoutBuilder<VulkanVertexBufferLayoutBuilder, VulkanVertexBufferLayout, VulkanInputAssemblerBuilder>::VertexBufferLayoutBuilder;
 
    public:
        virtual VulkanVertexBufferLayoutBuilder& withAttribute(UniquePtr<BufferAttribute>&& attribute) override;
 
    public:
        virtual VulkanVertexBufferLayoutBuilder& withAttribute(const BufferFormat& format, const UInt32& offset, const AttributeSemantic& semantic = AttributeSemantic::Unknown, const UInt32& semanticIndex = 0);
 
        virtual VulkanVertexBufferLayoutBuilder& withAttribute(const UInt32& location, const BufferFormat& format, const UInt32& offset, const AttributeSemantic& semantic = AttributeSemantic::Unknown, const UInt32& semanticIndex = 0);
    };
 
    class LITEFX_VULKAN_API VulkanInputAssemblerBuilder : public InputAssemblerBuilder<VulkanInputAssemblerBuilder, VulkanInputAssembler> {
        LITEFX_IMPLEMENTATION(VulkanInputAssemblerBuilderImpl);
 
    public:
        explicit VulkanInputAssemblerBuilder() noexcept;
        VulkanInputAssemblerBuilder(const VulkanInputAssemblerBuilder&) noexcept = delete;
        VulkanInputAssemblerBuilder(VulkanInputAssemblerBuilder&&) noexcept = delete;
        virtual ~VulkanInputAssemblerBuilder() noexcept;
 
        // Builder interface.
    public:
        virtual void build() override;
 
        // InputAssemblerBuilder interface.
    public:
        virtual VulkanInputAssemblerBuilder& topology(const PrimitiveTopology& topology) override;
 
        virtual void use(UniquePtr<VulkanVertexBufferLayout>&& layout) override;
 
        virtual void use(UniquePtr<VulkanIndexBufferLayout>&& layout) override;
 
        // VulkanInputAssemblerBuilder interface.
    public:
        virtual VulkanVertexBufferLayoutBuilder vertexBuffer(const size_t& elementSize, const UInt32& binding = 0);
 
        virtual VulkanInputAssemblerBuilder& indexType(const IndexType& type);
    };
 
    class LITEFX_VULKAN_API VulkanDescriptorSetLayoutBuilder : public DescriptorSetLayoutBuilder<VulkanDescriptorSetLayoutBuilder, VulkanDescriptorSetLayout, VulkanPipelineLayoutBuilder> {
        LITEFX_IMPLEMENTATION(VulkanDescriptorSetLayoutBuilderImpl);
 
    public:
        explicit VulkanDescriptorSetLayoutBuilder(VulkanPipelineLayoutBuilder& parent, const UInt32& space = 0, const ShaderStage& stages = ShaderStage::Compute | ShaderStage::Fragment | ShaderStage::Geometry | ShaderStage::TessellationControl | ShaderStage::TessellationEvaluation | ShaderStage::Vertex, const UInt32& poolSize = 1024, const UInt32& maxUnboundedArraySize = 104857);
        VulkanDescriptorSetLayoutBuilder(const VulkanDescriptorSetLayoutBuilder&) = delete;
        VulkanDescriptorSetLayoutBuilder(VulkanDescriptorSetLayoutBuilder&&) = delete;
        virtual ~VulkanDescriptorSetLayoutBuilder() noexcept;
 
        // Builder interface.
    public:
        virtual void build() override;
 
        // DescriptorSetLayoutBuilder interface.
    public:
        virtual VulkanDescriptorSetLayoutBuilder& withDescriptor(UniquePtr<VulkanDescriptorLayout>&& layout) override;
        
        virtual VulkanDescriptorSetLayoutBuilder& withDescriptor(const DescriptorType& type, const UInt32& binding, const UInt32& descriptorSize, const UInt32& descriptors = 1) override;
 
        virtual VulkanDescriptorSetLayoutBuilder& withStaticSampler(const UInt32& binding, const FilterMode& magFilter = FilterMode::Nearest, const FilterMode& minFilter = FilterMode::Nearest, const BorderMode& borderU = BorderMode::Repeat, const BorderMode& borderV = BorderMode::Repeat, const BorderMode& borderW = BorderMode::Repeat, const MipMapMode& mipMapMode = MipMapMode::Nearest, const Float& mipMapBias = 0.f, const Float& minLod = 0.f, const Float& maxLod = std::numeric_limits<Float>::max(), const Float& anisotropy = 0.f) override;
 
        // VulkanDescriptorSetLayoutBuilder.
    public:
        virtual VulkanDescriptorSetLayoutBuilder& space(const UInt32& space) noexcept;
 
        virtual VulkanDescriptorSetLayoutBuilder& shaderStages(const ShaderStage& stages) noexcept;
 
        virtual VulkanDescriptorSetLayoutBuilder& poolSize(const UInt32& poolSize) noexcept;
    };
 
    class LITEFX_VULKAN_API VulkanPushConstantsLayoutBuilder : public PushConstantsLayoutBuilder<VulkanPushConstantsLayoutBuilder, VulkanPushConstantsLayout, VulkanPipelineLayoutBuilder> {
        LITEFX_IMPLEMENTATION(VulkanPushConstantsLayoutBuilderImpl);
 
    public:
        explicit VulkanPushConstantsLayoutBuilder(VulkanPipelineLayoutBuilder& parent, const UInt32& size);
        VulkanPushConstantsLayoutBuilder(const VulkanPushConstantsLayoutBuilder&) = delete;
        VulkanPushConstantsLayoutBuilder(VulkanPushConstantsLayoutBuilder&&) = delete;
        virtual ~VulkanPushConstantsLayoutBuilder() noexcept;
 
        // IBuilder interface.
    public:
        virtual void build() override;
 
        // PushConstantsLayoutBuilder interface.
    public:
        virtual VulkanPushConstantsLayoutBuilder& withRange(const ShaderStage& shaderStages, const UInt32& offset, const UInt32& size, const UInt32& space, const UInt32& binding) override;
    };
 
    class LITEFX_VULKAN_API VulkanPipelineLayoutBuilder : public PipelineLayoutBuilder<VulkanPipelineLayoutBuilder, VulkanPipelineLayout> {
        LITEFX_IMPLEMENTATION(VulkanPipelineLayoutBuilderImpl);
        friend class VulkanDescriptorSetLayoutBuilder;
 
    public:
        explicit VulkanPipelineLayoutBuilder(const VulkanDevice& device);
        VulkanPipelineLayoutBuilder(VulkanPipelineLayoutBuilder&&) = delete;
        VulkanPipelineLayoutBuilder(const VulkanPipelineLayoutBuilder&) = delete;
        virtual ~VulkanPipelineLayoutBuilder() noexcept;
 
        // Builder interface.
    public:
        virtual void build() override;
 
        // PipelineLayoutBuilder interface.
    public:
        virtual void use(UniquePtr<VulkanDescriptorSetLayout>&& layout) override;
 
        virtual void use(UniquePtr<VulkanPushConstantsLayout>&& layout) override;
 
        // VulkanPipelineLayoutBuilder.
    public:
        virtual VulkanDescriptorSetLayoutBuilder descriptorSet(const UInt32& space = 0, const ShaderStage& stages = ShaderStage::Fragment | ShaderStage::Geometry | ShaderStage::TessellationControl | ShaderStage::TessellationEvaluation | ShaderStage::Vertex, const UInt32& poolSize = 1024);
 
        virtual VulkanPushConstantsLayoutBuilder pushConstants(const UInt32& size);
 
    private:
        virtual const VulkanDevice& device() const noexcept;
    };
 
    class LITEFX_VULKAN_API VulkanRenderPipelineBuilder : public RenderPipelineBuilder<VulkanRenderPipelineBuilder, VulkanRenderPipeline> {
        LITEFX_IMPLEMENTATION(VulkanRenderPipelineBuilderImpl);
 
    public:
        explicit VulkanRenderPipelineBuilder(const VulkanRenderPass& renderPass, const String& name = "");
        VulkanRenderPipelineBuilder(VulkanRenderPipelineBuilder&&) = delete;
        VulkanRenderPipelineBuilder(const VulkanRenderPipelineBuilder&) = delete;
        virtual ~VulkanRenderPipelineBuilder() noexcept;
 
        // Builder interface.
    public:
        virtual void build() override;
 
        // RenderPipelineBuilder interface.
    public:
        virtual VulkanRenderPipelineBuilder& shaderProgram(SharedPtr<VulkanShaderProgram> shaderProgram) override;
 
        virtual VulkanRenderPipelineBuilder& layout(SharedPtr<VulkanPipelineLayout> layout) override;
 
        virtual VulkanRenderPipelineBuilder& rasterizer(SharedPtr<VulkanRasterizer> rasterizer) override;
 
        virtual VulkanRenderPipelineBuilder& inputAssembler(SharedPtr<VulkanInputAssembler> inputAssembler) override;
 
        virtual VulkanRenderPipelineBuilder& viewport(SharedPtr<IViewport> viewport) override;
 
        virtual VulkanRenderPipelineBuilder& scissor(SharedPtr<IScissor> scissor) override;
 
        virtual VulkanRenderPipelineBuilder& enableAlphaToCoverage(const bool& enable = true) override;
    };
 
    class LITEFX_VULKAN_API VulkanComputePipelineBuilder : public ComputePipelineBuilder<VulkanComputePipelineBuilder, VulkanComputePipeline> {
        LITEFX_IMPLEMENTATION(VulkanComputePipelineBuilderImpl);
 
    public:
        explicit VulkanComputePipelineBuilder(const VulkanDevice& device, const String& name = "");
        VulkanComputePipelineBuilder(VulkanComputePipelineBuilder&&) = delete;
        VulkanComputePipelineBuilder(const VulkanComputePipelineBuilder&) = delete;
        virtual ~VulkanComputePipelineBuilder() noexcept;
 
        // Builder interface.
    public:
        virtual void build() override;
 
        // ComputePipelineBuilder interface.
    public:
        virtual VulkanComputePipelineBuilder& shaderProgram(SharedPtr<VulkanShaderProgram> program) override;
 
        virtual VulkanComputePipelineBuilder& layout(SharedPtr<VulkanPipelineLayout> layout) override;
    };
 
    class LITEFX_VULKAN_API VulkanRenderPassBuilder : public RenderPassBuilder<VulkanRenderPassBuilder, VulkanRenderPass> {
        LITEFX_IMPLEMENTATION(VulkanRenderPassBuilderImpl)
 
    public:
        explicit VulkanRenderPassBuilder(const VulkanDevice& device, const String& name = "") noexcept;
 
        explicit VulkanRenderPassBuilder(const VulkanDevice& device, const MultiSamplingLevel& samples = MultiSamplingLevel::x1, const String& name = "") noexcept;
 
        explicit VulkanRenderPassBuilder(const VulkanDevice& device, const UInt32& commandBuffers, const String& name = "") noexcept;
 
        explicit VulkanRenderPassBuilder(const VulkanDevice& device, const UInt32& commandBuffers, const MultiSamplingLevel& multiSamplingLevel, const String& name = "") noexcept;
        VulkanRenderPassBuilder(const VulkanRenderPassBuilder&) noexcept = delete;
        VulkanRenderPassBuilder(VulkanRenderPassBuilder&&) noexcept = delete;
        virtual ~VulkanRenderPassBuilder() noexcept;
 
        // Builder interface.
    public:
        virtual void build() override;
 
        // RenderPassBuilder interface.
    public:
        virtual VulkanRenderPassBuilder& commandBuffers(const UInt32& count) override;
 
        virtual VulkanRenderPassBuilder& multiSamplingLevel(const MultiSamplingLevel& samples) override;
 
        virtual VulkanRenderPassBuilder& renderTarget(const RenderTargetType& type, const Format& format, const Vector4f& clearValues = { 0.0f, 0.0f, 0.0f, 0.0f }, bool clearColor = true, bool clearStencil = true, bool isVolatile = false) override;
 
        virtual VulkanRenderPassBuilder& renderTarget(const String& name, const RenderTargetType& type, const Format& format, const Vector4f& clearValues = { 0.0f, 0.0f, 0.0f, 0.0f }, bool clearColor = true, bool clearStencil = true, bool isVolatile = false) override;
 
        virtual VulkanRenderPassBuilder& renderTarget(const UInt32& location, const RenderTargetType& type, const Format& format, const Vector4f& clearValues = { 0.0f, 0.0f, 0.0f, 0.0f }, bool clearColor = true, bool clearStencil = true, bool isVolatile = false) override;
 
        virtual VulkanRenderPassBuilder& renderTarget(const String& name, const UInt32& location, const RenderTargetType& type, const Format& format, const Vector4f& clearValues = { 0.0f, 0.0f, 0.0f, 0.0f }, bool clearColor = true, bool clearStencil = true, bool isVolatile = false) override;
 
        virtual VulkanRenderPassBuilder& renderTarget(VulkanInputAttachmentMapping& output, const RenderTargetType& type, const Format& format, const Vector4f& clearValues = { 0.0f, 0.0f, 0.0f, 0.0f }, bool clearColor = true, bool clearStencil = true, bool isVolatile = false) override;
 
        virtual VulkanRenderPassBuilder& renderTarget(const String& name, VulkanInputAttachmentMapping& output, const RenderTargetType& type, const Format& format, const Vector4f& clearValues = { 0.0f, 0.0f, 0.0f, 0.0f }, bool clearColor = true, bool clearStencil = true, bool isVolatile = false) override;
 
        virtual VulkanRenderPassBuilder& renderTarget(VulkanInputAttachmentMapping& output, const UInt32& location, const RenderTargetType& type, const Format& format, const Vector4f& clearValues = { 0.0f, 0.0f, 0.0f, 0.0f }, bool clearColor = true, bool clearStencil = true, bool isVolatile = false) override;
 
        virtual VulkanRenderPassBuilder& renderTarget(const String& name, VulkanInputAttachmentMapping& output, const UInt32& location, const RenderTargetType& type, const Format& format, const Vector4f& clearValues = { 0.0f, 0.0f, 0.0f, 0.0f }, bool clearColor = true, bool clearStencil = true, bool isVolatile = false) override;
 
        virtual VulkanRenderPassBuilder& inputAttachment(const VulkanInputAttachmentMapping& inputAttachment) override;
 
        virtual VulkanRenderPassBuilder& inputAttachment(const UInt32& inputLocation, const VulkanRenderPass& renderPass, const UInt32& outputLocation) override;
 
        virtual VulkanRenderPassBuilder& inputAttachment(const UInt32& inputLocation, const VulkanRenderPass& renderPass, const RenderTarget& renderTarget) override;
    };
}
#endif // defined(BUILD_DEFINE_BUILDERS)