1 #ifndef __DALI_TOOLKIT_MASK_EFFECT_H__
2 #define __DALI_TOOLKIT_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_FRAMEWORK
26 #include <dali/dali.h>
28 namespace Dali DALI_IMPORT_API
35 * MaskEffect is used to control which parts of an image are visible, using the alpha channel of a separate mask image.
36 * Typically mask images should be the same size as the main image being viewed, but this isn't essential.
40 * ImageActor actor = ImageActor::New( Image( EXAMPLE_IMAGE_PATH ) );
41 * MaskEffect maskEffect = MaskEffect::New( Image::New( MASK_IMAGE_PATH ) );
42 * actor.SetShaderEffect( maskEffect );
44 class DALI_IMPORT_API MaskEffect : public ShaderEffect
49 * Create an empty MaskEffect handle.
56 virtual ~MaskEffect();
59 * Create a MaskEffect.
60 * @return A handle to a newly allocated MaskEffect.
62 static MaskEffect New( Image maskImage );
64 private: // Not intended for application developers
66 DALI_INTERNAL MaskEffect( ShaderEffect handle );
69 } // namespace Toolkit
76 #endif // __DALI_TOOLKIT_MASK_EFFECT_H__