1 #ifndef __DALI_TOOLKIT_NINE_PATCH_MASK_EFFECT_H__
2 #define __DALI_TOOLKIT_NINE_PATCH_MASK_EFFECT_H__
5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
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.
21 * @addtogroup CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE
26 #include <dali/dali.h>
28 namespace Dali DALI_IMPORT_API
35 * @brief NinePatchMaskEffect is used to control which parts of an image are visible, using the alpha channel of a separate mask image.
37 * The mask image is expected to be smaller than the main image being viewed.
38 * Conceptually the mask image is divided into a 3x3 grid (9 patches). The middle patch is stretched whilst the outer border is not.
43 * ImageActor actor = ImageActor::New( Image( EXAMPLE_IMAGE_PATH ) );
44 * NinePatchMaskEffect::Apply( actor, MASK_IMAGE_PATH );
47 * NinePatchMaskEffect is mutually exclusive with ImageActor::STYLE_NINE_PATCH i.e. the actor's main image should not be a nine-patch.
49 namespace NinePatchMaskEffect
53 * @brief Apply the mask effect to an ImageActor.
55 * NinePatchMaskEffect is mutually exclusive with ImageActor::STYLE_NINE_PATCH i.e. the actor's main image should not be a nine-patch.
56 * @param [in] actor The actor which needs the effect. To remove the effect call actor.RemoveShaderEffect().
57 * @param [in] maskImage The path to a file containing the mask. The center pixels of the mask will be stretched.
59 void Apply( ImageActor actor, const std::string& maskImage );
62 * @brief Apply the mask effect to an ImageActor.
64 * NinePatchMaskEffect is mutually exclusive with ImageActor::STYLE_NINE_PATCH i.e. the actor's main image should not be a nine-patch.
65 * @param [in] actor The actor which needs the effect. To remove the effect call actor.RemoveShaderEffect().
66 * @param [in] maskImage The path to a file containing the mask.
67 * @param [in] maskBorder Specifies the part of the mask image that will be stretched (left, top, right, bottom).
69 void Apply( ImageActor actor, const std::string& maskImage, const Vector4& maskBorder );
71 } // namespace NinePatchMaskEffect
73 } // namespace Toolkit
80 #endif // __DALI_TOOLKIT_NINE_PATCH_MASK_EFFECT_H__