[quartz] Delete the typedef of GdkDevicePrivate

[~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 c8bff9b017cfc6fb46c4595234dcd7a9630173fc..d569f8af950c46f22d3894de27938cf2a199ddd3 100644 (file)
--- a/docs/reference/gdk-pixbuf/tmpl/animation.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/animation.sgml
@@ -2,15 +2,17 @@
 Animations
 
 <!-- ##### SECTION Short_Description ##### -->
-Animations as multi-frame structures.
+Animated images.
 
 <!-- ##### SECTION Long_Description ##### -->
   <para>
-    The &gdk-pixbuf; library provides a simple mechanism to load and
-    represent animations, primarily animated GIF files.  Animations
-    are represented as lists of #GdkPixbufFrame structures.  Each
-    frame structure contains a #GdkPixbuf structure and information
-    about the frame's overlay mode and duration.
+    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 ##### -->
@@ -18,35 +20,23 @@ Animations as multi-frame structures.
     #GdkPixbufLoader
   </para>
 
-<!-- ##### ENUM GdkPixbufFrameAction ##### -->
-  <para>
-    Each animation frame can have several things happen to it when the
-    next frame is displayed.  The #GdkPixbufFrameAction determines
-    this.  These are essentially the overlay modes supported by GIF
-    animations.
-  </para>
+<!-- ##### SECTION Stability_Level ##### -->
 
-@GDK_PIXBUF_FRAME_RETAIN: The previous image should remain displayed,
-and will potentially be occluded by the new frame.
-@GDK_PIXBUF_FRAME_DISPOSE: The animation will be reverted to the state
-before the frame was shown.
-@GDK_PIXBUF_FRAME_REVERT: The animation will be reverted to the first
-frame.
 
-<!-- ##### STRUCT GdkPixbufFrame ##### -->
-  <para>
-    This structure describes a frame in a #GdkPixbufAnimation.  Each
-    frame consists of a #GdkPixbuf, an offset of the frame within the
-    animation's bounding box, a duration, and an overlay mode or
-    action.
-  </para>
+<!-- ##### SECTION Image ##### -->
 
 
 <!-- ##### STRUCT GdkPixbufAnimation ##### -->
-  <para>
-    This structure describes an animation, which is represented as a
-    list of #GdkPixbufFrame structures.
-  </para>
+<para>
+An opaque struct representing an animation.
+</para>
+
+
+<!-- ##### STRUCT GdkPixbufAnimationIter ##### -->
+<para>
+An opaque struct representing an iterator which points to a
+certain position in an animation.
+</para>
 
 
 <!-- ##### FUNCTION gdk_pixbuf_animation_new_from_file ##### -->
@@ -59,7 +49,7 @@ frame.
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_animation_ref ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_get_width ##### -->
 <para>
 
 </para>
@@ -68,24 +58,26 @@ frame.
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_animation_unref ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_get_height ##### -->
 <para>
 
 </para>
 
 @animation: 
+@Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_animation_get_frames ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_get_iter ##### -->
 <para>
 
 </para>
 
 @animation: 
+@start_time: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_animation_get_width ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_is_static_image ##### -->
 <para>
 
 </para>
@@ -94,7 +86,7 @@ frame.
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_animation_get_num_frames ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_get_static_image ##### -->
 <para>
 
 </para>
@@ -103,62 +95,89 @@ frame.
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_animation_get_height ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_iter_advance ##### -->
 <para>
 
 </para>
 
-@animation: 
+@iter: 
+@current_time: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_pixbuf ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_iter_get_delay_time ##### -->
 <para>
 
 </para>
 
-@frame: 
+@iter: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_action ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_iter_on_currently_loading_frame ##### -->
 <para>
 
 </para>
 
-@frame: 
+@iter: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_y_offset ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_iter_get_pixbuf ##### -->
 <para>
 
 </para>
 
-@frame: 
+@iter: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_delay_time ##### -->
+<!-- ##### STRUCT GdkPixbufSimpleAnim ##### -->
+<para>
+An opaque struct representing a simple animation.
+</para>
+
+
+<!-- ##### ARG GdkPixbufSimpleAnim:loop ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION gdk_pixbuf_simple_anim_new ##### -->
 <para>
 
 </para>
 
-@frame: 
+@width: 
+@height: 
+@rate: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_x_offset ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_simple_anim_add_frame ##### -->
 <para>
 
 </para>
 
-@frame: 
-@Returns: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
+@animation: 
+@pixbuf: 
+
+
+<!-- ##### FUNCTION gdk_pixbuf_simple_anim_set_loop ##### -->
+<para>
+
+</para>
+
+@animation: 
+@loop: 
+
+
+<!-- ##### FUNCTION gdk_pixbuf_simple_anim_get_loop ##### -->
+<para>
+
+</para>
+
+@animation: 
+@Returns: