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    * @brief Destructor
  44    *
  45    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  46    */
  47   ~ColorAdjuster();
  48
  49   /**
  50    * Create an initialized ColorAdjuster.
  51    * @param[in] hsvDelta The color difference to apply to the HSV channel.
  52    * @param[in] ignoreAlpha If true, the result color will be opaque even though source has alpha value
  53    * @return A handle to a newly allocated Dali resource.
  54    */
  55   static ColorAdjuster New( const Vector3& hsvDelta, bool ignoreAlpha = false );
  56
  57    /**
  58    * Get the name of the uHSVDelta uniform so that it can be animated
  59    */
  60   std::string GetHsvDeltaPropertyName() const;
  61
  62 private: // Not intended for application developers
  63
  64 ColorAdjuster( ShaderEffect handle );
  65
  66 };
  67
  68 } // namespace Toolkit
  69
  70 } // namespace Dali
  71 #endif /* __DALI_TOOLKIT_COLOR_ADJUSTER_EFFECT_H__ */