StencilMode.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2023 Laurent Gomila (laurent@sfml-dev.org)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#pragma once

// Headers
#include <SFML/Graphics/Export.hpp>
 
 
namespace sf
{

enum class StencilComparison
{
    Never,        
    Less,         
    LessEqual,    
    Greater,      
    GreaterEqual, 
    Equal,        
    NotEqual,     
    Always        
};

enum class StencilUpdateOperation
{
    Keep,      
    Zero,      
    Replace,   
    Increment, 
    Decrement, 
    Invert,    
};

struct SFML_GRAPHICS_API StencilValue
{
    StencilValue(int theValue);

    StencilValue(unsigned int theValue);

    template <typename T>
    StencilValue(T) = delete;
 
    unsigned int value{}; 
};

struct SFML_GRAPHICS_API StencilMode
{
    StencilComparison stencilComparison{StencilComparison::Always}; 
    StencilUpdateOperation stencilUpdateOperation{
        StencilUpdateOperation::Keep}; 
    StencilValue stencilReference{0};  
    StencilValue stencilMask{~0u}; 
    bool         stencilOnly{};    
};

[[nodiscard]] SFML_GRAPHICS_API bool operator==(const StencilMode& left, const StencilMode& right);

[[nodiscard]] SFML_GRAPHICS_API bool operator!=(const StencilMode& left, const StencilMode& right);
 
} // namespace sf