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 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/dali.h>
24 namespace Dali DALI_IMPORT_API
31 * @brief DissolveEffect is a custom shader effect to achieve Dissolve effects in Image actors.
33 class DissolveEffect : public ShaderEffect
38 * @brief Create an uninitialized DissolveEffect; this can be initialized with DissolveEffect::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 DissolveEffect.
54 * @param[in] useHighPrecision True if using high precision in fragment shader for fully random noise, false otherwise
55 * @return A handle to a newly allocated Dali resource.
57 static DissolveEffect New( bool useHighPrecision = true);
60 * @brief Set the dissolve central line.
62 * Use one point (position) and one direction ( displacement ) vector to define this line
63 * As we use the texture coordinate as pixel position to calculate random offset,
64 * the line should passing through rectangle {(0,0),(0,1),(1,0),(1,1)},
65 * so make the position parameter with two component values between 0.0 to 1.0
66 * @param[in] position The point ( locates within rectangle {(0,0),(0,1),(1,0),(1,1)} ) passed through by the central line
67 * @param[in] displacement The direction of the central line
69 void SetCentralLine( const Vector2& position, const Vector2& displacement );
72 * @brief Sets the distortion applied to the effect texture.
74 * This value is proportional to the distortion applied; a value of zero means no distortion.
75 * @param [in] distortion The distortion value.
77 void SetDistortion( float distortion );
80 * @brief Get the name for the distortion property.
82 * @return A std::string containing the property name
84 const std::string& GetDistortionPropertyName() const;
86 private: // Not intended for application developers
87 DissolveEffect(ShaderEffect handle);
90 } // namespace Toolkit
94 #endif // __DALI_TOOLKIT_SHADER_EFFECT_DISSOLVE_H__