Add @DEPRECATED to all public symbols of ImageActor & ShaderEffect

Change-Id: Id5e39573f38bbf94fe67b1ea0df5989b05f8ae30

diff --git a/dali/public-api/actors/image-actor.h b/dali/public-api/actors/image-actor.h
index 072f3cc..3717007 100644 (file)
--- a/dali/public-api/actors/image-actor.h
+++ b/dali/public-api/actors/image-actor.h
@@ -70,6 +70,7 @@ class DALI_IMPORT_API ImageActor : public Actor
 public:
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief An enumeration of properties belonging to the ImageActor class.
    * Properties additional to RenderableActor.
    * @SINCE_1_0.0
@@ -79,6 +80,7 @@ public:
     enum
     {
       /**
+       * @DEPRECATED_1_1.11
        * @brief name "pixelArea",   type Rect<int>
        * @SINCE_1_0.0
        */
@@ -96,6 +98,7 @@ public:
        */
       BORDER,
       /**
+       * @DEPRECATED_1_1.11
        * @brief name "image",       type Map {"filename":"", "loadPolicy":...}
        * @SINCE_1_0.0
        */
@@ -129,7 +132,12 @@ public:
    */
   enum Style
   {
-    STYLE_QUAD,                 ///< As a simple quad. @SINCE_1_0.0
+    /**
+     * @DEPRECATED_1_1.11
+     * @brief As a simple quad.
+     * @SINCE_1_0.0
+     */
+    STYLE_QUAD,
     /**
      * @DEPRECATED_1_1.11
      * @brief As a nine-patch.
@@ -145,6 +153,7 @@ public:
   };
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Pixel area is relative to the top-left (0,0) of the image.
    * @SINCE_1_0.0
    */
@@ -153,6 +162,7 @@ public:
   static const BlendingMode::Type DEFAULT_BLENDING_MODE; ///< default value is BlendingMode::AUTO
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Create an uninitialized ImageActor handle.
    *
    * This can be initialized with ImageActor::New(...)
@@ -162,6 +172,7 @@ public:
   ImageActor();
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Create an empty image actor object.
    *
    * @SINCE_1_0.0
@@ -170,6 +181,7 @@ public:
   static ImageActor New();
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Create a image actor object.
    *
    * The actor will take the image's natural size unless a custom size
@@ -183,6 +195,7 @@ public:
   static ImageActor New(Image image);
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Create a image actor object.
    *
    * The actor will take the image's natural size unless a custom size
@@ -198,6 +211,7 @@ public:
   static ImageActor New(Image image, PixelArea pixelArea);
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Downcast an Object handle to ImageActor.
    *
    *
@@ -211,6 +225,7 @@ public:
   static ImageActor DownCast( BaseHandle handle );
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Destructor
    *
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
@@ -219,6 +234,7 @@ public:
   ~ImageActor();
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Copy constructor
    *
    * @SINCE_1_0.0
@@ -227,6 +243,7 @@ public:
   ImageActor(const ImageActor& copy);
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Assignment operator
    *
    * @SINCE_1_0.0
@@ -235,7 +252,9 @@ public:
   ImageActor& operator=(const ImageActor& rhs);
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Set the image rendered by the actor.
+   *
    * Set the image rendered by the actor.
    * If actor was already displaying a different image, the old image is dropped and actor may
    * temporarily display nothing. Setting an empty image (handle) causes the current image to be
@@ -250,6 +269,7 @@ public:
   void SetImage(Image image);
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Retrieve the image rendered by the actor.
    *
    * If no image is assigned, an empty handle is returned
@@ -259,6 +279,7 @@ public:
   Image GetImage();
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Set a region of the image to display, in pixels.
    *
    * When the image is loaded the actor's size will be reset to the pixelArea,
@@ -272,6 +293,7 @@ public:
   void SetPixelArea(const PixelArea& pixelArea);
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Retrieve the region of the image to display, in pixels.
    *
    * @SINCE_1_0.0
@@ -330,6 +352,7 @@ public:
 
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Allows modification of an actors position in the depth sort algorithm.
    *
    * The offset can be altered for each coplanar actor hence allowing an order of painting.
@@ -340,6 +363,7 @@ public:
   void SetSortModifier(float depthOffset);
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Retrieves the offset used to modify an actors position in the depth sort algorithm.
    *
    * The offset can be altered for each coplanar actor hence allowing an order of painting.
@@ -350,6 +374,7 @@ public:
   float GetSortModifier() const;
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Sets the blending mode.
    *
    * Possible values are: BlendingMode::OFF, BlendingMode::AUTO and BlendingMode::ON. Default is BlendingMode::AUTO.
@@ -368,6 +393,7 @@ public:
   void SetBlendMode( BlendingMode::Type mode );
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Retrieves the blending mode.
    *
    * @SINCE_1_0.0
@@ -376,6 +402,7 @@ public:
   BlendingMode::Type GetBlendMode() const;
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Specify the pixel arithmetic used when the actor is blended.
    *
    * @SINCE_1_0.0
@@ -392,6 +419,7 @@ public:
   void SetBlendFunc( BlendingFactor::Type srcFactorRgba, BlendingFactor::Type destFactorRgba );
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Specify the pixel arithmetic used when the actor is blended.
    *
    * @SINCE_1_0.0
@@ -415,6 +443,7 @@ public:
                      BlendingFactor::Type srcFactorAlpha, BlendingFactor::Type destFactorAlpha );
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Query the pixel arithmetic used when the actor is blended.
    *
    * @SINCE_1_0.0
@@ -427,6 +456,7 @@ public:
                      BlendingFactor::Type& srcFactorAlpha, BlendingFactor::Type& destFactorAlpha ) const;
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Specify the equation used when the actor is blended.
    *
    * The options are BlendingEquation::ADD, SUBTRACT, or REVERSE_SUBTRACT.
