animation.sgml 2.82 KB
Newer Older
1
<!-- ##### SECTION Title ##### -->
2
Animations
3 4

<!-- ##### SECTION Short_Description ##### -->
Havoc Pennington's avatar
Havoc Pennington committed
5
Animated images.
6 7

<!-- ##### SECTION Long_Description ##### -->
8
  <para>
Havoc Pennington's avatar
Havoc Pennington committed
9 10 11 12 13 14 15
    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. 
16
  </para>
17

18
<!-- ##### SECTION See_Also ##### -->
19 20 21
  <para>
    #GdkPixbufLoader
  </para>
22

Matthias Clasen's avatar
Matthias Clasen committed
23 24 25
<!-- ##### SECTION Stability_Level ##### -->


26 27 28
<!-- ##### SECTION Image ##### -->


29
<!-- ##### STRUCT GdkPixbufAnimation ##### -->
Matthias Clasen's avatar
Matthias Clasen committed
30
<para>
31
An opaque struct representing an animation.
Matthias Clasen's avatar
Matthias Clasen committed
32 33 34 35 36
</para>


<!-- ##### STRUCT GdkPixbufAnimationIter ##### -->
<para>
37
An opaque struct representing an iterator which points to a
Matthias Clasen's avatar
Matthias Clasen committed
38
certain position in an animation.
Matthias Clasen's avatar
Matthias Clasen committed
39 40 41
</para>


42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
<!-- ##### FUNCTION gdk_pixbuf_animation_new_from_file ##### -->
<para>

</para>

@filename: 
@error: 
@Returns: 


<!-- ##### FUNCTION gdk_pixbuf_animation_get_width ##### -->
<para>

</para>

@animation: 
@Returns: 


<!-- ##### FUNCTION gdk_pixbuf_animation_get_height ##### -->
<para>

</para>

@animation: 
@Returns: 


70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
<!-- ##### FUNCTION gdk_pixbuf_animation_get_iter ##### -->
<para>

</para>

@animation: 
@start_time: 
@Returns: 


<!-- ##### FUNCTION gdk_pixbuf_animation_is_static_image ##### -->
<para>

</para>

@animation: 
@Returns: 


<!-- ##### FUNCTION gdk_pixbuf_animation_get_static_image ##### -->
<para>

</para>

@animation: 
@Returns: 


<!-- ##### FUNCTION gdk_pixbuf_animation_iter_advance ##### -->
<para>

</para>

@iter: 
@current_time: 
@Returns: 


<!-- ##### FUNCTION gdk_pixbuf_animation_iter_get_delay_time ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gdk_pixbuf_animation_iter_on_currently_loading_frame ##### -->
<para>

</para>

@iter: 
@Returns: 


<!-- ##### FUNCTION gdk_pixbuf_animation_iter_get_pixbuf ##### -->
<para>

</para>

@iter: 
@Returns: 


Matthias Clasen's avatar
Matthias Clasen committed
135 136
<!-- ##### STRUCT GdkPixbufSimpleAnim ##### -->
<para>
137
An opaque struct representing a simple animation.
Matthias Clasen's avatar
Matthias Clasen committed
138 139 140
</para>


Matthias Clasen's avatar
Matthias Clasen committed
141 142 143 144 145
<!-- ##### ARG GdkPixbufSimpleAnim:loop ##### -->
<para>

</para>

Matthias Clasen's avatar
Matthias Clasen committed
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
<!-- ##### FUNCTION gdk_pixbuf_simple_anim_new ##### -->
<para>

</para>

@width: 
@height: 
@rate: 
@Returns: 


<!-- ##### FUNCTION gdk_pixbuf_simple_anim_add_frame ##### -->
<para>

</para>

@animation: 
@pixbuf: 


166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
<!-- ##### FUNCTION gdk_pixbuf_simple_anim_set_loop ##### -->
<para>

</para>

@animation: 
@loop: 


<!-- ##### FUNCTION gdk_pixbuf_simple_anim_get_loop ##### -->
<para>

</para>

@animation: 
@Returns: