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 <application>gdk-pixbuf</application> library provides a
  10     simple mechanism to load and represent animations, primarily
  11     animated GIF files.  Animations are represented as lists of
  12     #GdkPixbufFrame structures.  Each frame structure contains a
  13     #GdkPixbuf structure and information about the frame's overlay
  14     mode and duration.
  15   </para>
  16
  17 <!-- ##### SECTION See_Also ##### -->
  18   <para>
  19     #GdkPixbufLoader
  20   </para>
  21
  22 <!-- ##### ENUM GdkPixbufFrameAction ##### -->
  23   <para>
  24     Each animation frame can have several things happen to it when the
  25     next frame is displayed.  The #GdkPixbufFrameAction determines
  26     this.  These are essentially the overlay modes supported by GIF
  27     animations.
  28   </para>
  29
  30 @GDK_PIXBUF_FRAME_RETAIN: The previous image should remain displayed,
  31 and will potentially be occluded by the new frame.
  32 @GDK_PIXBUF_FRAME_DISPOSE: The animation will be reverted to the state
  33 before the frame was shown.
  34 @GDK_PIXBUF_FRAME_REVERT: The animation will be reverted to the first
  35 frame.
  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:
  46 @x_offset:
  47 @y_offset:
  48 @delay_time:
  49 @action:
  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 @parent_instance:
  58 @n_frames:
  59 @frames:
  60 @width:
  61 @height:
  62
  63 <!-- ##### STRUCT GdkPixbufAnimationClass ##### -->
  64 <para>
  65
  66 </para>
  67
  68
  69 <!-- ##### FUNCTION gdk_pixbuf_animation_new_from_file ##### -->
  70 <para>
  71
  72 </para>
  73
  74 @filename:
  75 @Returns:
  76
  77
  78 <!-- ##### FUNCTION gdk_pixbuf_animation_ref ##### -->
  79 <para>
  80
  81 </para>
  82
  83 @animation:
  84 @Returns:
  85
  86
  87 <!-- ##### FUNCTION gdk_pixbuf_animation_unref ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @animation:
  93
  94
  95 <!-- ##### FUNCTION gdk_pixbuf_animation_get_frames ##### -->
  96 <para>
  97
  98 </para>
  99
 100 @animation:
 101 @Returns:
 102
 103
 104 <!-- ##### FUNCTION gdk_pixbuf_animation_get_width ##### -->
 105 <para>
 106
 107 </para>
 108
 109 @animation:
 110 @Returns:
 111
 112
 113 <!-- ##### FUNCTION gdk_pixbuf_animation_get_num_frames ##### -->
 114 <para>
 115
 116 </para>
 117
 118 @animation:
 119 @Returns:
 120
 121
 122 <!-- ##### FUNCTION gdk_pixbuf_animation_get_height ##### -->
 123 <para>
 124
 125 </para>
 126
 127 @animation:
 128 @Returns:
 129
 130
 131 <!-- ##### FUNCTION gdk_pixbuf_frame_get_pixbuf ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @frame:
 137 @Returns:
 138
 139
 140 <!-- ##### FUNCTION gdk_pixbuf_frame_get_action ##### -->
 141 <para>
 142
 143 </para>
 144
 145 @frame:
 146 @Returns:
 147
 148
 149 <!-- ##### FUNCTION gdk_pixbuf_frame_get_y_offset ##### -->
 150 <para>
 151
 152 </para>
 153
 154 @frame:
 155 @Returns:
 156
 157
 158 <!-- ##### FUNCTION gdk_pixbuf_frame_get_delay_time ##### -->
 159 <para>
 160
 161 </para>
 162
 163 @frame:
 164 @Returns:
 165
 166
 167 <!-- ##### FUNCTION gdk_pixbuf_frame_get_x_offset ##### -->
 168 <para>
 169
 170 </para>
 171
 172 @frame:
 173 @Returns: <!--
 174 Local variables:
 175 mode: sgml
 176 sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
 177 End:
 178 -->
 179
 180