1 #ifndef __DALI_TOOLKIT_NINE_PATCH_MASK_EFFECT_H__
2 #define __DALI_TOOLKIT_NINE_PATCH_MASK_EFFECT_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/actors/image-actor.h>
31 * @brief NinePatchMaskEffect is used to control which parts of an image are visible, using the alpha channel of a separate mask image.
33 * The mask image is expected to be smaller than the main image being viewed.
34 * Conceptually the mask image is divided into a 3x3 grid (9 patches). The middle patch is stretched whilst the outer border is not.
39 * ImageActor actor = ImageActor::New( Image( EXAMPLE_IMAGE_PATH ) );
40 * NinePatchMaskEffect::Apply( actor, MASK_IMAGE_PATH );
43 * NinePatchMaskEffect is mutually exclusive with ImageActor::STYLE_NINE_PATCH i.e. the actor's main image should not be a nine-patch.
45 namespace NinePatchMaskEffect
49 * @brief Apply the mask effect to an ImageActor.
51 * NinePatchMaskEffect is mutually exclusive with ImageActor::STYLE_NINE_PATCH i.e. the actor's main image should not be a nine-patch.
52 * @param [in] actor The actor which needs the effect. To remove the effect call actor.RemoveShaderEffect().
53 * @param [in] maskImage The path to a file containing the mask. The center pixels of the mask will be stretched.
55 DALI_IMPORT_API void Apply( ImageActor actor, const std::string& maskImage );
58 * @brief Apply the mask effect to an ImageActor.
60 * NinePatchMaskEffect is mutually exclusive with ImageActor::STYLE_NINE_PATCH i.e. the actor's main image should not be a nine-patch.
61 * @param [in] actor The actor which needs the effect. To remove the effect call actor.RemoveShaderEffect().
62 * @param [in] maskImage The path to a file containing the mask.
63 * @param [in] maskBorder Specifies the part of the mask image that will be stretched (left, top, right, bottom).
65 DALI_IMPORT_API void Apply( ImageActor actor, const std::string& maskImage, const Vector4& maskBorder );
67 } // namespace NinePatchMaskEffect
69 } // namespace Toolkit
73 #endif // __DALI_TOOLKIT_NINE_PATCH_MASK_EFFECT_H__