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