Pileus Git - ~andy/gtk/blob - docs/reference/gdk-pixbuf/tmpl/animation.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Animations
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Animations as multi-frame structures.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8   <para>
   9     The GdkPixbuf library provides a simple mechanism to load and
  10     represent animations, primarily animated GIF files.  Animations
  11     are represented as lists of #GdkPixbufFrame structures.  Each
  12     frame structure contains a #GdkPixbuf structure and information
  13     about the frame's overlay mode and duration.
  14   </para>
  15
  16
  17 <!-- ##### SECTION See_Also ##### -->
  18   <para>
  19     #GdkPixbufLoader
  20   </para>
  21
  22
  23 <!-- ##### ENUM GdkPixbufFrameAction ##### -->
  24   <para>
  25     Each animation frame can have several things happen to it when the
  26     next frame is displayed.  The #GdkPixbufFrameAction determines this.
  27     If a frame as marked as @GDK_PIXBUF_FRAME_RETAIN, then the image
  28     will remain displayed, and will be potentially occluded by the next
  29     frame.  If it is marked as @GDK_PIXBUF_FRAME_DISPOSE, then the
  30     animation is reverted to the setting before the frame was shown.  If
  31     it is marked as @GDK_PIXBUF_FRAME_REVERT, then the animation is
  32     reverted to the first image before continuing.
  33   </para>
  34
  35 @GDK_PIXBUF_FRAME_RETAIN:
  36 @GDK_PIXBUF_FRAME_DISPOSE:
  37 @GDK_PIXBUF_FRAME_REVERT:
  38
  39 <!-- ##### STRUCT GdkPixbufFrame ##### -->
  40   <para>
  41     This structure describes a frame in a #GdkPixbufAnimation.  Each
  42     frame consists of a #GdkPixbuf, an offset of the frame within the
  43     animation's bounding box, a duration, and an overlay mode or
  44     action.
  45   </para>
  46
  47 @pixbuf: The frame's image contents.
  48 @x_offset: X offset of the frame inside the animation's bounding box.
  49 @y_offset: Y offset of the frame inside the animation's bounding box.
  50 @delay_time: Duration of the frame in milliseconds.
  51 @action: Overlay mode.
  52
  53 <!-- ##### STRUCT GdkPixbufAnimation ##### -->
  54   <para>
  55     This structure describes an animation, which is represented as a
  56     list of #GdkPixbufFrame structures.
  57   </para>
  58
  59 @ref_count: Reference count.
  60 @n_frames: Number of frames in the animation.
  61 @frames: List of #GdkPixbufFrame structures.
  62
  63 <!-- ##### FUNCTION gdk_pixbuf_animation_new_from_file ##### -->
  64 <para>
  65
  66 </para>
  67
  68 @filename:
  69 @Returns:
  70
  71
  72 <!-- ##### FUNCTION gdk_pixbuf_animation_ref ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @animation:
  78
  79
  80 <!-- ##### FUNCTION gdk_pixbuf_animation_unref ##### -->
  81 <para>
  82
  83 </para>
  84
  85 @animation:
  86
  87
  88 <!--
  89 Local variables:
  90 mode: sgml
  91 sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
  92 End:
  93 -->