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  * OverlayEffect is used to apply an overlay image to the actor.
  33  * Typically overlay images should be the same size as the main image being viewed, but this isn't essential.
  34  *
  35  * Usage example:
  36  *
  37  *   ImageActor actor = ImageActor::New( Image( EXAMPLE_IMAGE_PATH ) );
  38  *   OverlayEffect overlayEffect = OverlayEffect::New( Image::New( OVERLAY_IMAGE_PATH ) );
  39  *   actor.SetShaderEffect( overlayEffect );
  40  */
  41 class DALI_IMPORT_API OverlayEffect : public ShaderEffect
  42 {
  43 public:
  44
  45   /**
  46    * Create an empty OverlayEffect handle.
  47    */
  48   OverlayEffect();
  49
  50   /**
  51    * @brief Destructor
  52    *
  53    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  54    */
  55   ~OverlayEffect();
  56
  57   /**
  58    * Create a OverlayEffect.
  59    * @return A handle to a newly allocated OverlayEffect.
  60    */
  61   static OverlayEffect New( Image overlayImage );
  62
  63 private: // Not intended for application developers
  64
  65   DALI_INTERNAL OverlayEffect( ShaderEffect handle );
  66 };
  67
  68 } // namespace Toolkit
  69
  70 } // namespace Dali
  71
  72 #endif // __DALI_TOOLKIT_OVERLAY_EFFECT_H__