capi/dali-toolkit/public-api/shader-effects/mask-effect.h

   1 #ifndef __DALI_TOOLKIT_MASK_EFFECT_H__
   2 #define __DALI_TOOLKIT_MASK_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 /**
  21  * @addtogroup CAPI_DALI_FRAMEWORK
  22  * @{
  23  */
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/dali.h>
  27
  28 namespace Dali DALI_IMPORT_API
  29 {
  30
  31 namespace Toolkit
  32 {
  33
  34 /**
  35  * MaskEffect is used to control which parts of an image are visible, using the alpha channel of a separate mask image.
  36  * Typically mask images should be the same size as the main image being viewed, but this isn't essential.
  37  *
  38  * Usage example:
  39  *
  40  *   ImageActor actor = ImageActor::New( Image( EXAMPLE_IMAGE_PATH ) );
  41  *   MaskEffect maskEffect = MaskEffect::New( Image::New( MASK_IMAGE_PATH ) );
  42  *   actor.SetShaderEffect( maskEffect );
  43  */
  44 class DALI_IMPORT_API MaskEffect : public ShaderEffect
  45 {
  46 public:
  47
  48   /**
  49    * Create an empty MaskEffect handle.
  50    */
  51   MaskEffect();
  52
  53   /**
  54    * Virtual destructor.
  55    */
  56   virtual ~MaskEffect();
  57
  58   /**
  59    * Create a MaskEffect.
  60    * @return A handle to a newly allocated MaskEffect.
  61    */
  62   static MaskEffect New( Image maskImage );
  63
  64 private: // Not intended for application developers
  65
  66   DALI_INTERNAL MaskEffect( ShaderEffect handle );
  67 };
  68
  69 } // namespace Toolkit
  70
  71 } // namespace Dali
  72
  73 /**
  74  * @}
  75  */
  76 #endif // __DALI_TOOLKIT_MASK_EFFECT_H__