@@ -436,6 +466,7 @@ public:
   void SetBlendEquation( BlendingEquation::Type equationRgba );
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Specify the equation used when the actor is blended.
    *
    * @SINCE_1_0.0
@@ -446,6 +477,7 @@ public:
   void SetBlendEquation( BlendingEquation::Type equationRgb, BlendingEquation::Type equationAlpha );
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Query the equation used when the actor is blended.
    *
    * @SINCE_1_0.0
@@ -455,6 +487,7 @@ public:
   void GetBlendEquation( BlendingEquation::Type& equationRgb, BlendingEquation::Type& equationAlpha ) const;
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Specify the color used when the actor is blended; the default is Vector4::ZERO.
    *
    * @SINCE_1_0.0
@@ -463,6 +496,7 @@ public:
   void SetBlendColor( const Vector4& color );
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Query the color used when the actor is blended.
    *
    * @SINCE_1_0.0
@@ -471,6 +505,7 @@ public:
   const Vector4& GetBlendColor() const;
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Sets the filtering mode.
    *
    * Possible values are: FilterMode::NEAREST and FilterMode::LINEAR. Default is FilterMode::LINEAR.
@@ -487,6 +522,7 @@ public:
   void SetFilterMode( FilterMode::Type minFilter, FilterMode::Type magFilter );
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Retrieves the filtering mode.
    *
    * @SINCE_1_0.0
@@ -496,6 +532,7 @@ public:
   void GetFilterMode( FilterMode::Type& minFilter, FilterMode::Type& magFilter) const;
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Sets the shader effect for the RenderableActor.
    *
    * Shader effects provide special effects like ripple and bend.
@@ -508,6 +545,7 @@ public:
   void SetShaderEffect( ShaderEffect effect );
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Retrieve the custom shader effect for the RenderableActor.
    * If default shader is used an empty handle is returned.
    *
