Conversion to Apache 2.0 license
[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 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/dali.h>
23
24 namespace Dali DALI_IMPORT_API
25 {
26
27 namespace Toolkit
28 {
29
30 /**
31  * ColorAdjuster is a custom shader effect to adjust the image color in HSV space.
32  */
33 class ColorAdjuster : public ShaderEffect
34 {
35 public:
36
37   /**
38    * Create an empty ColorAdjuster handle.
39    */
40   ColorAdjuster();
41
42   /**
43    * Virtual destructor.
44    */
45   virtual ~ColorAdjuster();
46
47   /**
48    * Create an initialized ColorAdjuster.
49    * @param[in] hsvDelta The color difference to apply to the HSV channel.
50    * @param[in] ignoreAlpha If true, the result color will be opaque even though source has alpha value
51    * @return A handle to a newly allocated Dali resource.
52    */
53   static ColorAdjuster New( const Vector3& hsvDelta, bool ignoreAlpha = false );
54
55    /**
56    * Get the name of the uHSVDelta uniform so that it can be animated
57    */
58   std::string GetHsvDeltaPropertyName() const;
59
60 private: // Not intended for application developers
61
62 ColorAdjuster( ShaderEffect handle );
63
64 };
65
66 } // namespace Toolkit
67
68 } // namespace Dali
69 #endif /* __DALI_TOOLKIT_COLOR_ADJUSTER_EFFECT_H__ */