1 #ifndef __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE2D_H__
2 #define __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE2D_H__
5 * Copyright (c) 2015 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 #include <dali/public-api/shader-effects/shader-effect.h>
31 * @brief Ripple2DEffect is a custom shader effect to achieve 2d ripple effects on Image actors.
33 class DALI_IMPORT_API Ripple2DEffect : public ShaderEffect
38 * @brief Create an uninitialized Ripple2DEffect; this can be initialized with Ripple2DEffect::New().
40 * Calling member functions with an uninitialized Dali::Object is not allowed.
47 * This is non-virtual since derived Handle types must not contain data or virtual methods.
52 * @brief Create an initialized Ripple2DEffect.
54 * @return A handle to a newly allocated Dali resource.
56 static Ripple2DEffect New();
59 * @brief Set the amplitude of the 2d ripple.
61 * @param[in] amplitude The amplitude in float.
63 void SetAmplitude(float amplitude);
66 * @brief Set the time duration for the 2d ripple.
68 * @param[in] time The time duration in float.
70 void SetTime(float time);
73 * @brief Get the name for the amplitude property.
75 * @return A std::string containing the property name
77 const std::string& GetAmplitudePropertyName() const;
80 * @brief Get the name for the time property.
82 * which can be used in Animation API's
83 * @return A std::string containing the property name
85 const std::string& GetTimePropertyName() const;
88 DALI_INTERNAL Ripple2DEffect(ShaderEffect handle);
92 } // namespace Toolkit
96 #endif // __DALI_TOOLKIT_SHADER_EFFECT_RIPPLE2D_H__