From f2caafa127a42f5b10454407d52eb6b8bd64876d Mon Sep 17 00:00:00 2001
From: Emmanuele Bassi <ebassi@linux.intel.com>
Date: Wed, 21 Apr 2010 11:30:06 +0100
Subject: [PATCH] docs: Add Effects API to the reference

---
 doc/reference/clutter/clutter-docs.xml.in  |  12 ++++
 doc/reference/clutter/clutter-sections.txt | 105 +++++++++++++++++++++++++++++
 doc/reference/clutter/clutter.types        |   6 ++
 3 files changed, 123 insertions(+)

diff --git a/doc/reference/clutter/clutter-docs.xml.in b/doc/reference/clutter/clutter-docs.xml.in
index 1795da1..c915c38 100644
--- a/doc/reference/clutter/clutter-docs.xml.in
+++ b/doc/reference/clutter/clutter-docs.xml.in
@@ -179,6 +179,18 @@
       <xi:include href="xml/clutter-model-iter.xml"/>
       <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 db110c9..160d688 100644
--- a/doc/reference/clutter/clutter-sections.txt
+++ b/doc/reference/clutter/clutter-sections.txt
@@ -399,6 +399,8 @@ 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
@@ -2292,3 +2294,106 @@ clutter_click_action_get_type
 <SUBSECTION Private>
 ClutterClickActionPrivate
 </SECTION>
+
+<SECTION>
+<TITLE>ClutterEffect</TITLE>
+<FILE>clutter-effect</FILE>
+ClutterEffect
+ClutterEffectClass
+<SUBSECTION Standard>
+CLUTTER_TYPE_EFFECT
+CLUTTER_EFFECT
+CLUTTER_EFFECT_CLASS
+CLUTTER_IS_EFFECT
+CLUTTER_IS_EFFECT_CLASS
+CLUTTER_EFFECT_GET_CLASS
+<SUBSECTION Private>
+clutter_effect_get_type
+</SECTION>
+
+<SECTION>
+<TITLE>ClutterOffscreenEffect</TITLE>
+<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>
+CLUTTER_TYPE_OFFSCREEN_EFFECT
+CLUTTER_OFFSCREEN_EFFECT
+CLUTTER_OFFSCREEN_EFFECT_CLASS
+CLUTTER_IS_OFFSCREEN_EFFECT
+CLUTTER_IS_OFFSCREEN_EFFECT_CLASS
+CLUTTER_OFFSCREEN_EFFECT_GET_CLASS
+<SUBSECTION Private>
+ClutterOffscreenEffectPrivate
+clutter_offscreen_effect_get_type
+</SECTION>
+
+<SECTION>
+<TITLE>ClutterShaderEffect</TITLE>
+<FILE>clutter-shader-effect</FILE>
+ClutterShaderEffect
+ClutterShaderEffectClass
+clutter_shader_effect_set_uniform
+clutter_shader_effect_set_uniform_value
+<SUBSECTION>
+clutter_shader_effect_get_program
+clutter_shader_effect_get_shader
+<SUBSECTION Standard>
+CLUTTER_TYPE_SHADER_EFFECT
+CLUTTER_SHADER_EFFECT
+CLUTTER_SHADER_EFFECT_CLASS
+CLUTTER_IS_SHADER_EFFECT
+CLUTTER_IS_SHADER_EFFECT_CLASS
+CLUTTER_SHADER_EFFECT_GET_CLASS
+<SUBSECTION Private>
+ClutterShaderEffectPrivate
+clutter_shader_effect_get_type
+</SECTION>
+
+<SECTION>
+<TITLE>ClutterBlurEffect</TITLE>
+<FILE>clutter-blur-effect</FILE>
+ClutterBlurEffect
+clutter_blur_effect_new
+<SUBSECTION Standard>
+CLUTTER_TYPE_BLUR_EFFECT
+CLUTTER_BLUR_EFFECT
+CLUTTER_IS_BLUR_EFFECT
+<SUBSECTION Private>
+clutter_blur_effect_get_type
+</SECTION>
+
+<SECTION>
+<TITLE>ClutterColorizeEffect</TITLE>
+<FILE>clutter-colorize-effect</FILE>
+ClutterColorizeEffect
+clutter_colorize_effect_new
+clutter_colorize_effect_set_tint
+clutter_colorize_effect_get_tint
+<SUBSECTION Standard>
+CLUTTER_TYPE_COLORIZE_EFFECT
+CLUTTER_COLORIZE_EFFECT
+CLUTTER_IS_COLORIZE_EFFECT
+<SUBSECTION Private>
+clutter_colorize_effect_get_type
+</SECTION>
+
+<SECTION>
+<TITLE>ClutterDesaturateEffect</TITLE>
+<FILE>clutter-desaturate-effect</FILE>
+ClutterDesaturateEffect
+clutter_desaturate_effect_new
+clutter_desaturate_effect_set_factor
+clutter_desaturate_effect_get_factor
+<SUBSECTION Standard>
+CLUTTER_TYPE_DESATURATE_EFFECT
+CLUTTER_DESATURATE_EFFECT
+CLUTTER_IS_DESATURATE_EFFECT
+<SUBSECTION Private>
+clutter_desaturate_effect_get_type
+</SECTION>
diff --git a/doc/reference/clutter/clutter.types b/doc/reference/clutter/clutter.types
index 5841ab3..517b72f 100644
--- a/doc/reference/clutter/clutter.types
+++ b/doc/reference/clutter/clutter.types
@@ -18,15 +18,19 @@ clutter_behaviour_scale_get_type
 clutter_bind_constraint_get_type
 clutter_binding_pool_get_type
 clutter_bin_layout_get_type
+clutter_blur_effect_get_type
 clutter_box_get_type
 clutter_box_layout_get_type
 clutter_cairo_texture_get_type
 clutter_child_meta_get_type
 clutter_click_action_get_type
 clutter_clone_get_type
+clutter_colorize_effect_get_type
 clutter_constraint_get_type
+clutter_desaturate_effect_get_type
 clutter_device_manager_get_type
 clutter_drag_action_get_type
+clutter_effect_get_type
 clutter_fixed_layout_get_type
 clutter_flow_layout_get_type
 clutter_group_get_type
@@ -38,12 +42,14 @@ clutter_list_model_get_type
 clutter_media_get_type
 clutter_model_get_type
 clutter_model_iter_get_type
+clutter_offscreen_effect_get_type
 clutter_path_get_type
 clutter_rectangle_get_type
 clutter_score_get_type
 clutter_scriptable_get_type
 clutter_script_get_type
 clutter_shader_get_type
+clutter_shader_effect_get_type
 clutter_stage_get_type
 clutter_stage_manager_get_type
 clutter_state_get_type
-- 
2.7.4