Apply the new doxygen tagging rule for @SINCE
[platform/core/uifw/dali-core.git] / dali / public-api / actors / blending.h
1 #ifndef __DALI_BLENDING_H__
2 #define __DALI_BLENDING_H__
3
4 /*
5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  */
20
21 // INTERNAL INCLUDES
22 #include <dali/public-api/common/dali-common.h>
23
24 namespace Dali
25 {
26 /**
27  * @addtogroup dali_core_actors
28  * @{
29  */
30
31 namespace BlendingMode
32 {
33 /**
34  * @brief Blending mode.
35  * @SINCE_1_0.0
36  */
37 enum Type
38 {
39   OFF,  ///< Blending is disabled. @SINCE_1_0.0
40   AUTO, ///< Blending is enabled if there is alpha channel. This is the default mode. @SINCE_1_0.0
41   ON    ///< Blending is enabled. @SINCE_1_0.0
42 };
43
44 } //namespace BlendingMode
45
46 namespace BlendingFactor
47 {
48 /**
49  * @brief Blending Factor.
50  *
51  * @SINCE_1_0.0
52  * @see Dali::RenderableActor::SetBlendFunc() and Dali::RenderableActor::GetBlendFunc()
53  */
54 enum Type
55 {
56   ZERO                     = 0,
57   ONE                      = 1,
58   SRC_COLOR                = 0x0300,
59   ONE_MINUS_SRC_COLOR      = 0x0301,
60   SRC_ALPHA                = 0x0302,
61   ONE_MINUS_SRC_ALPHA      = 0x0303,
62   DST_ALPHA                = 0x0304,
63   ONE_MINUS_DST_ALPHA      = 0x0305,
64   DST_COLOR                = 0x0306,
65   ONE_MINUS_DST_COLOR      = 0x0307,
66   SRC_ALPHA_SATURATE       = 0x0308,
67   CONSTANT_COLOR           = 0x8001,
68   ONE_MINUS_CONSTANT_COLOR = 0x8002,
69   CONSTANT_ALPHA           = 0x8003,
70   ONE_MINUS_CONSTANT_ALPHA = 0x8004
71 };
72
73 } // namespace BlendingFactor
74
75 namespace BlendingEquation
76 {
77 /**
78  * @brief Blending Equation.
79  *
80  * @SINCE_1_0.0
81  * @see Dali::RenderableActor::SetBlendEquation() and Dali::RenderableActor::GetBlendEquation()
82  */
83 enum Type
84 {
85   ADD              = 0x8006,
86   SUBTRACT         = 0x800A,
87   REVERSE_SUBTRACT = 0x800B
88 };
89
90 } // namespace BlendingEquation
91
92 DALI_IMPORT_API extern const BlendingFactor::Type   DEFAULT_BLENDING_SRC_FACTOR_RGB;    ///< BlendingFactor::SRC_ALPHA
93 DALI_IMPORT_API extern const BlendingFactor::Type   DEFAULT_BLENDING_DEST_FACTOR_RGB;   ///< BlendingFactor::ONE_MINUS_SRC_ALPHA
94 DALI_IMPORT_API extern const BlendingFactor::Type   DEFAULT_BLENDING_SRC_FACTOR_ALPHA;  ///< BlendingFactor::ONE
95 DALI_IMPORT_API extern const BlendingFactor::Type   DEFAULT_BLENDING_DEST_FACTOR_ALPHA; ///< BlendingFactor::ONE_MINUS_SRC_ALPHA
96
97 DALI_IMPORT_API extern const BlendingEquation::Type DEFAULT_BLENDING_EQUATION_RGB;     ///< BlendingEquation::ADD
98 DALI_IMPORT_API extern const BlendingEquation::Type DEFAULT_BLENDING_EQUATION_ALPHA;   ///< BlendingEquation::ADD
99
100 /**
101  * @}
102  */
103 } // namespace Dali
104
105 #endif // __DALI_BLENDING_H__