dali-toolkit/devel-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) 2015 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/shader-effects/shader-effect.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 /**
  31  * Alpha discard effect is used to discard fragments when the alpha colour value is below a threshold.
  32  * This is useful for stenciling.
  33  *
  34  * Usage example:
  35  *
  36  *   ImageActor actor = ImageActor::New( Image( EXAMPLE_IMAGE_PATH ) );
  37  *   AlphaDiscardEffect alphaDiscardEffect = AlphaDiscardEffect::New();
  38  *   actor.SetShaderEffect( alphaDiscardEffect );
  39  */
  40 class DALI_IMPORT_API AlphaDiscardEffect : public ShaderEffect
  41 {
  42 public:
  43
  44   /**
  45    * Create an empty AlphaDiscardEffect handle.
  46    */
  47   AlphaDiscardEffect();
  48
  49   /**
  50    * @brief Destructor
  51    *
  52    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  53    */
  54   ~AlphaDiscardEffect();
  55
  56   /**
  57    * Create a AlphaDiscardEffect.
  58    * @return A handle to a newly allocated AlphaDiscardEffect.
  59    */
  60   static AlphaDiscardEffect New();
  61
  62 private: // Not intended for application developers
  63
  64   DALI_INTERNAL AlphaDiscardEffect( ShaderEffect handle );
  65 };
  66
  67 } // namespace Toolkit
  68
  69 } // namespace Dali
  70
  71 #endif // __DALI_TOOLKIT_ALPHA_DISCARD_EFFECT_H__