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