docs: Effects fixes for the API reference

diff --git a/clutter/clutter-blur-effect.c b/clutter/clutter-blur-effect.c
index 3ec60cc..5dd60a4 100644 (file)
--- a/clutter/clutter-blur-effect.c
+++ b/clutter/clutter-blur-effect.c
@@ -220,7 +220,7 @@ clutter_blur_effect_init (ClutterBlurEffect *self)
  * clutter_blur_effect_new:
  *
  * Creates a new #ClutterBlurEffect to be used with
- * clutter_actor_set_effect()
+ * clutter_actor_add_effect()
  *
  * Return value: the newly created #ClutterBlurEffect or %NULL
  *

diff --git a/clutter/clutter-colorize-effect.c b/clutter/clutter-colorize-effect.c
index b19ea28..e8f202e 100644 (file)
--- a/clutter/clutter-colorize-effect.c
+++ b/clutter/clutter-colorize-effect.c
@@ -23,8 +23,8 @@
  */
 
 /**
- * SECTION:clutter-desaturate-effect
- * @short_description: A desaturation effect
+ * SECTION:clutter-colorize-effect
+ * @short_description: A colorization effect
  * @see_also: #ClutterEffect, #ClutterOffscreenEffect
  *
  * #ClutterColorizeEffect is a sub-class of #ClutterEffect that

diff --git a/clutter/clutter-desaturate-effect.c b/clutter/clutter-desaturate-effect.c
index bfd6ca5..1a65d6f 100644 (file)
--- a/clutter/clutter-desaturate-effect.c
+++ b/clutter/clutter-desaturate-effect.c
@@ -233,7 +233,7 @@ clutter_desaturate_effect_init (ClutterDesaturateEffect *self)
  * @factor: the desaturation factor, between 0.0 and 1.0
  *
  * Creates a new #ClutterDesaturateEffect to be used with
- * clutter_actor_set_effect()
+ * clutter_actor_add_effect()
  *
  * Return value: the newly created #ClutterDesaturateEffect or %NULL
  *

diff --git a/clutter/clutter-effect.c b/clutter/clutter-effect.c
index 6c79458..0dd781b 100644 (file)
--- a/clutter/clutter-effect.c
+++ b/clutter/clutter-effect.c
@@ -43,7 +43,7 @@
  *   <itemizedlist>
  *     <listitem><simpara><function>prepare()</function>, which is called when
  *     attaching the #ClutterEffect to a #ClutterActor through the
- *     clutter_actor_set_effect() function or when the actor is being
+ *     clutter_actor_add_effect() function or when the actor is being
  *     painted;</simpara></listitem>
  *     <listitem><simpara><function>pre_paint()</function>, which is called
  *     before painting the #ClutterActor.</simpara></listitem>

diff --git a/clutter/clutter-effect.h b/clutter/clutter-effect.h
index 8b45f16..5b04be8 100644 (file)
--- a/clutter/clutter-effect.h
+++ b/clutter/clutter-effect.h
@@ -59,7 +59,6 @@ struct _ClutterEffect
 
 /**
  * ClutterEffectClass:
- * @prepare: virtual function
  * @pre_paint: virtual function
  * @post_paint: virtual function
  *

diff --git a/clutter/clutter-shader-effect.c b/clutter/clutter-shader-effect.c
index 0f68151..9006536 100644 (file)
--- a/clutter/clutter-shader-effect.c
+++ b/clutter/clutter-shader-effect.c
@@ -647,8 +647,8 @@ add_uniform:
  * @effect: a #ClutterShaderEffect
  * @name: the name of the uniform to set
  * @gtype: the type of the uniform to set
- * @n_value: the number of values
- * @VarArgs: a list of values
+ * @n_values: the number of values
+ * @Varargs: a list of values
  *
  * Sets a list of values as the payload for the uniform @name inside
  * the shader effect

diff --git a/clutter/clutter-shader-effect.h b/clutter/clutter-shader-effect.h
index 40fa20c..1617eca 100644 (file)
--- a/clutter/clutter-shader-effect.h
+++ b/clutter/clutter-shader-effect.h
@@ -90,7 +90,7 @@ gboolean   clutter_shader_effect_set_shader_source (ClutterShaderEffect *effect,
 void       clutter_shader_effect_set_uniform       (ClutterShaderEffect *effect,
                                                     const gchar         *name,
                                                     GType                gtype,
-                                                    gsize                size,
+                                                    gsize                n_values,
                                                     ...);
 void       clutter_shader_effect_set_uniform_value (ClutterShaderEffect *effect,
                                                     const gchar         *name,

diff --git a/doc/reference/clutter/clutter-docs.xml.in b/doc/reference/clutter/clutter-docs.xml.in
index c915c38..2a6b706 100644 (file)
--- a/doc/reference/clutter/clutter-docs.xml.in
+++ b/doc/reference/clutter/clutter-docs.xml.in
@@ -63,6 +63,7 @@
       <xi:include href="xml/clutter-actor-meta.xml"/>
       <xi:include href="xml/clutter-action.xml"/>
       <xi:include href="xml/clutter-constraint.xml"/>
+      <xi:include href="xml/clutter-effect.xml"/>
     </chapter>
 
     <chapter>
@@ -92,12 +93,19 @@
     </chapter>
 
     <chapter>
-      <title>Actions and Constraints</title>
+      <title>Actions, Constraints and Effects</title>
 
       <xi:include href="xml/clutter-click-action.xml"/>
       <xi:include href="xml/clutter-drag-action.xml"/>
+
       <xi:include href="xml/clutter-bind-constraint.xml"/>
       <xi:include href="xml/clutter-align-constraint.xml"/>
+
+      <xi:include href="xml/clutter-offscreen-effect.xml"/>
+      <xi:include href="xml/clutter-shader-effect.xml"/>
+      <xi:include href="xml/clutter-blur-effect.xml"/>
+      <xi:include href="xml/clutter-colorize-effect.xml"/>
+      <xi:include href="xml/clutter-desaturate-effect.xml"/>
     </chapter>
 
   </part>
@@ -180,17 +188,6 @@
       <xi:include href="xml/clutter-list-model.xml"/>
     </chapter>
 
-    <chapter>
-      <title>Actor Effects</title>
-
-      <xi:include href="xml/clutter-effect.xml"/>
-      <xi:include href="xml/clutter-offscreen-effect.xml"/>
-      <xi:include href="xml/clutter-shader-effect.xml"/>
-
-      <xi:include href="xml/clutter-blur-effect.xml"/>
-      <xi:include href="xml/clutter-colorize-effect.xml"/>
-      <xi:include href="xml/clutter-desaturate-effect.xml"/>
-    </chapter>
   </part>
 
   <part id="clutterbackends">

diff --git a/doc/reference/clutter/clutter-sections.txt b/doc/reference/clutter/clutter-sections.txt
index 160d688..9f1b743 100644 (file)
--- a/doc/reference/clutter/clutter-sections.txt
+++ b/doc/reference/clutter/clutter-sections.txt
@@ -399,8 +399,6 @@ clutter_actor_get_shader
 clutter_actor_set_shader_param
 clutter_actor_set_shader_param_float
 clutter_actor_set_shader_param_int
-clutter_actor_get_effect
-clutter_actor_set_effect
 
 <SUBSECTION>
 clutter_actor_grab_key_focus
@@ -428,6 +426,13 @@ clutter_actor_remove_constraint_by_name
 clutter_actor_get_constraints
 clutter_actor_get_constraint
 clutter_actor_clear_constraints
+clutter_actor_add_effect
+clutter_actor_add_effect_with_name
+clutter_actor_remove_effect
+clutter_actor_remove_effect_by_name
+clutter_actor_get_effects
+clutter_actor_get_effect
+clutter_actor_clear_effects
 
 <SUBSECTION>
 ClutterActorBox
@@ -2316,9 +2321,7 @@ clutter_effect_get_type
 <FILE>clutter-offscreen-effect</FILE>
 ClutterOffscreenEffect
 ClutterOffscreenEffectClass
-clutter_offscreen_effect_get_actor
 clutter_offscreen_effect_get_target
-<SUBSECTION>
 clutter_offscreen_effect_create_target
 clutter_offscreen_effect_paint_target
 <SUBSECTION Standard>
@@ -2341,6 +2344,7 @@ ClutterShaderEffectClass
 clutter_shader_effect_set_uniform
 clutter_shader_effect_set_uniform_value
 <SUBSECTION>
+clutter_shader_effect_set_shader_source
 clutter_shader_effect_get_program
 clutter_shader_effect_get_shader
 <SUBSECTION Standard>