animation.sgml 2.9 KB
Newer Older
1 2 3 4 5 6 7 8
<!-- ##### SECTION Title ##### -->
Animations

<!-- ##### SECTION Short_Description ##### -->
Animations as multi-frame structures.

<!-- ##### SECTION Long_Description ##### -->
  <para>
Havoc Pennington's avatar
Havoc Pennington committed
9 10 11 12 13
    The &gdk-pixbuf; library provides a simple mechanism to load and
    represent animations, primarily animated GIF files.  Animations
    are represented as lists of #GdkPixbufFrame structures.  Each
    frame structure contains a #GdkPixbuf structure and information
    about the frame's overlay mode and duration.
14 15 16 17 18 19 20 21 22
  </para>

<!-- ##### SECTION See_Also ##### -->
  <para>
    #GdkPixbufLoader
  </para>

<!-- ##### ENUM GdkPixbufFrameAction ##### -->
  <para>
Jonathan Blandford's avatar
Jonathan Blandford committed
23
    Each animation frame can have several things happen to it when the
24 25 26
    next frame is displayed.  The #GdkPixbufFrameAction determines
    this.  These are essentially the overlay modes supported by GIF
    animations.
27 28
  </para>

29 30 31 32 33 34
@GDK_PIXBUF_FRAME_RETAIN: The previous image should remain displayed,
and will potentially be occluded by the new frame.
@GDK_PIXBUF_FRAME_DISPOSE: The animation will be reverted to the state
before the frame was shown.
@GDK_PIXBUF_FRAME_REVERT: The animation will be reverted to the first
frame.
35 36 37 38 39 40 41 42 43

<!-- ##### STRUCT GdkPixbufFrame ##### -->
  <para>
    This structure describes a frame in a #GdkPixbufAnimation.  Each
    frame consists of a #GdkPixbuf, an offset of the frame within the
    animation's bounding box, a duration, and an overlay mode or
    action.
  </para>

44

45 46 47 48 49 50
<!-- ##### STRUCT GdkPixbufAnimation ##### -->
  <para>
    This structure describes an animation, which is represented as a
    list of #GdkPixbufFrame structures.
  </para>

51

52 53 54 55 56 57
<!-- ##### FUNCTION gdk_pixbuf_animation_new_from_file ##### -->
<para>

</para>

@filename: 
Havoc Pennington's avatar
Havoc Pennington committed
58
@error: 
59 60 61 62 63 64 65 66 67
@Returns: 


<!-- ##### FUNCTION gdk_pixbuf_animation_ref ##### -->
<para>

</para>

@animation: 
68
@Returns: 
69 70 71 72 73 74 75


<!-- ##### FUNCTION gdk_pixbuf_animation_unref ##### -->
<para>

</para>

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 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
@animation: 


<!-- ##### FUNCTION gdk_pixbuf_animation_get_frames ##### -->
<para>

</para>

@animation: 
@Returns: 


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

</para>

@animation: 
@Returns: 


<!-- ##### FUNCTION gdk_pixbuf_animation_get_num_frames ##### -->
<para>

</para>

@animation: 
@Returns: 


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

</para>

@animation: 
@Returns: 


<!-- ##### FUNCTION gdk_pixbuf_frame_get_pixbuf ##### -->
<para>

</para>

@frame: 
@Returns: 


<!-- ##### FUNCTION gdk_pixbuf_frame_get_action ##### -->
<para>

</para>

@frame: 
@Returns: 


<!-- ##### FUNCTION gdk_pixbuf_frame_get_y_offset ##### -->
<para>

</para>

@frame: 
@Returns: 


<!-- ##### FUNCTION gdk_pixbuf_frame_get_delay_time ##### -->
<para>

</para>

@frame: 
@Returns: 


<!-- ##### FUNCTION gdk_pixbuf_frame_get_x_offset ##### -->
<para>

</para>

@frame: 
157
@Returns: <!--
158 159 160 161 162
Local variables:
mode: sgml
sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
End:
-->
163 164