diff options
Diffstat (limited to 'gtk+-mingw/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-Animations.html')
| -rw-r--r-- | gtk+-mingw/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-Animations.html | 696 |
1 files changed, 0 insertions, 696 deletions
diff --git a/gtk+-mingw/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-Animations.html b/gtk+-mingw/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-Animations.html deleted file mode 100644 index 7619920..0000000 --- a/gtk+-mingw/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-Animations.html +++ /dev/null @@ -1,696 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Animations</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.77.1"> -<link rel="home" href="index.html" title="GDK-PixBuf Reference Manual"> -<link rel="up" href="rn01.html" title="API Reference"> -<link rel="prev" href="gdk-pixbuf-Utilities.html" title="Utilities"> -<link rel="next" href="GdkPixbufLoader.html" title="GdkPixbufLoader"> -<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)"> -<link rel="stylesheet" href="style.css" type="text/css"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> -<tr valign="middle"> -<td><a accesskey="p" href="gdk-pixbuf-Utilities.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="rn01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> -<th width="100%" align="center">GDK-PixBuf Reference Manual</th> -<td><a accesskey="n" href="GdkPixbufLoader.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#gdk-pixbuf-Animations.synopsis" class="shortcut">Top</a> - | - <a href="#gdk-pixbuf-Animations.description" class="shortcut">Description</a> - | - <a href="#gdk-pixbuf-Animations.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#gdk-pixbuf-Animations.properties" class="shortcut">Properties</a> -</td></tr> -</table> -<div class="refentry"> -<a name="gdk-pixbuf-Animations"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="gdk-pixbuf-Animations.top_of_page"></a>Animations</span></h2> -<p>Animations — Animated images.</p> -</td> -<td valign="top" align="right"></td> -</tr></table></div> -<div class="refsynopsisdiv"> -<a name="gdk-pixbuf-Animations.synopsis"></a><h2>Synopsis</h2> -<a name="GdkPixbufAnimation"></a><a name="GdkPixbufAnimationIter"></a><a name="GdkPixbufSimpleAnim"></a><pre class="synopsis"> -#include <gdk-pixbuf/gdk-pixbuf.h> - -struct <a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation-struct" title="struct GdkPixbufAnimation">GdkPixbufAnimation</a>; -struct <a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimationIter-struct" title="struct GdkPixbufAnimationIter">GdkPixbufAnimationIter</a>; -<a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="returnvalue">GdkPixbufAnimation</span></a> * <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-new-from-file" title="gdk_pixbuf_animation_new_from_file ()">gdk_pixbuf_animation_new_from_file</a> (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>); -<a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="returnvalue">GdkPixbufAnimation</span></a> * <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-ref" title="gdk_pixbuf_animation_ref ()">gdk_pixbuf_animation_ref</a> (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="type">GdkPixbufAnimation</span></a> *animation</code></em>); -<span class="returnvalue">void</span> <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-unref" title="gdk_pixbuf_animation_unref ()">gdk_pixbuf_animation_unref</a> (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="type">GdkPixbufAnimation</span></a> *animation</code></em>); -<span class="returnvalue">int</span> <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-get-width" title="gdk_pixbuf_animation_get_width ()">gdk_pixbuf_animation_get_width</a> (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="type">GdkPixbufAnimation</span></a> *animation</code></em>); -<span class="returnvalue">int</span> <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-get-height" title="gdk_pixbuf_animation_get_height ()">gdk_pixbuf_animation_get_height</a> (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="type">GdkPixbufAnimation</span></a> *animation</code></em>); -<a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimationIter"><span class="returnvalue">GdkPixbufAnimationIter</span></a> * <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-get-iter" title="gdk_pixbuf_animation_get_iter ()">gdk_pixbuf_animation_get_iter</a> (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="type">GdkPixbufAnimation</span></a> *animation</code></em>, - <em class="parameter"><code>const <span class="type">GTimeVal</span> *start_time</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-is-static-image" title="gdk_pixbuf_animation_is_static_image ()">gdk_pixbuf_animation_is_static_image</a> - (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="type">GdkPixbufAnimation</span></a> *animation</code></em>); -<a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-get-static-image" title="gdk_pixbuf_animation_get_static_image ()">gdk_pixbuf_animation_get_static_image</a> - (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="type">GdkPixbufAnimation</span></a> *animation</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-iter-advance" title="gdk_pixbuf_animation_iter_advance ()">gdk_pixbuf_animation_iter_advance</a> (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimationIter"><span class="type">GdkPixbufAnimationIter</span></a> *iter</code></em>, - <em class="parameter"><code>const <span class="type">GTimeVal</span> *current_time</code></em>); -<span class="returnvalue">int</span> <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-iter-get-delay-time" title="gdk_pixbuf_animation_iter_get_delay_time ()">gdk_pixbuf_animation_iter_get_delay_time</a> - (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimationIter"><span class="type">GdkPixbufAnimationIter</span></a> *iter</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-iter-on-currently-loading-frame" title="gdk_pixbuf_animation_iter_on_currently_loading_frame ()">gdk_pixbuf_animation_iter_on_currently_loading_frame</a> - (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimationIter"><span class="type">GdkPixbufAnimationIter</span></a> *iter</code></em>); -<a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-iter-get-pixbuf" title="gdk_pixbuf_animation_iter_get_pixbuf ()">gdk_pixbuf_animation_iter_get_pixbuf</a> - (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimationIter"><span class="type">GdkPixbufAnimationIter</span></a> *iter</code></em>); - - <a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufSimpleAnim-struct" title="GdkPixbufSimpleAnim">GdkPixbufSimpleAnim</a>; -<a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufSimpleAnim"><span class="returnvalue">GdkPixbufSimpleAnim</span></a> * <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-simple-anim-new" title="gdk_pixbuf_simple_anim_new ()">gdk_pixbuf_simple_anim_new</a> (<em class="parameter"><code><span class="type">gint</span> width</code></em>, - <em class="parameter"><code><span class="type">gint</span> height</code></em>, - <em class="parameter"><code><span class="type">gfloat</span> rate</code></em>); -<span class="returnvalue">void</span> <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-simple-anim-add-frame" title="gdk_pixbuf_simple_anim_add_frame ()">gdk_pixbuf_simple_anim_add_frame</a> (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufSimpleAnim"><span class="type">GdkPixbufSimpleAnim</span></a> *animation</code></em>, - <em class="parameter"><code><a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>); -<span class="returnvalue">void</span> <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-simple-anim-set-loop" title="gdk_pixbuf_simple_anim_set_loop ()">gdk_pixbuf_simple_anim_set_loop</a> (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufSimpleAnim"><span class="type">GdkPixbufSimpleAnim</span></a> *animation</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> loop</code></em>); -<span class="returnvalue">gboolean</span> <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-simple-anim-get-loop" title="gdk_pixbuf_simple_anim_get_loop ()">gdk_pixbuf_simple_anim_get_loop</a> (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufSimpleAnim"><span class="type">GdkPixbufSimpleAnim</span></a> *animation</code></em>); -</pre> -</div> -<div class="refsect1"> -<a name="gdk-pixbuf-Animations.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="synopsis"> - GObject - +----GdkPixbufAnimation - +----<a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufSimpleAnim">GdkPixbufSimpleAnim</a> -</pre> -<pre class="synopsis"> - GObject - +----GdkPixbufAnimationIter -</pre> -<pre class="synopsis"> - GObject - +----<a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation">GdkPixbufAnimation</a> - +----GdkPixbufSimpleAnim -</pre> -</div> -<div class="refsect1"> -<a name="gdk-pixbuf-Animations.properties"></a><h2>Properties</h2> -<pre class="synopsis"> - "<a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufSimpleAnim--loop" title='The "loop" property'>loop</a>" <span class="type">gboolean</span> : Read / Write -</pre> -</div> -<div class="refsect1"> -<a name="gdk-pixbuf-Animations.description"></a><h2>Description</h2> -<p> -The GdkPixBuf library provides a simple mechanism to load and -represent animations. An animation is conceptually a series of -frames to be displayed over time. 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 GdkPixBuf what should -be displayed at a given point in time. -</p> -</div> -<div class="refsect1"> -<a name="gdk-pixbuf-Animations.details"></a><h2>Details</h2> -<div class="refsect2"> -<a name="GdkPixbufAnimation-struct"></a><h3>struct GdkPixbufAnimation</h3> -<pre class="programlisting">struct GdkPixbufAnimation;</pre> -<p> -An opaque struct representing an animation. -</p> -</div> -<hr> -<div class="refsect2"> -<a name="GdkPixbufAnimationIter-struct"></a><h3>struct GdkPixbufAnimationIter</h3> -<pre class="programlisting">struct GdkPixbufAnimationIter;</pre> -<p> -An opaque struct representing an iterator which points to a -certain position in an animation. -</p> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-animation-new-from-file"></a><h3>gdk_pixbuf_animation_new_from_file ()</h3> -<pre class="programlisting"><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="returnvalue">GdkPixbufAnimation</span></a> * gdk_pixbuf_animation_new_from_file (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p> -Creates a new animation by loading it from a file. The file format is -detected automatically. If the file's format does not support multi-frame -images, then an animation with a single frame will be created. Possible errors -are in the <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GDK-PIXBUF-ERROR:CAPS" title="GDK_PIXBUF_ERROR"><span class="type">GDK_PIXBUF_ERROR</span></a> and <span class="type">G_FILE_ERROR</span> domains. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td> -<td>Name of file to load, in the GLib file name encoding</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> -<td>return location for error</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A newly-created animation with a reference count of 1, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> -if any of several error conditions ocurred: the file could not be opened, -there was no loader for the file's format, there was not enough memory to -allocate the image buffer, or the image file contained invalid data.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-animation-ref"></a><h3>gdk_pixbuf_animation_ref ()</h3> -<pre class="programlisting"><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="returnvalue">GdkPixbufAnimation</span></a> * gdk_pixbuf_animation_ref (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="type">GdkPixbufAnimation</span></a> *animation</code></em>);</pre> -<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"> -<h3 class="title">Warning</h3> -<p><code class="literal">gdk_pixbuf_animation_ref</code> has been deprecated since version 2.0 and should not be used in newly-written code. Use <code class="function">g_object_ref()</code>.</p> -</div> -<p> -Adds a reference to an animation. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>animation</code></em> :</span></p></td> -<td>An animation.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>The same as the <em class="parameter"><code>animation</code></em> argument.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-animation-unref"></a><h3>gdk_pixbuf_animation_unref ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> gdk_pixbuf_animation_unref (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="type">GdkPixbufAnimation</span></a> *animation</code></em>);</pre> -<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"> -<h3 class="title">Warning</h3> -<p><code class="literal">gdk_pixbuf_animation_unref</code> has been deprecated since version 2.0 and should not be used in newly-written code. Use <code class="function">g_object_unref()</code>.</p> -</div> -<p> -Removes a reference from an animation. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody><tr> -<td><p><span class="term"><em class="parameter"><code>animation</code></em> :</span></p></td> -<td>An animation.</td> -</tr></tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-animation-get-width"></a><h3>gdk_pixbuf_animation_get_width ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> gdk_pixbuf_animation_get_width (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="type">GdkPixbufAnimation</span></a> *animation</code></em>);</pre> -<p> -Queries the width of the bounding box of a pixbuf animation. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>animation</code></em> :</span></p></td> -<td>An animation.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>Width of the bounding box of the animation.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-animation-get-height"></a><h3>gdk_pixbuf_animation_get_height ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> gdk_pixbuf_animation_get_height (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="type">GdkPixbufAnimation</span></a> *animation</code></em>);</pre> -<p> -Queries the height of the bounding box of a pixbuf animation. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>animation</code></em> :</span></p></td> -<td>An animation.</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>Height of the bounding box of the animation.</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-animation-get-iter"></a><h3>gdk_pixbuf_animation_get_iter ()</h3> -<pre class="programlisting"><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimationIter"><span class="returnvalue">GdkPixbufAnimationIter</span></a> * gdk_pixbuf_animation_get_iter (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="type">GdkPixbufAnimation</span></a> *animation</code></em>, - <em class="parameter"><code>const <span class="type">GTimeVal</span> *start_time</code></em>);</pre> -<p> -Get an iterator for displaying an animation. The iterator provides -the frames that should be displayed at a given time. -It should be freed after use with <code class="function">g_object_unref()</code>. -</p> -<p> -<em class="parameter"><code>start_time</code></em> would normally come from <code class="function">g_get_current_time()</code>, and -marks the beginning of animation playback. After creating an -iterator, you should immediately display the pixbuf returned by -<a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-iter-get-pixbuf" title="gdk_pixbuf_animation_iter_get_pixbuf ()"><code class="function">gdk_pixbuf_animation_iter_get_pixbuf()</code></a>. Then, you should install a -timeout (with <code class="function">g_timeout_add()</code>) or by some other mechanism ensure -that you'll update the image after -<a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-iter-get-delay-time" title="gdk_pixbuf_animation_iter_get_delay_time ()"><code class="function">gdk_pixbuf_animation_iter_get_delay_time()</code></a> milliseconds. Each time -the image is updated, you should reinstall the timeout with the new, -possibly-changed delay time. -</p> -<p> -As a shortcut, if <em class="parameter"><code>start_time</code></em> is <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, the result of -<code class="function">g_get_current_time()</code> will be used automatically. -</p> -<p> -To update the image (i.e. possibly change the result of -<a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-iter-get-pixbuf" title="gdk_pixbuf_animation_iter_get_pixbuf ()"><code class="function">gdk_pixbuf_animation_iter_get_pixbuf()</code></a> to a new frame of the animation), -call <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-iter-advance" title="gdk_pixbuf_animation_iter_advance ()"><code class="function">gdk_pixbuf_animation_iter_advance()</code></a>. -</p> -<p> -If you're using <a class="link" href="GdkPixbufLoader.html" title="GdkPixbufLoader"><span class="type">GdkPixbufLoader</span></a>, in addition to updating the image -after the delay time, you should also update it whenever you -receive the area_updated signal and -<a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-iter-on-currently-loading-frame" title="gdk_pixbuf_animation_iter_on_currently_loading_frame ()"><code class="function">gdk_pixbuf_animation_iter_on_currently_loading_frame()</code></a> returns -<code class="literal">TRUE</code>. In this case, the frame currently being fed into the loader -has received new data, so needs to be refreshed. The delay time for -a frame may also be modified after an area_updated signal, for -example if the delay time for a frame is encoded in the data after -the frame itself. So your timeout should be reinstalled after any -area_updated signal. -</p> -<p> -A delay time of -1 is possible, indicating "infinite." -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>animation</code></em> :</span></p></td> -<td>a <a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="type">GdkPixbufAnimation</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>start_time</code></em> :</span></p></td> -<td>time when the animation starts playing. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>an iterator to move over the animation. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-animation-is-static-image"></a><h3>gdk_pixbuf_animation_is_static_image ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> gdk_pixbuf_animation_is_static_image - (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="type">GdkPixbufAnimation</span></a> *animation</code></em>);</pre> -<p> -If you load a file with <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-new-from-file" title="gdk_pixbuf_animation_new_from_file ()"><code class="function">gdk_pixbuf_animation_new_from_file()</code></a> and it turns -out to be a plain, unanimated image, then this function will return -<code class="literal">TRUE</code>. Use <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-get-static-image" title="gdk_pixbuf_animation_get_static_image ()"><code class="function">gdk_pixbuf_animation_get_static_image()</code></a> to retrieve -the image. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>animation</code></em> :</span></p></td> -<td>a <a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="type">GdkPixbufAnimation</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> -<code class="literal">TRUE</code> if the "animation" was really just an image</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-animation-get-static-image"></a><h3>gdk_pixbuf_animation_get_static_image ()</h3> -<pre class="programlisting"><a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * gdk_pixbuf_animation_get_static_image - (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="type">GdkPixbufAnimation</span></a> *animation</code></em>);</pre> -<p> -If an animation is really just a plain image (has only one frame), -this function returns that image. If the animation is an animation, -this function returns a reasonable thing to display as a static -unanimated image, which might be the first frame, or something more -sophisticated. If an animation hasn't loaded any frames yet, this -function will return <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>animation</code></em> :</span></p></td> -<td>a <a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimation"><span class="type">GdkPixbufAnimation</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>unanimated image representing the animation. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-animation-iter-advance"></a><h3>gdk_pixbuf_animation_iter_advance ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> gdk_pixbuf_animation_iter_advance (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimationIter"><span class="type">GdkPixbufAnimationIter</span></a> *iter</code></em>, - <em class="parameter"><code>const <span class="type">GTimeVal</span> *current_time</code></em>);</pre> -<p> -Possibly advances an animation to a new frame. Chooses the frame based -on the start time passed to <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-get-iter" title="gdk_pixbuf_animation_get_iter ()"><code class="function">gdk_pixbuf_animation_get_iter()</code></a>. -</p> -<p> -<em class="parameter"><code>current_time</code></em> would normally come from <code class="function">g_get_current_time()</code>, and -must be greater than or equal to the time passed to -<a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-get-iter" title="gdk_pixbuf_animation_get_iter ()"><code class="function">gdk_pixbuf_animation_get_iter()</code></a>, and must increase or remain -unchanged each time <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-iter-get-pixbuf" title="gdk_pixbuf_animation_iter_get_pixbuf ()"><code class="function">gdk_pixbuf_animation_iter_get_pixbuf()</code></a> is -called. That is, you can't go backward in time; animations only -play forward. -</p> -<p> -As a shortcut, pass <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for the current time and <code class="function">g_get_current_time()</code> -will be invoked on your behalf. So you only need to explicitly pass -<em class="parameter"><code>current_time</code></em> if you're doing something odd like playing the animation -at double speed. -</p> -<p> -If this function returns <code class="literal">FALSE</code>, there's no need to update the animation -display, assuming the display had been rendered prior to advancing; -if <code class="literal">TRUE</code>, you need to call <code class="function">gdk_animation_iter_get_pixbuf()</code> and update the -display with the new pixbuf. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> -<td>a <a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimationIter"><span class="type">GdkPixbufAnimationIter</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>current_time</code></em> :</span></p></td> -<td>current time. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> -<code class="literal">TRUE</code> if the image may need updating</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-animation-iter-get-delay-time"></a><h3>gdk_pixbuf_animation_iter_get_delay_time ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> gdk_pixbuf_animation_iter_get_delay_time - (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimationIter"><span class="type">GdkPixbufAnimationIter</span></a> *iter</code></em>);</pre> -<p> -Gets the number of milliseconds the current pixbuf should be displayed, -or -1 if the current pixbuf should be displayed forever. <code class="function">g_timeout_add()</code> -conveniently takes a timeout in milliseconds, so you can use a timeout -to schedule the next update. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> -<td>an animation iterator</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>delay time in milliseconds (thousandths of a second)</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-animation-iter-on-currently-loading-frame"></a><h3>gdk_pixbuf_animation_iter_on_currently_loading_frame ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> gdk_pixbuf_animation_iter_on_currently_loading_frame - (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimationIter"><span class="type">GdkPixbufAnimationIter</span></a> *iter</code></em>);</pre> -<p> -Used to determine how to respond to the area_updated signal on -<a class="link" href="GdkPixbufLoader.html" title="GdkPixbufLoader"><span class="type">GdkPixbufLoader</span></a> when loading an animation. area_updated is emitted -for an area of the frame currently streaming in to the loader. So if -you're on the currently loading frame, you need to redraw the screen for -the updated area. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> -<td>a <a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimationIter"><span class="type">GdkPixbufAnimationIter</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> -<code class="literal">TRUE</code> if the frame we're on is partially loaded, or the last frame</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-animation-iter-get-pixbuf"></a><h3>gdk_pixbuf_animation_iter_get_pixbuf ()</h3> -<pre class="programlisting"><a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * gdk_pixbuf_animation_iter_get_pixbuf - (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufAnimationIter"><span class="type">GdkPixbufAnimationIter</span></a> *iter</code></em>);</pre> -<p> -Gets the current pixbuf which should be displayed; the pixbuf might not -be the same size as the animation itself -(<a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-get-width" title="gdk_pixbuf_animation_get_width ()"><code class="function">gdk_pixbuf_animation_get_width()</code></a>, <a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-get-height" title="gdk_pixbuf_animation_get_height ()"><code class="function">gdk_pixbuf_animation_get_height()</code></a>). -This pixbuf should be displayed for -<a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-iter-get-delay-time" title="gdk_pixbuf_animation_iter_get_delay_time ()"><code class="function">gdk_pixbuf_animation_iter_get_delay_time()</code></a> milliseconds. The caller -of this function does not own a reference to the returned pixbuf; -the returned pixbuf will become invalid when the iterator advances -to the next frame, which may happen anytime you call -<a class="link" href="gdk-pixbuf-Animations.html#gdk-pixbuf-animation-iter-advance" title="gdk_pixbuf_animation_iter_advance ()"><code class="function">gdk_pixbuf_animation_iter_advance()</code></a>. Copy the pixbuf to keep it -(don't just add a reference), as it may get recycled as you advance -the iterator. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> -<td>an animation iterator</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the pixbuf to be displayed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="GdkPixbufSimpleAnim-struct"></a><h3>GdkPixbufSimpleAnim</h3> -<pre class="programlisting">typedef struct _GdkPixbufSimpleAnim GdkPixbufSimpleAnim;</pre> -<p> -An opaque struct representing a simple animation. -</p> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-simple-anim-new"></a><h3>gdk_pixbuf_simple_anim_new ()</h3> -<pre class="programlisting"><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufSimpleAnim"><span class="returnvalue">GdkPixbufSimpleAnim</span></a> * gdk_pixbuf_simple_anim_new (<em class="parameter"><code><span class="type">gint</span> width</code></em>, - <em class="parameter"><code><span class="type">gint</span> height</code></em>, - <em class="parameter"><code><span class="type">gfloat</span> rate</code></em>);</pre> -<p> -Creates a new, empty animation. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td> -<td>the width of the animation</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td> -<td>the height of the animation</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>rate</code></em> :</span></p></td> -<td>the speed of the animation, in frames per second</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a newly allocated <a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufSimpleAnim"><span class="type">GdkPixbufSimpleAnim</span></a> -</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.8</p> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-simple-anim-add-frame"></a><h3>gdk_pixbuf_simple_anim_add_frame ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> gdk_pixbuf_simple_anim_add_frame (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufSimpleAnim"><span class="type">GdkPixbufSimpleAnim</span></a> *animation</code></em>, - <em class="parameter"><code><a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>);</pre> -<p> -Adds a new frame to <em class="parameter"><code>animation</code></em>. The <em class="parameter"><code>pixbuf</code></em> must -have the dimensions specified when the animation -was constructed. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>animation</code></em> :</span></p></td> -<td>a <a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufSimpleAnim"><span class="type">GdkPixbufSimpleAnim</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td> -<td>the pixbuf to add</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.8</p> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-simple-anim-set-loop"></a><h3>gdk_pixbuf_simple_anim_set_loop ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> gdk_pixbuf_simple_anim_set_loop (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufSimpleAnim"><span class="type">GdkPixbufSimpleAnim</span></a> *animation</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> loop</code></em>);</pre> -<p> -Sets whether <em class="parameter"><code>animation</code></em> should loop indefinitely when it reaches the end. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>animation</code></em> :</span></p></td> -<td>a <a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufSimpleAnim"><span class="type">GdkPixbufSimpleAnim</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>loop</code></em> :</span></p></td> -<td>whether to loop the animation</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.18</p> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-simple-anim-get-loop"></a><h3>gdk_pixbuf_simple_anim_get_loop ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> gdk_pixbuf_simple_anim_get_loop (<em class="parameter"><code><a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufSimpleAnim"><span class="type">GdkPixbufSimpleAnim</span></a> *animation</code></em>);</pre> -<p> -Gets whether <em class="parameter"><code>animation</code></em> should loop indefinitely when it reaches the end. -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>animation</code></em> :</span></p></td> -<td>a <a class="link" href="gdk-pixbuf-Animations.html#GdkPixbufSimpleAnim"><span class="type">GdkPixbufSimpleAnim</span></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> -<code class="literal">TRUE</code> if the animation loops forever, <code class="literal">FALSE</code> otherwise</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.18</p> -</div> -</div> -<div class="refsect1"> -<a name="gdk-pixbuf-Animations.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="GdkPixbufSimpleAnim--loop"></a><h3>The <code class="literal">"loop"</code> property</h3> -<pre class="programlisting"> "loop" <span class="type">gboolean</span> : Read / Write</pre> -<p> -Whether the animation should loop when it reaches the end. -</p> -<p>Default value: FALSE</p> -<p class="since">Since 2.18</p> -</div> -</div> -<div class="refsect1"> -<a name="gdk-pixbuf-Animations.see-also"></a><h2>See Also</h2> -<a class="link" href="GdkPixbufLoader.html" title="GdkPixbufLoader"><span class="type">GdkPixbufLoader</span></a>. -</div> -</div> -<div class="footer"> -<hr> - Generated by GTK-Doc V1.18.1</div> -</body> -</html>
\ No newline at end of file |