[clutter] docs: Update with the newly added Animatable symbol



commit fe66575a2c0b5d423400b9223d0f2548f64cee10
Author: Emmanuele Bassi <ebassi linux intel com>
Date:   Fri Jul 29 11:48:13 2011 +0100

    docs: Update with the newly added Animatable symbol

 clutter/clutter-animatable.c               |   25 +++++++++++++++++++++++++
 doc/reference/clutter/clutter-sections.txt |    1 +
 2 files changed, 26 insertions(+), 0 deletions(-)
---
diff --git a/clutter/clutter-animatable.c b/clutter/clutter-animatable.c
index f5400e3..413b2eb 100644
--- a/clutter/clutter-animatable.c
+++ b/clutter/clutter-animatable.c
@@ -224,6 +224,31 @@ clutter_animatable_set_final_state (ClutterAnimatable *animatable,
     g_object_set_property (G_OBJECT (animatable), property_name, value);
 }
 
+/**
+ * clutter_animatable_interpolate_value:
+ * @animatable: a #ClutterAnimatable
+ * @property_name: the name of the property to interpolate
+ * @interval: a #ClutterInterval with the animation range
+ * @progress: the progress to use to interpolate between the
+ *   initial and final values of the @interval
+ * @value: (out): return location for an initialized #GValue
+ *   using the same type of the @interval
+ *
+ * Asks a #ClutterAnimatable implementation to interpolate a
+ * a named property between the initial and final values of
+ * a #ClutterInterval, using @progress as the interpolation
+ * value, and store the result inside @value.
+ *
+ * This function should be used for every property animation
+ * involving #ClutterAnimatable<!-- -->s.
+ *
+ * This function replaces clutter_animatable_animate_property().
+ *
+ * Return value: %TRUE if the interpolation was successful,
+ *   and %FALSE otherwise
+ *
+ * Since: 1.8
+ */
 gboolean
 clutter_animatable_interpolate_value (ClutterAnimatable *animatable,
                                       const gchar       *property_name,
diff --git a/doc/reference/clutter/clutter-sections.txt b/doc/reference/clutter/clutter-sections.txt
index 21e4da2..2e6765a 100644
--- a/doc/reference/clutter/clutter-sections.txt
+++ b/doc/reference/clutter/clutter-sections.txt
@@ -1883,6 +1883,7 @@ clutter_animatable_animate_property
 clutter_animatable_find_property
 clutter_animatable_get_initial_state
 clutter_animatable_set_final_state
+clutter_animatable_interpolate_property
 
 <SUBSECTION Standard>
 CLUTTER_TYPE_ANIMATABLE



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]