Add 'ExclusiveArch: armv7l' limit build to arm architecture
[platform/core/uifw/dali-toolkit.git] / optional / dali-toolkit / public-api / shader-effects / alpha-discard-effect.h
1 #ifndef __DALI_TOOLKIT_ALPHA_DISCARD_EFFECT_H__
2 #define __DALI_TOOLKIT_ALPHA_DISCARD_EFFECT_H__
3
4 //
5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
6 //
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
10 //
11 //     http://floralicense.org/license/
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 // INTERNAL INCLUDES
21 #include <dali/dali.h>
22
23 namespace Dali DALI_IMPORT_API
24 {
25
26 namespace Toolkit
27 {
28
29 /**
30  * Alpha discard effect is used to discard fragments when the alpha colour value is below a threshold.
31  * This is useful for stenciling.
32  *
33  * Usage example:
34  *
35  *   ImageActor actor = ImageActor::New( Image( EXAMPLE_IMAGE_PATH ) );
36  *   AlphaDiscardEffect alphaDiscardEffect = AlphaDiscardEffect::New();
37  *   actor.SetShaderEffect( alphaDiscardEffect );
38  */
39 class DALI_IMPORT_API AlphaDiscardEffect : public ShaderEffect
40 {
41 public:
42
43   /**
44    * Create an empty AlphaDiscardEffect handle.
45    */
46   AlphaDiscardEffect();
47
48   /**
49    * Virtual destructor.
50    */
51   virtual ~AlphaDiscardEffect();
52
53   /**
54    * Create a AlphaDiscardEffect.
55    * @return A handle to a newly allocated AlphaDiscardEffect.
56    */
57   static AlphaDiscardEffect New();
58
59 private: // Not intended for application developers
60
61   DALI_INTERNAL AlphaDiscardEffect( ShaderEffect handle );
62 };
63
64 } // namespace Toolkit
65
66 } // namespace Dali
67
68 #endif // __DALI_TOOLKIT_ALPHA_DISCARD_EFFECT_H__