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