optional/dali-toolkit/public-api/shader-effects/blind-effect.h

   1 #ifndef __DALI_TOOLKIT_SHADER_EFFECT_BLIND_H__
   2 #define __DALI_TOOLKIT_SHADER_EFFECT_BLIND_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 // INTERNAL INCLUDES
  21 #include <dali/dali.h>
  22
  23 namespace Dali DALI_IMPORT_API
  24 {
  25
  26 namespace Toolkit
  27 {
  28
  29 /**
  30  * BlindEffect is a custom shader effect to achieve blind effects in Image actors
  31  */
  32 class BlindEffect : public ShaderEffect
  33 {
  34 public:
  35
  36   /**
  37    * Create an uninitialized BlindEffect; this can be initialized with BlindEffect::New()
  38    * Calling member functions with an uninitialized Dali::Object is not allowed.
  39    */
  40   BlindEffect();
  41
  42   /**
  43    * Virtual destructor.
  44    */
  45   virtual ~BlindEffect();
  46
  47   /**
  48    * Create an initialized ~BlindEffect.
  49    * @return A handle to a newly allocated Dali resource.
  50    */
  51   static BlindEffect New();
  52
  53
  54   /**
  55    * Set the step of the blind effect.
  56    * @param [in] step The step
  57    */
  58   void SetStep(float step);
  59
  60   /**
  61    * Get the name for the step property
  62    * which can be used in Animation API's
  63    * @return A std::string containing the property name
  64    */
  65   const std::string& GetStepPropertyName() const;
  66
  67 private: // Not intended for application developers
  68   BlindEffect(ShaderEffect handle);
  69 };
  70
  71 } // namespace Toolkit
  72
  73 } // namespace Dali
  74
  75 #endif // __DALI_TOOLKIT_SHADER_EFFECT_BLIND_H__