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 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 * @addtogroup CAPI_DALI_TOOLKIT_SHADER_EFFECTS_MODULE
27 #include <dali/dali.h>
29 namespace Dali DALI_IMPORT_API
36 * @brief MaskEffect is used to control which parts of an image are visible, using the alpha channel of a separate mask image.
38 * Typically mask images should be the same size as the main image being viewed, but this isn't essential.
42 * ImageActor actor = ImageActor::New( Image( EXAMPLE_IMAGE_PATH ) );
43 * MaskEffect maskEffect = MaskEffect::New( Image::New( MASK_IMAGE_PATH ) );
44 * actor.SetShaderEffect( maskEffect );
46 class DALI_IMPORT_API MaskEffect : public ShaderEffect
51 * @brief Create an empty MaskEffect handle.
58 * This is non-virtual since derived Handle types must not contain data or virtual methods.
63 * @brief Create a MaskEffect.
65 * @param[in] maskImage The image to use as a mask
66 * @return A handle to a newly allocated MaskEffect.
68 static MaskEffect New( Image maskImage );
70 private: // Not intended for application developers
72 DALI_INTERNAL MaskEffect( ShaderEffect handle );
75 } // namespace Toolkit
82 #endif // __DALI_TOOLKIT_MASK_EFFECT_H__