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

   1 <!-- ##### SECTION Title ##### -->
   2 Animations
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Animated images.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8   <para>
   9     The &gdk-pixbuf; library provides a simple mechanism to load and represent
  10     animations. An animation is conceptually a series of frames to be displayed
  11     over time. Each frame is the same size. The animation may not be represented
  12     as a series of frames internally; for example, it may be stored as a
  13     sprite and instructions for moving the sprite around a background. To display
  14     an animation you don't need to understand its representation, however; you just
  15     ask &gdk-pixbuf; what should be displayed at a given point in time.
  16   </para>
  17
  18 <!-- ##### SECTION See_Also ##### -->
  19   <para>
  20     #GdkPixbufLoader
  21   </para>
  22
  23 <!-- ##### SECTION Stability_Level ##### -->
  24
  25
  26 <!-- ##### STRUCT GdkPixbufAnimation ##### -->
  27 <para>
  28 An opaque struct representing an animation.
  29 </para>
  30
  31
  32 <!-- ##### STRUCT GdkPixbufAnimationIter ##### -->
  33 <para>
  34 An opaque struct representing an iterator which points to a
  35 certain position in an animation.
  36 </para>
  37
  38
  39 <!-- ##### FUNCTION gdk_pixbuf_animation_new_from_file ##### -->
  40 <para>
  41
  42 </para>
  43
  44 @filename:
  45 @error:
  46 @Returns:
  47
  48
  49 <!-- ##### FUNCTION gdk_pixbuf_animation_ref ##### -->
  50 <para>
  51
  52 </para>
  53
  54 @animation:
  55 @Returns:
  56
  57
  58 <!-- ##### FUNCTION gdk_pixbuf_animation_unref ##### -->
  59 <para>
  60
  61 </para>
  62
  63 @animation:
  64
  65
  66 <!-- ##### FUNCTION gdk_pixbuf_animation_get_width ##### -->
  67 <para>
  68
  69 </para>
  70
  71 @animation:
  72 @Returns:
  73
  74
  75 <!-- ##### FUNCTION gdk_pixbuf_animation_get_height ##### -->
  76 <para>
  77
  78 </para>
  79
  80 @animation:
  81 @Returns:
  82
  83
  84 <!-- ##### FUNCTION gdk_pixbuf_animation_get_iter ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @animation:
  90 @start_time:
  91 @Returns:
  92
  93
  94 <!-- ##### FUNCTION gdk_pixbuf_animation_is_static_image ##### -->
  95 <para>
  96
  97 </para>
  98
  99 @animation:
 100 @Returns:
 101
 102
 103 <!-- ##### FUNCTION gdk_pixbuf_animation_get_static_image ##### -->
 104 <para>
 105
 106 </para>
 107
 108 @animation:
 109 @Returns:
 110
 111
 112 <!-- ##### FUNCTION gdk_pixbuf_animation_iter_advance ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @iter:
 118 @current_time:
 119 @Returns:
 120
 121
 122 <!-- ##### FUNCTION gdk_pixbuf_animation_iter_get_delay_time ##### -->
 123 <para>
 124
 125 </para>
 126
 127 @iter:
 128 @Returns:
 129
 130
 131 <!-- ##### FUNCTION gdk_pixbuf_animation_iter_on_currently_loading_frame ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @iter:
 137 @Returns:
 138
 139
 140 <!-- ##### FUNCTION gdk_pixbuf_animation_iter_get_pixbuf ##### -->
 141 <para>
 142
 143 </para>
 144
 145 @iter:
 146 @Returns:
 147
 148
 149 <!-- ##### STRUCT GdkPixbufSimpleAnim ##### -->
 150 <para>
 151 An opaque struct representing a simple animation.
 152 </para>
 153
 154
 155 <!-- ##### ARG GdkPixbufSimpleAnim:loop ##### -->
 156 <para>
 157
 158 </para>
 159
 160 <!-- ##### FUNCTION gdk_pixbuf_simple_anim_new ##### -->
 161 <para>
 162
 163 </para>
 164
 165 @width:
 166 @height:
 167 @rate:
 168 @Returns:
 169
 170
 171 <!-- ##### FUNCTION gdk_pixbuf_simple_anim_add_frame ##### -->
 172 <para>
 173
 174 </para>
 175
 176 @animation:
 177 @pixbuf:
 178
 179
 180 <!-- ##### FUNCTION gdk_pixbuf_simple_anim_set_loop ##### -->
 181 <para>
 182
 183 </para>
 184
 185 @animation:
 186 @loop:
 187
 188
 189 <!-- ##### FUNCTION gdk_pixbuf_simple_anim_get_loop ##### -->
 190 <para>
 191
 192 </para>
 193
 194 @animation:
 195 @Returns:
 196
 197