Split dali-toolkit into Base & Optional
[platform/core/uifw/dali-toolkit.git] / optional / dali-toolkit / public-api / shader-effects / bubble-effect / color-adjuster.h
1 #ifndef __DALI_TOOLKIT_SHADER_COLOR_ADJUSTER_H__
2 #define __DALI_TOOLKIT_SHADER_COLOR_ADJUSTER_H__
3
4 //
5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
6 //
7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
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 // INTERNAL INCLUDES
21 #include <dali/dali.h>
22
23 namespace Dali DALI_IMPORT_API
24 {
25
26 namespace Toolkit
27 {
28
29 /**
30  * ColorAdjuster is a custom shader effect to adjust the image color in HSV space.
31  */
32 class ColorAdjuster : public ShaderEffect
33 {
34 public:
35
36   /**
37    * Create an empty ColorAdjuster handle.
38    */
39   ColorAdjuster();
40
41   /**
42    * Virtual destructor.
43    */
44   virtual ~ColorAdjuster();
45
46   /**
47    * Create an initialized ColorAdjuster.
48    * @param[in] hsvDelta The color difference to apply to the HSV channel.
49    * @param[in] ignoreAlpha If true, the result color will be opaque even though source has alpha value
50    * @return A handle to a newly allocated Dali resource.
51    */
52   static ColorAdjuster New( const Vector3& hsvDelta, bool ignoreAlpha = false );
53
54    /**
55    * Get the name of the uHSVDelta uniform so that it can be animated
56    */
57   std::string GetHsvDeltaPropertyName() const;
58
59 private: // Not intended for application developers
60
61 ColorAdjuster( ShaderEffect handle );
62
63 };
64
65 } // namespace Toolkit
66
67 } // namespace Dali
68 #endif /* __DALI_TOOLKIT_COLOR_ADJUSTER_EFFECT_H__ */