blend_mode.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  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.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Harry Storbacka
*/


#pragma once

#include "../api_display.h"
#include "../../Core/System/sharedptr.h"

class CL_Colorf;
class CL_BlendMode_Impl;

enum CL_BlendFunc
{
        cl_blend_zero,

        cl_blend_one,

        cl_blend_dest_color,

        cl_blend_src_color,

        cl_blend_one_minus_dest_color,

        cl_blend_one_minus_src_color,

        cl_blend_src_alpha,

        cl_blend_one_minus_src_alpha,

        cl_blend_dest_alpha,

        cl_blend_one_minus_dest_alpha,

        cl_blend_src_alpha_saturate,

        cl_blend_constant_color,

        cl_blend_one_minus_constant_color,

        cl_blend_constant_alpha,

        cl_blend_one_minus_constant_alpha
};

enum CL_BlendEquation
{
        cl_blend_equation_add,
        cl_blend_equation_subtract,
        cl_blend_equation_reverse_subtract,
        cl_blend_equation_min,
        cl_blend_equation_max,
        cl_blend_equation_logic_op
};

class CL_API_DISPLAY CL_BlendMode
{

public:
        CL_BlendMode();

        ~CL_BlendMode();


public:
        const CL_Colorf &get_blend_color() const;

        CL_BlendEquation get_blend_equation() const;

        CL_BlendEquation get_blend_equation_alpha() const;

        CL_BlendFunc get_blend_function_src() const;

        CL_BlendFunc get_blend_function_dest() const;

        CL_BlendFunc get_blend_function_src_alpha() const;

        CL_BlendFunc get_blend_function_dest_alpha() const;

        bool is_blend_enabled() const;


public:
        bool operator ==(const CL_BlendMode &other) const;

        void enable_blending(bool value);

        void set_blend_color(const CL_Colorf &color);

        void set_blend_equation(CL_BlendEquation color, CL_BlendEquation alpha);

        void set_blend_function(CL_BlendFunc src, CL_BlendFunc dest, CL_BlendFunc src_alpha, CL_BlendFunc dest_alpha);


private:
        CL_SharedPtr<CL_BlendMode_Impl> impl;
};

---