1 #ifndef __DALI_TOOLKIT_SHADER_EFFECT_SQUARE_H__
2 #define __DALI_TOOLKIT_SHADER_EFFECT_SQUARE_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 * SquareDissolveEffect is a custom shader effect to achieve square effects in Image actors
33 class DALI_IMPORT_API SquareDissolveEffect : public ShaderEffect
38 * Create an uninitialized SquareDissolveEffect; this can be initialized with BendyEffect::New()
39 * Calling member functions with an uninitialized Dali::Object is not allowed.
41 SquareDissolveEffect();
46 * This is non-virtual since derived Handle types must not contain data or virtual methods.
48 ~SquareDissolveEffect();
51 * Create an initialized SquareDissolveEffect.
52 * @return A handle to a newly allocated Dali resource.
54 static SquareDissolveEffect New();
57 * Set the step of the square effect.
58 * @param [in] step the new step.
60 void SetStep(float step);
63 * Set the rows of the square dissolve effect.
64 * @param [in] rows the new rows value.
66 void SetRows(float rows);
69 * Set the columns of the square dissolve effect.
70 * @param [in] columns the new columns value.
72 void SetColumns(float columns);
75 * Set the texture size of the square dissolve.
76 * @param[in] textureSize The texture size in Vector2.
78 void SetTextureSize(const Vector2& textureSize);
81 * Get the name for the step property
82 * which can be used in Animation API's
83 * @return A std::string containing the property name
85 const std::string& GetStepPropertyName() const;
88 * Get the name for the rows property
89 * which can be used in Animation API's
90 * @return A std::string containing the property name
92 const std::string& GetRowsPropertyName() const;
95 * Get the name for the columns property
96 * which can be used in Animation API's
97 * @return A std::string containing the property name
99 const std::string& GetColumnsPropertyName() const;
102 * Get the name for the texSize property
103 * which can be used in Animation API's
104 * @return A std::string containing the property name
106 const std::string& GetTexSizePropertyName() const;
108 private: // Not intended for application developers
109 DALI_INTERNAL SquareDissolveEffect(ShaderEffect handle);
112 } // namespace Toolkit
116 #endif // __DALI_TOOLKIT_SHADER_EFFECT_SQUARE_H__