[dali_2.0.21] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / shader-effects / image-region-effect.h
1 #ifndef DALI_TOOLKIT_IMAGE_REGION_EFFECT_H
2 #define DALI_TOOLKIT_IMAGE_REGION_EFFECT_H
3
4 /*
5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
6  *
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
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
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.
18  *
19  */
20
21 // EXTERNAL INCLUDES
22 #include <dali/public-api/object/property-map.h>
23
24 // INTERNAL INCLUDES
25 #include <dali-toolkit/public-api/dali-toolkit-common.h>
26
27 namespace Dali
28 {
29 namespace Toolkit
30 {
31 /**
32  * @brief Creates a new ImageRegionEffect
33  *
34  * ImageRegionEffect is a custom shader effect to show only a region of an Image actor.
35  *
36  * Animatable/Constrainable uniforms:
37  *  "uTopLeft"      - The top-left corner of the image region. The coordinates are in percentage,
38  *                    (0,0) being the top-left and (1,1) the bottom right of the original image
39  *  "uBottomRight"  - The bottom-right corner of the image region. The coordinates are in percentage,
40  *                    (0,0) being the top-left and (1,1) the bottom right of the original image
41  *
42  * @return A property map of the required shader
43  */
44 DALI_TOOLKIT_API Property::Map CreateImageRegionEffect();
45
46 } // namespace Toolkit
47
48 } // namespace Dali
49
50 #endif // DALI_TOOLKIT_IMAGE_REGION_EFFECT_H