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) 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 Alpha discard effect
  33  *
  34  * Alpha discard effect is used to discard fragments when the alpha colour value is below a threshold.
  35  * This is useful for stenciling.
  36  *
  37  * Usage example:
  38  *
  39  *   ImageView actor = ImageView::New( EXAMPLE_IMAGE_PATH );
  40  *   Property::Map alphaDiscardEffect = CreateAlphaDiscardEffect();
  41  *   actor.SetProperty( ImageView::Property::IMAGE, alphaDiscardEffect );
  42  *
  43  * @return A property map of the required shaders.
  44  */
  45 DALI_TOOLKIT_API Property::Map CreateAlphaDiscardEffect();
  46
  47 } // namespace Toolkit
  48
  49 } // namespace Dali
  50
  51 #endif // DALI_TOOLKIT_ALPHA_DISCARD_EFFECT_H