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_TOOLKIT_SHADER_EFFECTS_MODULE
  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  * @brief MaskEffect is used to control which parts of an image are visible, using the alpha channel of a separate mask image.
  36  *
  37  * Typically mask images should be the same size as the main image being viewed, but this isn't essential.
  38  *
  39  * Usage example:
  40  *
  41  *   ImageActor actor = ImageActor::New( Image( EXAMPLE_IMAGE_PATH ) );
  42  *   MaskEffect maskEffect = MaskEffect::New( Image::New( MASK_IMAGE_PATH ) );
  43  *   actor.SetShaderEffect( maskEffect );
  44  */
  45 class DALI_IMPORT_API MaskEffect : public ShaderEffect
  46 {
  47 public:
  48
  49   /**
  50    * @brief Create an empty MaskEffect handle.
  51    */
  52   MaskEffect();
  53
  54   /**
  55    * @brief Virtual destructor.
  56    */
  57   virtual ~MaskEffect();
  58
  59   /**
  60    * @brief Create a MaskEffect.
  61    *
  62    * @param[in] maskImage The image to use as a mask
  63    * @return A handle to a newly allocated MaskEffect.
  64    */
  65   static MaskEffect New( Image maskImage );
  66
  67 private: // Not intended for application developers
  68
  69   DALI_INTERNAL MaskEffect( ShaderEffect handle );
  70 };
  71
  72 } // namespace Toolkit
  73
  74 } // namespace Dali
  75
  76 /**
  77  * @}
  78  */
  79 #endif // __DALI_TOOLKIT_MASK_EFFECT_H__