1 #ifndef __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE2D_H__
2 #define __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE2D_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 * @addtogroup CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE
27 #include <dali/dali.h>
29 namespace Dali DALI_IMPORT_API
36 * @brief Ripple2DEffect is a custom shader effect to achieve 2d ripple effects on Image actors.
38 class Ripple2DEffect : public ShaderEffect
43 * @brief Create an uninitialized Ripple2DEffect; this can be initialized with Ripple2DEffect::New().
45 * Calling member functions with an uninitialized Dali::Object is not allowed.
50 * @brief Virtual destructor.
52 virtual ~Ripple2DEffect();
55 * @brief Create an initialized Ripple2DEffect.
57 * @return A handle to a newly allocated Dali resource.
59 static Ripple2DEffect New();
62 * @brief Set the amplitude of the 2d ripple.
64 * @param[in] amplitude The amplitude in float.
66 void SetAmplitude(float amplitude);
69 * @brief Set the time duration for the 2d ripple.
71 * @param[in] time The time duration in float.
73 void SetTime(float time);
76 * @brief Get the name for the amplitude property.
78 * @return A std::string containing the property name
80 const std::string& GetAmplitudePropertyName() const;
83 * @brief Get the name for the time property.
85 * which can be used in Animation API's
86 * @return A std::string containing the property name
88 const std::string& GetTimePropertyName() const;
91 Ripple2DEffect(ShaderEffect handle);
95 } // namespace Toolkit
102 #endif // __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE2D_H__