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