.. index:: pair: class; EE::Graphics::BlendMode
.. _doxid-class_e_e_1_1_graphics_1_1_blend_mode:

class EE::Graphics::BlendMode
=============================

.. toctree::
	:hidden:

	enum_EE_Graphics_BlendMode_Equation.rst
	enum_EE_Graphics_BlendMode_Factor.rst

Overview
~~~~~~~~




.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <blendmode.hpp>
	
	class BlendMode {
	public:
		// enums
	
		enum :ref:`Equation<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a81dd3c1887a16cf80b2d61220b2072d2>`;
		enum :ref:`Factor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a2662b459f710b5a34af1d412658ad383>`;

		// fields
	
		:ref:`Factor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a2662b459f710b5a34af1d412658ad383>` :target:`colorSrcFactor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a677bc45e4a1beeff652afad999d7bf09>`;
		:ref:`Factor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a2662b459f710b5a34af1d412658ad383>` :ref:`colorDstFactor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1ae8473991d2396fa7f5e889c89e8e9ada>`;
		:ref:`Equation<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a81dd3c1887a16cf80b2d61220b2072d2>` :ref:`colorEquation<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1aa00c09d30b6e2c074db84bdb1fb3bad2>`;
		:ref:`Factor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a2662b459f710b5a34af1d412658ad383>` :ref:`alphaSrcFactor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1add97a267fed1d743b406b3e4ddcbca5c>`;
		:ref:`Factor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a2662b459f710b5a34af1d412658ad383>` :ref:`alphaDstFactor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a9f684828a9a42c80aab43c8c49dd721a>`;
		:ref:`Equation<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a81dd3c1887a16cf80b2d61220b2072d2>` :ref:`alphaEquation<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a28273357e1554d4f4d941d750900ef54>`;

		// construction
	
		:target:`BlendMode<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a592c9ae46b44cda796fb6924489366d0>`();
		:target:`BlendMode<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a16b4e91f2416219eaa4ca20f88feee03>`(:ref:`Factor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a2662b459f710b5a34af1d412658ad383>` sourceFactor, :ref:`Factor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a2662b459f710b5a34af1d412658ad383>` destinationFactor, :ref:`Equation<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a81dd3c1887a16cf80b2d61220b2072d2>` blendEquation = :ref:`BlendMode::Equation::Add<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a81dd3c1887a16cf80b2d61220b2072d2aec211f7c20af43e742bf2570c3cb84f9>`);
		:target:`BlendMode<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a8bbed94ea207718ff348fc4a2ec3953b>`(:ref:`Factor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a2662b459f710b5a34af1d412658ad383>` colorSourceFactor, :ref:`Factor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a2662b459f710b5a34af1d412658ad383>` colorDestinationFactor, :ref:`Equation<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a81dd3c1887a16cf80b2d61220b2072d2>` colorBlendEquation, :ref:`Factor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a2662b459f710b5a34af1d412658ad383>` alphaSourceFactor, :ref:`Factor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a2662b459f710b5a34af1d412658ad383>` alphaDestinationFactor, :ref:`Equation<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a81dd3c1887a16cf80b2d61220b2072d2>` alphaBlendEquation);

		// methods
	
		static BlendMode :target:`Alpha<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a4d7b3de926b178d2ac3e2e081bf71d86>`();
		static BlendMode :ref:`Add<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a4b6b944ec832cd095fb6b00f52928b85>`();
		static BlendMode :ref:`Multiply<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1aa614eae278f036ce5fc3db770cc8cf6c>`();
		static BlendMode :ref:`None<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1ad6825e1627b8d325cd7b4987ea3ce66a>`();
		static std::string :ref:`equationToString<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1aa78ed46077426b8a5fc2a782499d3dd0>`(const :ref:`Equation<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a81dd3c1887a16cf80b2d61220b2072d2>`& eq);
		static std::string :target:`factorToString<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a8d3838ba252f353aa1953e22cc70c9e2>`(const :ref:`Factor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a2662b459f710b5a34af1d412658ad383>`& fc);
		static void :ref:`setMode<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a3eb398cb796400fbe08e4b98ef82f28d>`(const BlendMode& mode, bool force = false);
		static BlendMode :ref:`getPreBlendFunc<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a4d8acd2024aa1ebc3fa90ab3f2a0dc33>`();
		std::string :ref:`toString<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1ad7c78ad97cd46c092aeafc0da804e1d6>`() const;
	};
.. _details-class_e_e_1_1_graphics_1_1_blend_mode:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~



Fields
------

.. index:: pair: variable; colorDstFactor
.. _doxid-class_e_e_1_1_graphics_1_1_blend_mode_1ae8473991d2396fa7f5e889c89e8e9ada:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`Factor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a2662b459f710b5a34af1d412658ad383>` colorDstFactor

Source blending factor for the color channels.

.. index:: pair: variable; colorEquation
.. _doxid-class_e_e_1_1_graphics_1_1_blend_mode_1aa00c09d30b6e2c074db84bdb1fb3bad2:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`Equation<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a81dd3c1887a16cf80b2d61220b2072d2>` colorEquation

Destination blending factor for the color channels.

.. index:: pair: variable; alphaSrcFactor
.. _doxid-class_e_e_1_1_graphics_1_1_blend_mode_1add97a267fed1d743b406b3e4ddcbca5c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`Factor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a2662b459f710b5a34af1d412658ad383>` alphaSrcFactor

Blending equation for the color channels.

.. index:: pair: variable; alphaDstFactor
.. _doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a9f684828a9a42c80aab43c8c49dd721a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`Factor<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a2662b459f710b5a34af1d412658ad383>` alphaDstFactor

Source blending factor for the alpha channel.

.. index:: pair: variable; alphaEquation
.. _doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a28273357e1554d4f4d941d750900ef54:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`Equation<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a81dd3c1887a16cf80b2d61220b2072d2>` alphaEquation

Destination blending factor for the alpha channel.

Methods
-------

.. index:: pair: function; Add
.. _doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a4b6b944ec832cd095fb6b00f52928b85:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static BlendMode Add()

Blend source and dest according to dest alpha.

.. index:: pair: function; Multiply
.. _doxid-class_e_e_1_1_graphics_1_1_blend_mode_1aa614eae278f036ce5fc3db770cc8cf6c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static BlendMode Multiply()

Add source to dest.

.. index:: pair: function; None
.. _doxid-class_e_e_1_1_graphics_1_1_blend_mode_1ad6825e1627b8d325cd7b4987ea3ce66a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static BlendMode None()

Multiply source and dest.

.. index:: pair: function; equationToString
.. _doxid-class_e_e_1_1_graphics_1_1_blend_mode_1aa78ed46077426b8a5fc2a782499d3dd0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static std::string equationToString(const :ref:`Equation<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a81dd3c1887a16cf80b2d61220b2072d2>`& eq)

Overwrite dest with source.

.. index:: pair: function; setMode
.. _doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a3eb398cb796400fbe08e4b98ef82f28d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static void setMode(const BlendMode& mode, bool force = false)

Set a Predefined Blend Function



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- mode

		- The Blend Mode

	*
		- force

		- If force to apply the blend ( no matters if the last blend was the same blend )

.. index:: pair: function; getPreBlendFunc
.. _doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a4d8acd2024aa1ebc3fa90ab3f2a0dc33:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static BlendMode getPreBlendFunc()



.. rubric:: Returns:

The last used predefined blend func

.. index:: pair: function; toString
.. _doxid-class_e_e_1_1_graphics_1_1_blend_mode_1ad7c78ad97cd46c092aeafc0da804e1d6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	std::string toString() const

Blending equation for the alpha channel.