dali-toolkit/devel-api/shader-effects/distance-field-effect.h

   1 #ifndef DALI_TOOLKIT_SHADER_EFFECT_DISTANCEFIELD_H
   2 #define DALI_TOOLKIT_SHADER_EFFECT_DISTANCEFIELD_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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/dali-toolkit-common.h>
  23
  24 // EXTERNAL INCLUDES
  25 #include <dali/public-api/object/property-map.h>
  26
  27 namespace Dali
  28 {
  29 namespace Toolkit
  30 {
  31 /**
  32  * Creates a new DistanceFieldEffect
  33  *
  34  * DistanceFieldEffect is a custom shader effect to achieve distance field on Image actors
  35  *
  36  * Animatable/Constrainable uniforms - These will need to be registered to the actor as a custom property to take into effect:
  37  *
  38  *  "uDoGlow"       - The glow state. If true, glow is enabled
  39  *  "uGlowBoundary" - The glow boundary factor
  40  *  "uGlowColor"    - The glow color multiplier
  41
  42  *  "uDoShadow"     - The shadow state. If true, shadows is enabled. Cannot be used with glow/and or outline
  43  *  "uShadowColor"  - The shadow color multiplier
  44  *  "uShadowOffset" - The shadow offset
  45
  46  *  "uDoOutline"    - The outline state. If true, outline is enabled
  47  *  "uOutlineColor" - The outline color multiplier
  48  *  "uOutlineParams"- Thickness of outline. The outline thickness is determined by two values.
  49  *                    First value [0-1] Specifies the distance field value for the center of the outline.
  50  *                    Second value [0-1] Specifies the softness/width/anti-aliasing of the outlines inner edge.
  51  *
  52  *  @return The newly created Property::Map with the distance field effect
  53  */
  54 DALI_TOOLKIT_API Dali::Property::Map CreateDistanceFieldEffect();
  55
  56 } // namespace Toolkit
  57
  58 } // namespace Dali
  59
  60 #endif // DALI_TOOLKIT_SHADER_EFFECT_DISTANCEFIELD_H