@@ -518,6 +556,7 @@ public:
   ShaderEffect GetShaderEffect() const;
 
   /**
+   * @DEPRECATED_1_1.11
    * @brief Removes the current shader effect.
    *
    * @SINCE_1_0.0
@@ -533,6 +572,7 @@ public: // Not intended for application developers
 
 
 /**
+ * @DEPRECATED_1_1.11
  * @brief Sets the shader effect for all ImageActors in a tree of Actors.
  *
  * @SINCE_1_0.0
@@ -544,6 +584,7 @@ public: // Not intended for application developers
 DALI_IMPORT_API void SetShaderEffectRecursively( Actor actor, ShaderEffect effect );
 
 /**
+ * @DEPRECATED_1_1.11
  * @brief Removes the shader effect from all ImageActors in a tree of Actors.
  *
  * @SINCE_1_0.0

diff --git a/dali/public-api/shader-effects/shader-effect.h b/dali/public-api/shader-effects/shader-effect.h
index ed0d44f..f810db4 100644 (file)
--- a/dali/public-api/shader-effects/shader-effect.h
+++ b/dali/public-api/shader-effects/shader-effect.h
@@ -30,6 +30,7 @@ namespace Dali
  */
 
 /**
+ * @DEPRECATED_1_0.47
  * @brief DALI_COMPOSE_SHADER macro provides a convenient way to write shader source code.
  *
  * We normally use double quotation marks to write a string such as "Hello World".
@@ -116,6 +117,7 @@ public:
 
   // Default Properties
   /**
+   * @DEPRECATED_1_0.47
    * @brief An enumeration of properties belonging to the ShaderEffect class.
    * Grid Density defines the spacing of vertex coordinates in world units.
    * ie a larger actor will have more grids at the same spacing.
@@ -133,31 +135,33 @@ public:
   {
     enum
     {
-      GRID_DENSITY = DEFAULT_ACTOR_PROPERTY_START_INDEX, ///< name "gridDensity",    type float @SINCE_1_0.0
-      IMAGE,                                             ///< name "image",          type Map {"filename":"", "loadPolicy":...} @SINCE_1_0.0
-      PROGRAM,                                           ///< name "program",        type Map {"vertexPrefix":"","fragmentPrefix":"","vertex":"","fragment":""} @SINCE_1_0.0
-      GEOMETRY_HINTS                                     ///< name "geometryHints",  type int (bitfield) values from enum GeometryHints @SINCE_1_0.0
+      GRID_DENSITY = DEFAULT_ACTOR_PROPERTY_START_INDEX, ///< @DEPRECATED_1_0.47 @brief name "gridDensity",    type float @SINCE_1_0.0
+      IMAGE,                                             ///< @DEPRECATED_1_0.47 @brief name "image",          type Map {"filename":"", "loadPolicy":...} @SINCE_1_0.0
+      PROGRAM,                                           ///< @DEPRECATED_1_0.47 @brief name "program",        type Map {"vertexPrefix":"","fragmentPrefix":"","vertex":"","fragment":""} @SINCE_1_0.0
+      GEOMETRY_HINTS                                     ///< @DEPRECATED_1_0.47 @brief name "geometryHints",  type int (bitfield) values from enum GeometryHints @SINCE_1_0.0
     };
   };
 
   static const float DEFAULT_GRID_DENSITY;              ///< The default density is 40 pixels
 
   /**
+   * @DEPRECATED_1_0.47
    * @brief Hints for rendering/subdividing geometry.
    * @SINCE_1_0.0
    */
   enum GeometryHints
   {
-    HINT_NONE           = 0x00,   ///< no hints @SINCE_1_0.0
-    HINT_GRID_X         = 0x01,   ///< Geometry must be subdivided in X @SINCE_1_0.0
-    HINT_GRID_Y         = 0x02,   ///< Geometry must be subdivided in Y @SINCE_1_0.0
-    HINT_GRID           = (HINT_GRID_X | HINT_GRID_Y),
-    HINT_DEPTH_BUFFER   = 0x04,   ///< Needs depth buffering turned on @SINCE_1_0.0
-    HINT_BLENDING       = 0x08,   ///< Notifies the actor to use blending even if it's fully opaque. Needs actor's blending set to BlendingMode::AUTO @SINCE_1_0.0
-    HINT_DOESNT_MODIFY_GEOMETRY = 0x10 ///< Notifies that the vertex shader will not change geometry (enables bounding box culling) @SINCE_1_0.0
+    HINT_NONE           = 0x00,   ///< @DEPRECATED_1_0.47 @brief no hints @SINCE_1_0.0
+    HINT_GRID_X         = 0x01,   ///< @DEPRECATED_1_0.47 @brief Geometry must be subdivided in X @SINCE_1_0.0
+    HINT_GRID_Y         = 0x02,   ///< @DEPRECATED_1_0.47 @brief Geometry must be subdivided in Y @SINCE_1_0.0
+    HINT_GRID           = (HINT_GRID_X | HINT_GRID_Y),  ///< @DEPRECATED_1_0.47 @brief HINT_GRID_X | HINT_GRID_Y @SINCE_1_0.0
+    HINT_DEPTH_BUFFER   = 0x04,   ///< @DEPRECATED_1_0.47 @brief Needs depth buffering turned on @SINCE_1_0.0
+    HINT_BLENDING       = 0x08,   ///< @DEPRECATED_1_0.47 @brief Notifies the actor to use blending even if it's fully opaque. Needs actor's blending set to BlendingMode::AUTO @SINCE_1_0.0
+    HINT_DOESNT_MODIFY_GEOMETRY = 0x10 ///< @DEPRECATED_1_0.47 @brief Notifies that the vertex shader will not change geometry (enables bounding box culling) @SINCE_1_0.0
   };
 
   /**
+   * @DEPRECATED_1_0.47
    * @brief Coordinate type of the shader uniform.
    *
    * Viewport coordinate types will convert from viewport to view space.
@@ -168,12 +172,13 @@ public:
    */
   enum UniformCoordinateType
   {
-    COORDINATE_TYPE_DEFAULT,           ///< @brief Default, No transformation to be applied @SINCE_1_0.0
-    COORDINATE_TYPE_VIEWPORT_POSITION, ///< @DEPRECATED_1_1.11 @brief The uniform is a position vector in viewport coordinates that needs to be converted to GL view space coordinates. @SINCE_1_0.0
-    COORDINATE_TYPE_VIEWPORT_DIRECTION ///< @DEPRECATED_1_1.11 @brief The uniform is a directional vector in viewport coordinates that needs to be converted to GL view space coordinates. @SINCE_1_0.0
+    COORDINATE_TYPE_DEFAULT,           ///< @DEPRECATED_1_0.47 @brief Default, No transformation to be applied @SINCE_1_0.0
+    COORDINATE_TYPE_VIEWPORT_POSITION, ///< @DEPRECATED_1_0.47 @brief The uniform is a position vector in viewport coordinates that needs to be converted to GL view space coordinates. @SINCE_1_0.0
+    COORDINATE_TYPE_VIEWPORT_DIRECTION ///< @DEPRECATED_1_0.47 @brief The uniform is a directional vector in viewport coordinates that needs to be converted to GL view space coordinates. @SINCE_1_0.0
   };
 
   /**
+   * @DEPRECATED_1_0.47
    * @brief Create an empty ShaderEffect.
    *
    * This can be initialised with ShaderEffect::New(...)
@@ -182,6 +187,7 @@ public:
   ShaderEffect();
 
   /**
+   * @DEPRECATED_1_0.47
    * @brief Create ShaderEffect.
    *
    * @SINCE_1_0.0
@@ -195,6 +201,7 @@ public:
                            GeometryHints hints = GeometryHints(HINT_NONE) );
 
   /**
+   * @DEPRECATED_1_0.47
    * @brief Create ShaderEffect.
    * @SINCE_1_0.0
    * @param vertexShaderPrefix code for the effect. It will be inserted before the default uniforms (ideal for \#defines)
@@ -211,6 +218,7 @@ public:
                                     GeometryHints hints = GeometryHints(HINT_NONE) );
 
   /**
+   * @DEPRECATED_1_0.47
    * @brief Downcast an Object handle to ShaderEffect.
    *
    * If handle points to a ShaderEffect the downcast produces valid
@@ -223,6 +231,7 @@ public:
   static ShaderEffect DownCast( BaseHandle handle );
 
   /**
+   * @DEPRECATED_1_0.47
    * @brief Destructor
    *
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
@@ -231,6 +240,7 @@ public:
   ~ShaderEffect();
 
   /**
+   * @DEPRECATED_1_0.47
    * @brief Copy constructor
    *
    * @SINCE_1_0.0
@@ -239,6 +249,7 @@ public:
   ShaderEffect(const ShaderEffect& object);
 
   /**
+   * @DEPRECATED_1_0.47
    * @brief This assignment operator is required for (smart) pointer semantics.
    *
    * @SINCE_1_0.0
@@ -248,6 +259,7 @@ public:
   ShaderEffect& operator=(const ShaderEffect& rhs);
 
   /**
+   * @DEPRECATED_1_0.47
    * @brief Sets image for using as effect texture.
    *
    * This image texture will be bound to the "sEffect" sampler
@@ -259,7 +271,9 @@ public:
   void SetEffectImage( Image image );
 
   /**
+   * @DEPRECATED_1_0.47
    * @brief Set a uniform value.
+   *
    * This will register a property of type Property::FLOAT; see Object::RegisterProperty() for more details.
    * If name matches a uniform in the shader source, this value will be uploaded when rendering.
    * @SINCE_1_0.0
@@ -273,6 +287,7 @@ public:
                    UniformCoordinateType uniformCoordinateType = UniformCoordinateType(COORDINATE_TYPE_DEFAULT) );
 
   /**
+   * @DEPRECATED_1_0.47
    * @brief Set a uniform value.
    *
    * This will register a property of type Property::VECTOR2; see Object::RegisterProperty() for more details.
@@ -288,6 +303,7 @@ public:
                    UniformCoordinateType uniformCoordinateType = UniformCoordinateType(COORDINATE_TYPE_DEFAULT) );
 
   /**
+   * @DEPRECATED_1_0.47
    * @brief Set a uniform value.
    *
    * This will register a property of type Property::VECTOR3; see Object::RegisterProperty() for more details.
@@ -303,6 +319,7 @@ public:
                    UniformCoordinateType uniformCoordinateType = UniformCoordinateType(COORDINATE_TYPE_DEFAULT) );
 
   /**
+   * @DEPRECATED_1_0.47
    * @brief Set a uniform value.
    *
    * This will register a property of type Property::VECTOR4; see Object::RegisterProperty() for more details.
@@ -318,6 +335,7 @@ public:
                    UniformCoordinateType uniformCoordinateType = UniformCoordinateType(COORDINATE_TYPE_DEFAULT) );
 
   /**
+   * @DEPRECATED_1_0.47
    * @brief Set a uniform value.
    *
    * This will register a property of type Property::MATRIX; see Object::RegisterProperty() for more details.
@@ -333,6 +351,7 @@ public:
                    UniformCoordinateType uniformCoordinateType = UniformCoordinateType(COORDINATE_TYPE_DEFAULT) );
 
   /**
+   * @DEPRECATED_1_0.47
    * @brief Set a uniform value.
    *
    * This will register a property of type Property::MATRIX3; see Object::RegisterProperty() for more details.
@@ -350,6 +369,7 @@ public:
 public: // Not intended for application developers
 
   /**
+   * @DEPRECATED_1_0.47
    * @brief This constructor is used by Dali New() methods.
    * @SINCE_1_0.0
    * @param [in] effect A pointer to a newly allocated Dali resource.