capi/dali-toolkit/public-api/shader-effects/dissolve-effect.h

   1 #ifndef __DALI_TOOLKIT_SHADER_EFFECT_DISSOLVE_H__
   2 #define __DALI_TOOLKIT_SHADER_EFFECT_DISSOLVE_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 /**
  21  * @addtogroup CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE
  22  * @{
  23  */
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/dali.h>
  27
  28 namespace Dali DALI_IMPORT_API
  29 {
  30
  31 namespace Toolkit
  32 {
  33
  34 /**
  35  * @brief DissolveEffect is a custom shader effect to achieve Dissolve effects in Image actors.
  36  */
  37 class DissolveEffect : public ShaderEffect
  38 {
  39 public:
  40
  41   /**
  42    * @brief Create an uninitialized DissolveEffect; this can be initialized with DissolveEffect::New().
  43    *
  44    * Calling member functions with an uninitialized Dali::Object is not allowed.
  45    */
  46   DissolveEffect();
  47
  48   /**
  49    * @brief Virtual destructor.
  50    */
  51   virtual ~DissolveEffect();
  52
  53   /**
  54    * @brief Create an initialized DissolveEffect.
  55    *
  56    * @param[in] useHighPrecision True if using high precision in fragment shader for fully random noise, false otherwise
  57    * @return A handle to a newly allocated Dali resource.
  58    */
  59   static DissolveEffect New( bool useHighPrecision = true);
  60
  61   /**
  62    * @brief Set the dissolve central line.
  63    *
  64    * Use one point (position) and one direction ( displacement ) vector to define this line
  65    * As we use the texture coordinate as pixel position to calculate random offset,
  66    * the line should passing through rectangle {(0,0),(0,1),(1,0),(1,1)},
  67    * so make the position parameter with two component values between 0.0 to 1.0
  68    * @param[in] position The point ( locates within rectangle {(0,0),(0,1),(1,0),(1,1)} ) passed through by the central line
  69    * @param[in] displacement The direction of the central line
  70    */
  71   void SetCentralLine( const Vector2& position, const Vector2& displacement );
  72
  73   /**
  74    * @brief Sets the distortion applied to the effect texture.
  75    *
  76    * This value is proportional to the distortion applied; a value of zero means no distortion.
  77    * @param [in] distortion The distortion value.
  78    */
  79   void SetDistortion( float distortion );
  80
  81   /**
  82    * @brief Get the name for the distortion property.
  83    *
  84    * @return A std::string containing the property name
  85    */
  86   const std::string& GetDistortionPropertyName() const;
  87
  88 private: // Not intended for application developers
  89   DissolveEffect(ShaderEffect handle);
  90 };
  91
  92 } // namespace Toolkit
  93
  94 } // namespace Dali
  95
  96 /**
  97  * @}
  98  */
  99 #endif // __DALI_TOOLKIT_SHADER_EFFECT_DISSOLVE_H__