BlendMode.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2024 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
{

struct SFML_GRAPHICS_API BlendMode
{
    enum class Factor
    {
        Zero,             
        One,              
        SrcColor,         
        OneMinusSrcColor, 
        DstColor,         
        OneMinusDstColor, 
        SrcAlpha,         
        OneMinusSrcAlpha, 
        DstAlpha,         
        OneMinusDstAlpha  
    };

    enum class Equation
    {
        Add,             
        Subtract,        
        ReverseSubtract, 
        Min,             
        Max              
    };

    BlendMode() = default;

    BlendMode(Factor sourceFactor, Factor destinationFactor, Equation blendEquation = Equation::Add);

    BlendMode(Factor   colorSourceFactor,
              Factor   colorDestinationFactor,
              Equation colorBlendEquation,
              Factor   alphaSourceFactor,
              Factor   alphaDestinationFactor,
              Equation alphaBlendEquation);

    // Member Data
    Factor colorSrcFactor{BlendMode::Factor::SrcAlpha};         
    Factor colorDstFactor{BlendMode::Factor::OneMinusSrcAlpha}; 
    Equation colorEquation{BlendMode::Equation::Add};           
    Factor   alphaSrcFactor{BlendMode::Factor::One};            
    Factor   alphaDstFactor{BlendMode::Factor::OneMinusSrcAlpha}; 
    Equation alphaEquation{BlendMode::Equation::Add};             
};

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

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

// Commonly used blending modes
// NOLINTBEGIN(readability-identifier-naming)
SFML_GRAPHICS_API extern const BlendMode BlendAlpha;    
SFML_GRAPHICS_API extern const BlendMode BlendAdd;      
SFML_GRAPHICS_API extern const BlendMode BlendMultiply; 
SFML_GRAPHICS_API extern const BlendMode BlendMin;      
SFML_GRAPHICS_API extern const BlendMode BlendMax;      
SFML_GRAPHICS_API extern const BlendMode BlendNone;     
// NOLINTEND(readability-identifier-naming)
 
} // namespace sf