DepthStencilState.h

#pragma once
 
#include "spark/render/Export.h"
 
#include <memory>
 
namespace spark::render
{
    enum class CompareOperation
    {
        Never = 0x00000000,
 
        Less = 0x00000001,
 
        Greater = 0x0000002,
 
        Equal = 0x00000003,
 
        LessEqual = 0x00000004,
 
        GreaterEqual = 0x00000005,
 
        NotEqual = 0x00000006,
 
        Always = 0x00000007
    };
 
    enum class StencilOperation
    {
        Keep = 0x00000000,
 
        Zero = 0x00000001,
 
        Replace = 0x00000002,
 
        IncrementClamp = 0x00000003,
 
        DecrementClamp = 0x00000004,
 
        Invert = 0x00000005,
 
        IncrementWrap = 0x00000006,
 
        DecrementWrap = 0x00000007
    };
 
    class SPARK_RENDER_EXPORT DepthStencilState final
    {
    public:
        struct DepthState
        {
        public:
            bool enable = true;
 
            bool write = true;
 
            CompareOperation operation = CompareOperation::Always;
        };
 
        struct DepthBias
        {
        public:
            bool enable = false;
 
            float clamp = 0.f;
 
            float slopeFactor = 0.f;
 
            float constantFactor = 0.f;
        };
 
        struct StencilTest
        {
        public:
            StencilOperation stencilFailOp = StencilOperation::Keep;
 
            StencilOperation stencilPassOp = StencilOperation::Replace;
 
            StencilOperation depthFailOp = StencilOperation::Keep;
 
            CompareOperation operation = CompareOperation::Never;
        };
 
        struct StencilState
        {
        public:
            bool enable = false;
 
            unsigned char writeMask = 0xFF;
 
            unsigned char readMask = 0xFF;
 
            StencilTest frontFace = {};
 
            StencilTest backFace = {};
        };
 
    public:
        explicit DepthStencilState() noexcept;
 
        explicit DepthStencilState(const DepthState& depth_state, const DepthBias& depth_bias, const StencilState& stencil_state) noexcept;
        ~DepthStencilState() noexcept;
 
        DepthStencilState(const DepthStencilState& other);
        DepthStencilState(DepthStencilState&& other) noexcept;
        DepthStencilState& operator=(const DepthStencilState& other);
        DepthStencilState& operator=(DepthStencilState&& other) noexcept;
 
        [[nodiscard]] DepthState& depthState() const noexcept;
 
        [[nodiscard]] DepthBias& depthBias() const noexcept;
 
        [[nodiscard]] StencilState& stencilState() const noexcept;
 
    private:
        struct Impl;
        std::unique_ptr<Impl> m_impl;
    };
}