massize rewrite. Static models now totally work. I'm not 100% sure about

[~andy/gtk] / docs / reference / gdk-pixbuf / tmpl / animation.sgml

diff --git a/docs/reference/gdk-pixbuf/tmpl/animation.sgml b/docs/reference/gdk-pixbuf/tmpl/animation.sgml
index 8253cb491d72ae6bf7e3d3e01715f8b83f154f22..00ed351718dfd6ad1fc9f827e9c32a221cc03370 100644 (file)
--- a/docs/reference/gdk-pixbuf/tmpl/animation.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/animation.sgml
@@ -1,37 +1,41 @@
 <!-- ##### SECTION Title ##### -->
-animation
+Animations
 
 <!-- ##### SECTION Short_Description ##### -->
-
+Animated images.
 
 <!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
+  <para>
+    The &gdk-pixbuf; library provides a simple mechanism to load and represent
+    animations. An animation is conceptually a series of frames to be displayed
+    over time. Each frame is the same size. The animation may not be represented
+    as a series of frames internally; for example, it may be stored as a 
+    sprite and instructions for moving the sprite around a background. To display 
+    an animation you don't need to understand its representation, however; you just
+    ask &gdk-pixbuf; what should be displayed at a given point in time. 
+  </para>
 
 <!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### ENUM GdkPixbufFrameAction ##### -->
-<para>
-
-</para>
-
-@GDK_PIXBUF_FRAME_RETAIN: 
-@GDK_PIXBUF_FRAME_DISPOSE: 
-@GDK_PIXBUF_FRAME_REVERT: 
+  <para>
+    #GdkPixbufLoader
+  </para>
 
 <!-- ##### STRUCT GdkPixbufFrame ##### -->
 <para>
-
+ This object describes an individual frame of an animation.
 </para>
 
 
 <!-- ##### STRUCT GdkPixbufAnimation ##### -->
-<para>
+  <para>
+    This object describes an animation.
+  </para>
 
+
+<!-- ##### STRUCT GdkPixbufAnimationIter ##### -->
+<para>
+A #GdkPixbufAnimationIter provides the necessary functionality to
+display an animation. See gdk_pixbuf_animation_get_iter().
 </para>
 
 
@@ -62,7 +66,7 @@ animation
 @animation: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_animation_get_frames ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_get_width ##### -->
 <para>
 
 </para>
@@ -71,7 +75,7 @@ animation
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_animation_get_width ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_get_height ##### -->
 <para>
 
 </para>
@@ -80,16 +84,17 @@ animation
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_animation_get_num_frames ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_get_iter ##### -->
 <para>
 
 </para>
 
 @animation: 
+@start_time: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_animation_get_height ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_is_static_image ##### -->
 <para>
 
 </para>
@@ -98,48 +103,49 @@ animation
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_pixbuf ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_get_static_image ##### -->
 <para>
 
 </para>
 
-@frame: 
+@animation: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_action ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_iter_advance ##### -->
 <para>
 
 </para>
 
-@frame: 
+@iter: 
+@current_time: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_y_offset ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_iter_get_delay_time ##### -->
 <para>
 
 </para>
 
-@frame: 
+@iter: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_delay_time ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_iter_on_currently_loading_frame ##### -->
 <para>
 
 </para>
 
-@frame: 
+@iter: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_x_offset ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_iter_get_pixbuf ##### -->
 <para>
 
 </para>
 
-@frame: 
+@iter: 
 @Returns: