]> Pileus Git - ~andy/gtk/blobdiff - docs/reference/gdk-pixbuf/tmpl/animation.sgml
[quartz] Delete the typedef of GdkDevicePrivate
[~andy/gtk] / docs / reference / gdk-pixbuf / tmpl / animation.sgml
index 8253cb491d72ae6bf7e3d3e01715f8b83f154f22..d569f8af950c46f22d3894de27938cf2a199ddd3 100644 (file)
@@ -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>
+    #GdkPixbufLoader
+  </para>
 
-</para>
+<!-- ##### SECTION Stability_Level ##### -->
 
-<!-- ##### ENUM GdkPixbufFrameAction ##### -->
-<para>
 
-</para>
+<!-- ##### SECTION Image ##### -->
 
-@GDK_PIXBUF_FRAME_RETAIN: 
-@GDK_PIXBUF_FRAME_DISPOSE: 
-@GDK_PIXBUF_FRAME_REVERT: 
 
-<!-- ##### STRUCT GdkPixbufFrame ##### -->
+<!-- ##### STRUCT GdkPixbufAnimation ##### -->
 <para>
-
+An opaque struct representing an animation.
 </para>
 
 
-<!-- ##### STRUCT GdkPixbufAnimation ##### -->
+<!-- ##### STRUCT GdkPixbufAnimationIter ##### -->
 <para>
-
+An opaque struct representing an iterator which points to a
+certain position in an animation.
 </para>
 
 
@@ -45,7 +49,7 @@ animation
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_animation_ref ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_get_width ##### -->
 <para>
 
 </para>
@@ -54,24 +58,26 @@ animation
 @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>
@@ -80,7 +86,7 @@ animation
 @Returns: 
 
 
-<!-- ##### FUNCTION gdk_pixbuf_animation_get_num_frames ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_animation_get_static_image ##### -->
 <para>
 
 </para>
@@ -89,57 +95,89 @@ animation
 @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>
+
+@animation: 
+@pixbuf: 
+
+
+<!-- ##### FUNCTION gdk_pixbuf_simple_anim_set_loop ##### -->
+<para>
+
+</para>
+
+@animation: 
+@loop: 
+
+
+<!-- ##### FUNCTION gdk_pixbuf_simple_anim_get_loop ##### -->
 <para>
 
 </para>
 
-@frame
+@animation
 @Returns: