X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=capi%2Fdali-toolkit%2Fpublic-api%2Fshader-effects%2Fdissolve-effect.h;h=f687e88b573212e8756f727514b30e03d8c4eeba;hp=634e4ab3cb14fd169cb867ba4eea0ccaed0f60b9;hb=aa19ec23c1186efea1585ed2dc19587714063e39;hpb=ae1982a116aae1d8e25837fa553ba2e37bc062a7 diff --git a/capi/dali-toolkit/public-api/shader-effects/dissolve-effect.h b/capi/dali-toolkit/public-api/shader-effects/dissolve-effect.h index 634e4ab..f687e88 100644 --- a/capi/dali-toolkit/public-api/shader-effects/dissolve-effect.h +++ b/capi/dali-toolkit/public-api/shader-effects/dissolve-effect.h @@ -18,7 +18,7 @@ // /** - * @addtogroup CAPI_DALI_FRAMEWORK + * @addtogroup CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE * @{ */ @@ -32,32 +32,35 @@ namespace Toolkit { /** - * DissolveEffect is a custom shader effect to achieve Dissolve effects in Image actors + * @brief DissolveEffect is a custom shader effect to achieve Dissolve effects in Image actors. */ class DissolveEffect : public ShaderEffect { public: /** - * Create an uninitialized DissolveEffect; this can be initialized with DissolveEffect::New() + * @brief Create an uninitialized DissolveEffect; this can be initialized with DissolveEffect::New(). + * * Calling member functions with an uninitialized Dali::Object is not allowed. */ DissolveEffect(); /** - * Virtual destructor. + * @brief Virtual destructor. */ virtual ~DissolveEffect(); /** - * Create an initialized DissolveEffect. + * @brief Create an initialized DissolveEffect. + * * @param[in] useHighPrecision True if using high precision in fragment shader for fully random noise, false otherwise * @return A handle to a newly allocated Dali resource. */ static DissolveEffect New( bool useHighPrecision = true); /** - * Set the dissolve central line + * @brief Set the dissolve central line. + * * Use one point (position) and one direction ( displacement ) vector to define this line * As we use the texture coordinate as pixel position to calculate random offset, * the line should passing through rectangle {(0,0),(0,1),(1,0),(1,1)}, @@ -68,14 +71,16 @@ public: void SetCentralLine( const Vector2& position, const Vector2& displacement ); /** - * Sets the distortion applied to the effect texture. + * @brief Sets the distortion applied to the effect texture. + * * This value is proportional to the distortion applied; a value of zero means no distortion. * @param [in] distortion The distortion value. */ void SetDistortion( float distortion ); /** - * Get the name for the distortion property + * @brief Get the name for the distortion property. + * * @return A std::string containing the property name */ const std::string& GetDistortionPropertyName() const;