Property refactor in dali-toolkit: Toolkit changes
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / shader-effects / motion-blur-effect.h
index 3099d48..e9da7f2 100644 (file)
@@ -1,28 +1,28 @@
 #ifndef __DALI_TOOLKIT_SHADER_EFFECT_MOTION_BLUR_H__
 #define __DALI_TOOLKIT_SHADER_EFFECT_MOTION_BLUR_H__
 
-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+/*
+ * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
 
 // EXTERNAL INCLUDES
+#include <dali/public-api/actors/renderable-actor.h>
+#include <dali/public-api/shader-effects/shader-effect.h>
 
-// INTERNAL INCLUDES
-#include <dali/dali.h>
-
-namespace Dali DALI_IMPORT_API
+namespace Dali
 {
 
 namespace Toolkit
@@ -44,7 +44,7 @@ namespace Toolkit
  * Actor.SetShaderEffect( MotionBlurEffect );
  *
  */
-class MotionBlurEffect : public ShaderEffect
+class DALI_IMPORT_API MotionBlurEffect : public ShaderEffect
 {
 
 public:
@@ -56,9 +56,11 @@ public:
   MotionBlurEffect();
 
   /**
-   * Virtual destructor.
+   * @brief Destructor
+   *
+   * This is non-virtual since derived Handle types must not contain data or virtual methods.
    */
-  virtual ~MotionBlurEffect();
+  ~MotionBlurEffect();
 
   /**
    * Create an initialized MotionBlurEffect
@@ -72,18 +74,20 @@ public:
    * Create a  MotionBlurEffect and attach it to the specified actor
    * The number of texture samples taken along the motion velocity vector of the
    * actor, producing the blur, is set to a default of 8.
+   * @param renderable actor to apply the effect to
    * @return A handle to a newly allocated Dali resource.
    */
-  static MotionBlurEffect Apply( Actor handle );
+  static MotionBlurEffect Apply( RenderableActor renderable );
 
   /**
    * Create an initialized MotionBlurEffect
    * @param numBlurSamples The number of texture samples taken along the motion
    * velocity vector of the actor, producing the blur. A higher number gives a
    * smoother blur but costs more in terms of performance.
+   * @param numBlurSamples to have
    * @return A handle to a newly allocated Dali resource.
    */
-  static MotionBlurEffect New( const unsigned int numBlurSamples );
+  static MotionBlurEffect New( unsigned int numBlurSamples );
 
   /**
    * Set texcoord scale property. This scales the offset for texture samples
@@ -202,7 +206,7 @@ public:
 
 private:
   // Not intended for application developers
-  MotionBlurEffect( ShaderEffect handle );
+  DALI_INTERNAL MotionBlurEffect( ShaderEffect handle );
 };
 
 }
@@ -210,4 +214,3 @@ private:
 }
 
 #endif //#ifndef __DALI_TOOLKIT_SHADER_EFFECT_MOTION_BLUR_H__
-