projects
/
platform
/
core
/
uifw
/
dali-toolkit.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Updated CAPI documentation style
[platform/core/uifw/dali-toolkit.git]
/
capi
/
dali-toolkit
/
public-api
/
shader-effects
/
iris-effect.h
diff --git
a/capi/dali-toolkit/public-api/shader-effects/iris-effect.h
b/capi/dali-toolkit/public-api/shader-effects/iris-effect.h
index
9f8b33a
..
b9b3653
100644
(file)
--- a/
capi/dali-toolkit/public-api/shader-effects/iris-effect.h
+++ b/
capi/dali-toolkit/public-api/shader-effects/iris-effect.h
@@
-18,7
+18,7
@@
//
/**
//
/**
- * @addtogroup CAPI_DALI_
FRAMEWORK
+ * @addtogroup CAPI_DALI_
TOOLKIT_SHADER_EFFECTS_MODULE
* @{
*/
* @{
*/
@@
-32,7
+32,7
@@
namespace Toolkit
{
/**
{
/**
- * IrisEffect is a custom shader effect to achieve iris effects in Image actors
+ *
@brief
IrisEffect is a custom shader effect to achieve iris effects in Image actors
*/
class IrisEffect : public ShaderEffect
{
*/
class IrisEffect : public ShaderEffect
{
@@
-40,26
+40,28
@@
class IrisEffect : public ShaderEffect
public:
/**
public:
/**
- * Create an uninitialized IrisEffect; this can be initialized with IrisEffect::New()
+ * @brief Create an uninitialized IrisEffect; this can be initialized with IrisEffect::New().
+ *
* Calling member functions with an uninitialized Dali::Object is not allowed.
*/
IrisEffect();
/**
* Calling member functions with an uninitialized Dali::Object is not allowed.
*/
IrisEffect();
/**
- * Virtual destructor.
+ *
@brief
Virtual destructor.
*/
virtual ~IrisEffect();
/**
*/
virtual ~IrisEffect();
/**
- * Create an initialized IrisEffect
+ * @brief Create an initialized IrisEffect.
+ *
* @return A handle to a newly allocated Dali resource.
*/
static IrisEffect New();
/**
* @return A handle to a newly allocated Dali resource.
*/
static IrisEffect New();
/**
- *
Set the radius of the iris effect (
in texture coordinate distance,
+ *
@brief Set the radius of the iris effect
in texture coordinate distance,
* i.e. 0.0 (no circle) to 1.0 (complete circle), to > 1.0 (extending
* i.e. 0.0 (no circle) to 1.0 (complete circle), to > 1.0 (extending
- * outside of texture)
+ * outside of texture)
.
*
* @note For Atlas Textures results may be unpredictable.
*
*
* @note For Atlas Textures results may be unpredictable.
*
@@
-68,7
+70,7
@@
public:
void SetRadius(float radius);
/**
void SetRadius(float radius);
/**
- * Set the blend factor of the iris effect.
+ *
@brief
Set the blend factor of the iris effect.
*
* The lower the value, the larger the blending portion
* (between Opaque & Transparent)
*
* The lower the value, the larger the blending portion
* (between Opaque & Transparent)
@@
-81,27
+83,29
@@
public:
void SetBlendFactor(float value);
/**
void SetBlendFactor(float value);
/**
- *
Sets the center point of the iris (in texture coordinates)
+ *
@brief Sets the center point of the iris (in texture coordinates).
*
* @param[in] center The center point.
*/
void SetCenter( const Vector2& center );
/**
*
* @param[in] center The center point.
*/
void SetCenter( const Vector2& center );
/**
- *
Get the name for the radius property
- *
which can be used in Animation API's
+ *
@brief Get the name for the radius property which can be used in Animation APIs.
+ *
* @return A std::string containing the property name
*/
const std::string& GetRadiusPropertyName() const;
/**
* @return A std::string containing the property name
*/
const std::string& GetRadiusPropertyName() const;
/**
- * Get the name for the blend factor property
+ * @brief Get the name for the blend factor property.
+ *
* @return A std::string containing the property name
*/
const std::string& GetBlendFactorPropertyName() const;
/**
* @return A std::string containing the property name
*/
const std::string& GetBlendFactorPropertyName() const;
/**
- * Get the name for the center property
+ * @brief Get the name for the center property.
+ *
* @return A std::string containing the property name
*/
const std::string& GetCenterPropertyName() const;
* @return A std::string containing the property name
*/
const std::string& GetCenterPropertyName() const;