//
/**
- * @addtogroup CAPI_DALI_FRAMEWORK
+ * @addtogroup CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE
* @{
*/
{
/**
- * NinePatchMaskEffect is used to control which parts of an image are visible, using the alpha channel of a separate mask image.
+ * @brief NinePatchMaskEffect is used to control which parts of an image are visible, using the alpha channel of a separate mask image.
+ *
* The mask image is expected to be smaller than the main image being viewed.
* Conceptually the mask image is divided into a 3x3 grid (9 patches). The middle patch is stretched whilst the outer border is not.
*
{
/**
- * Apply the mask effect to an ImageActor.
+ * @brief Apply the mask effect to an ImageActor.
+ *
* NinePatchMaskEffect is mutually exclusive with ImageActor::STYLE_NINE_PATCH i.e. the actor's main image should not be a nine-patch.
* @param [in] actor The actor which needs the effect. To remove the effect call actor.RemoveShaderEffect().
* @param [in] maskImage The path to a file containing the mask. The center pixels of the mask will be stretched.
void Apply( ImageActor actor, const std::string& maskImage );
/**
- * Apply the mask effect to an ImageActor.
+ * @brief Apply the mask effect to an ImageActor.
+ *
* NinePatchMaskEffect is mutually exclusive with ImageActor::STYLE_NINE_PATCH i.e. the actor's main image should not be a nine-patch.
* @param [in] actor The actor which needs the effect. To remove the effect call actor.RemoveShaderEffect().
* @param [in] maskImage The path to a file containing the mask.