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 Flora License, Version 1.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://floralicense.org/license/
  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 // INTERNAL INCLUDES
  21 #include <dali/dali.h>
  22
  23 namespace Dali DALI_IMPORT_API
  24 {
  25
  26 namespace Toolkit
  27 {
  28
  29 /**
  30  * OverlayEffect is used to apply an overlay image to the actor.
  31  * Typically overlay images should be the same size as the main image being viewed, but this isn't essential.
  32  *
  33  * Usage example:
  34  *
  35  *   ImageActor actor = ImageActor::New( Image( EXAMPLE_IMAGE_PATH ) );
  36  *   OverlayEffect overlayEffect = OverlayEffect::New( Image::New( OVERLAY_IMAGE_PATH ) );
  37  *   actor.SetShaderEffect( overlayEffect );
  38  */
  39 class DALI_IMPORT_API OverlayEffect : public ShaderEffect
  40 {
  41 public:
  42
  43   /**
  44    * Create an empty OverlayEffect handle.
  45    */
  46   OverlayEffect();
  47
  48   /**
  49    * Virtual destructor.
  50    */
  51   virtual ~OverlayEffect();
  52
  53   /**
  54    * Create a OverlayEffect.
  55    * @return A handle to a newly allocated OverlayEffect.
  56    */
  57   static OverlayEffect New( Image overlayImage );
  58
  59 private: // Not intended for application developers
  60
  61   DALI_INTERNAL OverlayEffect( ShaderEffect handle );
  62 };
  63
  64 } // namespace Toolkit
  65
  66 } // namespace Dali
  67
  68 #endif // __DALI_TOOLKIT_OVERLAY_EFFECT_H__