From 23084b9768ee10502ef01f0c34ae7f2c64888c2b Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Thu, 3 Jun 2010 14:34:41 +0100 Subject: [PATCH] docs: Effects fixes for the API reference --- clutter/clutter-blur-effect.c | 2 +- clutter/clutter-colorize-effect.c | 4 ++-- clutter/clutter-desaturate-effect.c | 2 +- clutter/clutter-effect.c | 2 +- clutter/clutter-effect.h | 1 - clutter/clutter-shader-effect.c | 4 ++-- clutter/clutter-shader-effect.h | 2 +- doc/reference/clutter/clutter-docs.xml.in | 21 +++++++++------------ doc/reference/clutter/clutter-sections.txt | 12 ++++++++---- 9 files changed, 25 insertions(+), 25 deletions(-) diff --git a/clutter/clutter-blur-effect.c b/clutter/clutter-blur-effect.c index 3ec60cc3f..5dd60a442 100644 --- 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 b19ea2876..e8f202eb2 100644 --- 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 bfd6ca54b..1a65d6f08 100644 --- 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 6c79458e9..0dd781b97 100644 --- a/clutter/clutter-effect.c +++ b/clutter/clutter-effect.c @@ -43,7 +43,7 @@ * * prepare(), 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; * pre_paint(), which is called * before painting the #ClutterActor. diff --git a/clutter/clutter-effect.h b/clutter/clutter-effect.h index 8b45f164b..5b04be808 100644 --- 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 0f68151a1..900653658 100644 --- 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 40fa20c33..1617ecadb 100644 --- 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 c915c38f7..2a6b7065b 100644 --- a/doc/reference/clutter/clutter-docs.xml.in +++ b/doc/reference/clutter/clutter-docs.xml.in @@ -63,6 +63,7 @@ + @@ -92,12 +93,19 @@ - Actions and Constraints + Actions, Constraints and Effects + + + + + + + @@ -180,17 +188,6 @@ - - Actor Effects - - - - - - - - - diff --git a/doc/reference/clutter/clutter-sections.txt b/doc/reference/clutter/clutter-sections.txt index 160d68891..9f1b7436f 100644 --- 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 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 ClutterActorBox @@ -2316,9 +2321,7 @@ clutter_effect_get_type clutter-offscreen-effect ClutterOffscreenEffect ClutterOffscreenEffectClass -clutter_offscreen_effect_get_actor clutter_offscreen_effect_get_target - clutter_offscreen_effect_create_target clutter_offscreen_effect_paint_target @@ -2341,6 +2344,7 @@ ClutterShaderEffectClass clutter_shader_effect_set_uniform clutter_shader_effect_set_uniform_value +clutter_shader_effect_set_shader_source clutter_shader_effect_get_program clutter_shader_effect_get_shader