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