Formatting API
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / visuals / color-visual-properties-devel.h
1 #ifndef DALI_TOOLKIT_COLOR_VISUAL_PROPERTIES_DEVEL_H
2 #define DALI_TOOLKIT_COLOR_VISUAL_PROPERTIES_DEVEL_H
3
4 /*
5  * Copyright (c) 2020 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-toolkit/public-api/visuals/color-visual-properties.h>
23
24 namespace Dali
25 {
26 namespace Toolkit
27 {
28 namespace DevelColorVisual
29 {
30 /**
31  * @brief Additional ColorVisual Properties.
32  */
33 namespace Property
34 {
35 /**
36  * @brief Enumeration for the instance of additional properties belonging to the ColorVisual.
37  */
38 enum
39 {
40   MIX_COLOR = Toolkit::ColorVisual::Property::MIX_COLOR,
41
42   /**
43    * @brief Whether to render if the MIX_COLOR is transparent.
44    * @details Name "renderIfTransparent", type Property::BOOLEAN.
45    * @note Optional.
46    * @note By default it's false, i.e. ColorVisual will not render if the MIX_COLOR is transparent.
47    */
48   RENDER_IF_TRANSPARENT = MIX_COLOR + 1,
49
50   /**
51    * @brief The blur radius of the visual.
52    * @details Name "blurRadius", type Property::FLOAT.
53    *          If the value is 0, the edge is sharp. Otherwise, the larger the value, the more the edge is blurred.
54    * @note Optional.
55    * @note The default is 0.
56    * @note The visual size increases by the blur radius.
57    */
58   BLUR_RADIUS = MIX_COLOR + 2,
59 };
60
61 } // namespace Property
62
63 } // namespace DevelColorVisual
64
65 /**
66  * @}
67  */
68
69 } // namespace Toolkit
70
71 } // namespace Dali
72
73 #endif // DALI_TOOLKIT_COLOR_VISUAL_PROPERTIES_DEVEL_H