1 #ifndef __DALI_TOOLKIT_SHADER_EFFECT_DISSOLVE_H__
2 #define __DALI_TOOLKIT_SHADER_EFFECT_DISSOLVE_H__
5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
11 // http://floralicense.org/license/
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.
21 * @addtogroup CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE
26 #include <dali/dali.h>
28 namespace Dali DALI_IMPORT_API
35 * @brief DissolveEffect is a custom shader effect to achieve Dissolve effects in Image actors.
37 class DissolveEffect : public ShaderEffect
42 * @brief Create an uninitialized DissolveEffect; this can be initialized with DissolveEffect::New().
44 * Calling member functions with an uninitialized Dali::Object is not allowed.
49 * @brief Virtual destructor.
51 virtual ~DissolveEffect();
54 * @brief Create an initialized DissolveEffect.
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.
59 static DissolveEffect New( bool useHighPrecision = true);
62 * @brief Set the dissolve central line.
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
71 void SetCentralLine( const Vector2& position, const Vector2& displacement );
74 * @brief Sets the distortion applied to the effect texture.
76 * This value is proportional to the distortion applied; a value of zero means no distortion.
77 * @param [in] distortion The distortion value.
79 void SetDistortion( float distortion );
82 * @brief Get the name for the distortion property.
84 * @return A std::string containing the property name
86 const std::string& GetDistortionPropertyName() const;
88 private: // Not intended for application developers
89 DissolveEffect(ShaderEffect handle);
92 } // namespace Toolkit
99 #endif // __DALI_TOOLKIT_SHADER_EFFECT_DISSOLVE_H__