GteDepthStencilState.h

Go to the documentation of this file.

// David Eberly, Geometric Tools, Redmond WA 98052
// Copyright (c) 1998-2017
// Distributed under the Boost Software License, Version 1.0.
// http://www.boost.org/LICENSE_1_0.txt
// http://www.geometrictools.com/License/Boost/LICENSE_1_0.txt
// File Version: 3.0.1 (2016/10/02)

#pragma once

#include <Graphics/GteDrawingState.h>

namespace gte
{

class GTE_IMPEXP DepthStencilState : public DrawingState
{
public:
    enum GTE_IMPEXP WriteMask
    {
        MASK_ZERO,
        MASK_ALL
    };

    enum GTE_IMPEXP Comparison
    {
        NEVER,
        LESS,
        EQUAL,
        LESS_EQUAL,
        GREATER,
        NOT_EQUAL,
        GREATER_EQUAL,
        ALWAYS
    };

    enum GTE_IMPEXP Operation
    {
        OP_KEEP,
        OP_ZERO,
        OP_REPLACE,
        OP_INCR_SAT,
        OP_DECR_SAT,
        OP_INVERT,
        OP_INCR,
        OP_DECR
    };

    struct GTE_IMPEXP Face
    {
        Operation fail;
        Operation depthFail;
        Operation pass;
        Comparison comparison;
    };

    // Construction.
    DepthStencilState();

    // Member access.  The members are intended to be write-once before
    // you create an associated graphics state.
    bool depthEnable;                   // default: true
    WriteMask writeMask;                // default: MASK_ALL
    Comparison comparison;              // default: LESS_EQUAL
    bool stencilEnable;                 // default: false
    unsigned char stencilReadMask;      // default: 0xFF
    unsigned char stencilWriteMask;     // default: 0xFF
    Face frontFace;                     // default: (KEEP,KEEP,KEEP,ALWAYS)
    Face backFace;                      // default: (KEEP,KEEP,KEEP,ALWAYS)
    unsigned int reference;             // default: 0
};

}