BlendMode.hpp

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2014 Laurent Gomila (laurent.gom@gmail.com)
//
// 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.
//

#ifndef SFML_BLENDMODE_HPP
#define SFML_BLENDMODE_HPP

// Headers
#include <SFML/Graphics/Export.hpp>


namespace sf
{

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

    enum Equation
    {
        Add,     
        Subtract 
    };

    BlendMode();

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

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

    // Member Data
    Factor   colorSrcFactor; 
    Factor   colorDstFactor; 
    Equation colorEquation;  
    Factor   alphaSrcFactor; 
    Factor   alphaDstFactor; 
    Equation alphaEquation;  
};

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

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

// Commonly used blending modes
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 BlendNone;     

} // namespace sf


#endif // SFML_BLENDMODE_HPP