dali-toolkit/devel-api/shader-effects/overlay-effect.h

   1 #ifndef __DALI_TOOLKIT_OVERLAY_EFFECT_H__
   2 #define __DALI_TOOLKIT_OVERLAY_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/images/image.h>
  23 #include <dali/public-api/shader-effects/shader-effect.h>
  24
  25 namespace Dali
  26 {
  27
  28 namespace Toolkit
  29 {
  30
  31 /**
  32  * @brief Creates a new OverlayEffect
  33  *
  34  * OverlayEffect is used to apply an overlay image to the actor.
  35  * Typically overlay images should be the same size as the main image being viewed, but this isn't essential.
  36  *
  37  * Usage example:
  38  *
  39  *   ImageActor actor = ImageActor::New( Image( EXAMPLE_IMAGE_PATH ) );
  40  *   ShaderEffect overlayEffect = CreateOverlayEffect( Image::New( OVERLAY_IMAGE_PATH ) );
  41  *   actor.SetShaderEffect( overlayEffect );
  42  *
  43  *   @param[in] overlayImage The image to overlay on top of the actor
  44  *   @return A handle to a newly allocated ShaderEffect
  45  */
  46 inline ShaderEffect CreateOverlayEffect(Image overlayImage)
  47 {
  48   // (Target > 0.5) * (1 - (1-2*(Target-0.5)) * (1-Blend)) + (Target <= 0.5) * ((2*Target) * Blend)
  49   const char* OVERLAY_FRAGMENT_SHADER_SOURCE =
  50       "void main()\n"
  51       "{\n"
  52       "  lowp vec4 target = texture2D(sTexture, vTexCoord);\n"
  53       "  lowp vec4 overlay = texture2D(sEffect, vTexCoord);\n"
  54       "  if ( length( target.rgb ) > 0.5 )\n"
  55       "  {\n"
  56       "    gl_FragColor = vec4( mix( target.rgb, 1.0 - ( 1.0 - 2.0 * ( target.rgb - 0.5 ) )  * ( 1.0 - overlay.rgb ), overlay.a ), min( 1.0, target.a + overlay.a ) );\n"
  57       "  }\n"
  58       "  else\n"
  59       "  {\n"
  60       "    gl_FragColor = vec4( mix( target.rgb, 2.0 * target.rgb * overlay.rgb, overlay.a ), target.a + overlay.a );\n"
  61       "  }\n"
  62       "}\n";
  63
  64   ShaderEffect shaderEffect = ShaderEffect::New(
  65       "", // Use default
  66       OVERLAY_FRAGMENT_SHADER_SOURCE,
  67       GeometryType( GEOMETRY_TYPE_IMAGE ),
  68       ShaderEffect::GeometryHints( ShaderEffect::HINT_BLENDING ) );
  69
  70   shaderEffect.SetEffectImage( overlayImage );
  71
  72   return shaderEffect;
  73 }
  74
  75 } // namespace Toolkit
  76
  77 } // namespace Dali
  78
  79 #endif // __DALI_TOOLKIT_OVERLAY_EFFECT_H__