ShaderConfiguration.hpp

Go to the documentation of this file.

#ifndef DONUT_GRAPHICS_SHADER_CONFIGURATION_HPP
#define DONUT_GRAPHICS_SHADER_CONFIGURATION_HPP
 
#include <compare> // std::strong_ordering
#include <cstdint> // std::int32_t, std::uint8_t, std::uint32_t
 
namespace donut::graphics {
 
enum class DepthBufferMode : std::uint8_t {
    IGNORE,
 
    USE_DEPTH_TEST,
};
 
enum class DepthTestPredicate : std::uint32_t {
    NEVER_PASS = 0x0200,
 
    LESS = 0x0201,
 
    LESS_OR_EQUAL = 0x0203,
 
    GREATER = 0x0204,
 
    GREATER_OR_EQUAL = 0x0206,
 
    EQUAL = 0x0202,
 
    NOT_EQUAL = 0x0205,
 
    ALWAYS_PASS = 0x0207,
};
 
enum class StencilBufferMode : std::uint8_t {
    IGNORE,
 
    USE_STENCIL_TEST,
};
 
enum class StencilTestPredicate : std::uint32_t {
    NEVER_PASS = 0x0200,
 
    LESS = 0x0201,
 
    LESS_OR_EQUAL = 0x0203,
 
    GREATER = 0x0204,
 
    GREATER_OR_EQUAL = 0x0206,
 
    EQUAL = 0x0202,
 
    NOT_EQUAL = 0x0205,
 
    ALWAYS_PASS = 0x0207,
};
 
enum class StencilBufferOperation : std::uint32_t {
    KEEP = 0x1E00,
 
    SET_TO_ZERO = 0,
 
    REPLACE = 0x1E01,
 
    INCREMENT_CLAMP = 0x1E02,
 
    INCREMENT_WRAP = 0x8507,
 
    DECREMENT_CLAMP = 0x1E03,
 
    DECREMENT_WRAP = 0x8508,
 
    BITWISE_INVERT = 0x150A,
};
 
enum class FaceCullingMode : std::uint8_t {
    IGNORE,
 
    CULL_BACK_FACES,
 
    CULL_FRONT_FACES,
 
    CULL_FRONT_AND_BACK_FACES,
};
 
enum class FrontFace : std::uint32_t {
    CLOCKWISE = 0x0900,
 
    COUNTERCLOCKWISE = 0x0901,
};
 
enum class AlphaMode : std::uint8_t {
    IGNORE,
 
    USE_ALPHA_BLENDING,
};
 
struct ShaderConfiguration {
    DepthBufferMode depthBufferMode = DepthBufferMode::USE_DEPTH_TEST;
 
    DepthTestPredicate depthTestPredicate = DepthTestPredicate::LESS;
 
    StencilBufferMode stencilBufferMode = StencilBufferMode::IGNORE;
 
    StencilTestPredicate stencilTestPredicate = StencilTestPredicate::ALWAYS_PASS;
 
    std::int32_t stencilTestReferenceValue = 0;
 
    std::uint32_t stencilTestMask = 0xFFFFFFFF;
 
    StencilBufferOperation stencilBufferOperationOnStencilTestFail = StencilBufferOperation::KEEP;
 
    StencilBufferOperation stencilBufferOperationOnDepthTestFail = StencilBufferOperation::KEEP;
 
    StencilBufferOperation stencilBufferOperationOnPass = StencilBufferOperation::KEEP;
 
    FaceCullingMode faceCullingMode = FaceCullingMode::CULL_BACK_FACES;
 
    FrontFace frontFace = FrontFace::COUNTERCLOCKWISE;
 
    AlphaMode alphaMode = AlphaMode::IGNORE;
 
    [[nodiscard]] constexpr bool operator==(const ShaderConfiguration& other) const = default;
 
    [[nodiscard]] constexpr std::strong_ordering operator<=>(const ShaderConfiguration& other) const = default;
};
 
} // namespace donut::graphics
 
#endif