base/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 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  * @brief MaskEffect is used to control which parts of an image are visible, using the alpha channel of a separate mask image.
  32  *
  33  * Typically mask 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  *   MaskEffect maskEffect = MaskEffect::New( Image::New( MASK_IMAGE_PATH ) );
  39  *   actor.SetShaderEffect( maskEffect );
  40  */
  41 class DALI_IMPORT_API MaskEffect : public ShaderEffect
  42 {
  43 public:
  44
  45   /**
  46    * @brief Create an empty MaskEffect handle.
  47    */
  48   MaskEffect();
  49
  50   /**
  51    * @brief Destructor
  52    *
  53    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  54    */
  55   ~MaskEffect();
  56
  57   /**
  58    * @brief Create a MaskEffect.
  59    *
  60    * @param[in] maskImage The image to use as a mask
  61    * @return A handle to a newly allocated MaskEffect.
  62    */
  63   static MaskEffect New( Image maskImage );
  64
  65 private: // Not intended for application developers
  66
  67   DALI_INTERNAL MaskEffect( ShaderEffect handle );
  68 };
  69
  70 } // namespace Toolkit
  71
  72 } // namespace Dali
  73
  74 #endif // __DALI_TOOLKIT_MASK_EFFECT_H__