diff options
Diffstat (limited to 'gtk+-mingw/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-File-Loading.html')
-rw-r--r-- | gtk+-mingw/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-File-Loading.html | 668 |
1 files changed, 0 insertions, 668 deletions
diff --git a/gtk+-mingw/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-File-Loading.html b/gtk+-mingw/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-File-Loading.html deleted file mode 100644 index 7dafcbb..0000000 --- a/gtk+-mingw/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-File-Loading.html +++ /dev/null @@ -1,668 +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>File Loading</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-Reference-Counting-and-Memory-Mangement.html" title="Reference Counting and Memory Mangement"> -<link rel="next" href="gdk-pixbuf-File-saving.html" title="File saving"> -<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-Reference-Counting-and-Memory-Mangement.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="gdk-pixbuf-File-saving.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-File-Loading.synopsis" class="shortcut">Top</a> - | - <a href="#gdk-pixbuf-File-Loading.description" class="shortcut">Description</a> -</td></tr> -</table> -<div class="refentry"> -<a name="gdk-pixbuf-File-Loading"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="gdk-pixbuf-File-Loading.top_of_page"></a>File Loading</span></h2> -<p>File Loading — Loading a pixbuf from a file.</p> -</td> -<td valign="top" align="right"></td> -</tr></table></div> -<div class="refsynopsisdiv"> -<a name="gdk-pixbuf-File-Loading.synopsis"></a><h2>Synopsis</h2> -<pre class="synopsis"> -#include <gdk-pixbuf/gdk-pixbuf.h> - -<a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * <a class="link" href="gdk-pixbuf-File-Loading.html#gdk-pixbuf-new-from-file" title="gdk_pixbuf_new_from_file ()">gdk_pixbuf_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-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * <a class="link" href="gdk-pixbuf-File-Loading.html#gdk-pixbuf-new-from-file-at-size" title="gdk_pixbuf_new_from_file_at_size ()">gdk_pixbuf_new_from_file_at_size</a> (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>, - <em class="parameter"><code><span class="type">int</span> width</code></em>, - <em class="parameter"><code><span class="type">int</span> height</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</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-File-Loading.html#gdk-pixbuf-new-from-file-at-scale" title="gdk_pixbuf_new_from_file_at_scale ()">gdk_pixbuf_new_from_file_at_scale</a> (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>, - <em class="parameter"><code><span class="type">int</span> width</code></em>, - <em class="parameter"><code><span class="type">int</span> height</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> preserve_aspect_ratio</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>); -<a class="link" href="gdk-pixbuf-Module-Interface.html#GdkPixbufFormat" title="struct GdkPixbufFormat"><span class="returnvalue">GdkPixbufFormat</span></a> * <a class="link" href="gdk-pixbuf-File-Loading.html#gdk-pixbuf-get-file-info" title="gdk_pixbuf_get_file_info ()">gdk_pixbuf_get_file_info</a> (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>, - <em class="parameter"><code><span class="type">gint</span> *width</code></em>, - <em class="parameter"><code><span class="type">gint</span> *height</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-File-Loading.html#gdk-pixbuf-new-from-resource" title="gdk_pixbuf_new_from_resource ()">gdk_pixbuf_new_from_resource</a> (<em class="parameter"><code>const <span class="type">char</span> *resource_path</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</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-File-Loading.html#gdk-pixbuf-new-from-resource-at-scale" title="gdk_pixbuf_new_from_resource_at_scale ()">gdk_pixbuf_new_from_resource_at_scale</a> - (<em class="parameter"><code>const <span class="type">char</span> *resource_path</code></em>, - <em class="parameter"><code><span class="type">int</span> width</code></em>, - <em class="parameter"><code><span class="type">int</span> height</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> preserve_aspect_ratio</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</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-File-Loading.html#gdk-pixbuf-new-from-stream" title="gdk_pixbuf_new_from_stream ()">gdk_pixbuf_new_from_stream</a> (<em class="parameter"><code><span class="type">GInputStream</span> *stream</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>); -<span class="returnvalue">void</span> <a class="link" href="gdk-pixbuf-File-Loading.html#gdk-pixbuf-new-from-stream-async" title="gdk_pixbuf_new_from_stream_async ()">gdk_pixbuf_new_from_stream_async</a> (<em class="parameter"><code><span class="type">GInputStream</span> *stream</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</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-File-Loading.html#gdk-pixbuf-new-from-stream-finish" title="gdk_pixbuf_new_from_stream_finish ()">gdk_pixbuf_new_from_stream_finish</a> (<em class="parameter"><code><span class="type">GAsyncResult</span> *async_result</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</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-File-Loading.html#gdk-pixbuf-new-from-stream-at-scale" title="gdk_pixbuf_new_from_stream_at_scale ()">gdk_pixbuf_new_from_stream_at_scale</a> (<em class="parameter"><code><span class="type">GInputStream</span> *stream</code></em>, - <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">gboolean</span> preserve_aspect_ratio</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>); -<span class="returnvalue">void</span> <a class="link" href="gdk-pixbuf-File-Loading.html#gdk-pixbuf-new-from-stream-at-scale-async" title="gdk_pixbuf_new_from_stream_at_scale_async ()">gdk_pixbuf_new_from_stream_at_scale_async</a> - (<em class="parameter"><code><span class="type">GInputStream</span> *stream</code></em>, - <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">gboolean</span> preserve_aspect_ratio</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>); -</pre> -</div> -<div class="refsect1"> -<a name="gdk-pixbuf-File-Loading.description"></a><h2>Description</h2> -<p> -The GdkPixBuf library provides a simple mechanism for loading -an image from a file in synchronous fashion. This means that the -library takes control of the application while the file is being -loaded; from the user's point of view, the application will block -until the image is done loading. -</p> -<p> -This interface can be used by applications in which blocking is -acceptable while an image is being loaded. It can also be used to -load small images in general. Applications that need progressive -loading can use the <a class="link" href="GdkPixbufLoader.html" title="GdkPixbufLoader"><span class="type">GdkPixbufLoader</span></a> functionality instead. -</p> -</div> -<div class="refsect1"> -<a name="gdk-pixbuf-File-Loading.details"></a><h2>Details</h2> -<div class="refsect2"> -<a name="gdk-pixbuf-new-from-file"></a><h3>gdk_pixbuf_new_from_file ()</h3> -<pre class="programlisting"><a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * gdk_pixbuf_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 pixbuf by loading an image from a file. The file format is -detected automatically. If <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> is returned, then <em class="parameter"><code>error</code></em> will be set. -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 an error</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A newly-created pixbuf 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 occurred: 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-new-from-file-at-size"></a><h3>gdk_pixbuf_new_from_file_at_size ()</h3> -<pre class="programlisting"><a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * gdk_pixbuf_new_from_file_at_size (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>, - <em class="parameter"><code><span class="type">int</span> width</code></em>, - <em class="parameter"><code><span class="type">int</span> height</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p> -Creates a new pixbuf by loading an image from a file. -The file format is detected automatically. If <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> is returned, then -<em class="parameter"><code>error</code></em> will be set. 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> -<p> -The image will be scaled to fit in the requested size, preserving -the image's aspect ratio. Note that the returned pixbuf may be smaller -than <em class="parameter"><code>width</code></em> x <em class="parameter"><code>height</code></em>, if the aspect ratio requires it. To load -and image at the requested size, regardless of aspect ratio, use -<a class="link" href="gdk-pixbuf-File-Loading.html#gdk-pixbuf-new-from-file-at-scale" title="gdk_pixbuf_new_from_file_at_scale ()"><code class="function">gdk_pixbuf_new_from_file_at_scale()</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>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>width</code></em> :</span></p></td> -<td>The width the image should have or -1 to not constrain the width</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td> -<td>The height the image should have or -1 to not constrain the height</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> -<td>Return location for an error</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A newly-created pixbuf 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 occurred: 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> -<p class="since">Since 2.4</p> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-new-from-file-at-scale"></a><h3>gdk_pixbuf_new_from_file_at_scale ()</h3> -<pre class="programlisting"><a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * gdk_pixbuf_new_from_file_at_scale (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>, - <em class="parameter"><code><span class="type">int</span> width</code></em>, - <em class="parameter"><code><span class="type">int</span> height</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> preserve_aspect_ratio</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p> -Creates a new pixbuf by loading an image from a file. The file format is -detected automatically. If <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> is returned, then <em class="parameter"><code>error</code></em> will be set. -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. -The image will be scaled to fit in the requested size, optionally preserving -the image's aspect ratio. -</p> -<p> -When preserving the aspect ratio, a <em class="parameter"><code>width</code></em> of -1 will cause the image -to be scaled to the exact given height, and a <em class="parameter"><code>height</code></em> of -1 will cause -the image to be scaled to the exact given width. When not preserving -aspect ratio, a <em class="parameter"><code>width</code></em> or <em class="parameter"><code>height</code></em> of -1 means to not scale the image -at all in that dimension. Negative values for <em class="parameter"><code>width</code></em> and <em class="parameter"><code>height</code></em> are -allowed since 2.8. -</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>width</code></em> :</span></p></td> -<td>The width the image should have or -1 to not constrain the width</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td> -<td>The height the image should have or -1 to not constrain the height</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>preserve_aspect_ratio</code></em> :</span></p></td> -<td> -<code class="literal">TRUE</code> to preserve the image's aspect ratio</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> -<td>Return location for an error</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A newly-created pixbuf 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 occurred: 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> -<p class="since">Since 2.6</p> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-get-file-info"></a><h3>gdk_pixbuf_get_file_info ()</h3> -<pre class="programlisting"><a class="link" href="gdk-pixbuf-Module-Interface.html#GdkPixbufFormat" title="struct GdkPixbufFormat"><span class="returnvalue">GdkPixbufFormat</span></a> * gdk_pixbuf_get_file_info (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>, - <em class="parameter"><code><span class="type">gint</span> *width</code></em>, - <em class="parameter"><code><span class="type">gint</span> *height</code></em>);</pre> -<p> -Parses an image file far enough to determine its format and size. -</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>The name of the file to identify.</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td> -<td>Return location for the width of the image, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td> -<td>Return location for the height of the image, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A <a class="link" href="gdk-pixbuf-Module-Interface.html#GdkPixbufFormat" title="struct GdkPixbufFormat"><span class="type">GdkPixbufFormat</span></a> describing the image -format of the file or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if the image format wasn't -recognized. The return value is owned by GdkPixbuf and should -not be freed. <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> -<p class="since">Since 2.4</p> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-new-from-resource"></a><h3>gdk_pixbuf_new_from_resource ()</h3> -<pre class="programlisting"><a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * gdk_pixbuf_new_from_resource (<em class="parameter"><code>const <span class="type">char</span> *resource_path</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p> -Creates a new pixbuf by loading an image from an resource. -</p> -<p> -The file format is detected automatically. If <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> is returned, then -<em class="parameter"><code>error</code></em> will be set. -</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>resource_path</code></em> :</span></p></td> -<td>the path of the resource file</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> -<td>Return location for an error</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A newly-created pixbuf, 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 occurred: the file could not be opened, the image format is -not supported, there was not enough memory to allocate the image buffer, -the stream contained invalid data, or the operation was cancelled.</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-new-from-resource-at-scale"></a><h3>gdk_pixbuf_new_from_resource_at_scale ()</h3> -<pre class="programlisting"><a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * gdk_pixbuf_new_from_resource_at_scale - (<em class="parameter"><code>const <span class="type">char</span> *resource_path</code></em>, - <em class="parameter"><code><span class="type">int</span> width</code></em>, - <em class="parameter"><code><span class="type">int</span> height</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> preserve_aspect_ratio</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p> -Creates a new pixbuf by loading an image from an resource. -</p> -<p> -The file format is detected automatically. If <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> is returned, then -<em class="parameter"><code>error</code></em> will be set. -</p> -<p> -The image will be scaled to fit in the requested size, optionally -preserving the image's aspect ratio. When preserving the aspect ratio, -a <em class="parameter"><code>width</code></em> of -1 will cause the image to be scaled to the exact given -height, and a <em class="parameter"><code>height</code></em> of -1 will cause the image to be scaled to the -exact given width. When not preserving aspect ratio, a <em class="parameter"><code>width</code></em> or -<em class="parameter"><code>height</code></em> of -1 means to not scale the image at all in that dimension. -</p> -<p> -The stream is not closed. -</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>resource_path</code></em> :</span></p></td> -<td>the path of the resource file</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td> -<td>The width the image should have or -1 to not constrain the width</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td> -<td>The height the image should have or -1 to not constrain the height</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>preserve_aspect_ratio</code></em> :</span></p></td> -<td> -<code class="literal">TRUE</code> to preserve the image's aspect ratio</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> -<td>Return location for an error</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A newly-created pixbuf, 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 occurred: the file could not be opened, the image format is -not supported, there was not enough memory to allocate the image buffer, -the stream contained invalid data, or the operation was cancelled.</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-new-from-stream"></a><h3>gdk_pixbuf_new_from_stream ()</h3> -<pre class="programlisting"><a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * gdk_pixbuf_new_from_stream (<em class="parameter"><code><span class="type">GInputStream</span> *stream</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p> -Creates a new pixbuf by loading an image from an input stream. -</p> -<p> -The file format is detected automatically. If <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> is returned, then -<em class="parameter"><code>error</code></em> will be set. The <em class="parameter"><code>cancellable</code></em> can be used to abort the operation -from another thread. If the operation was cancelled, the error -<code class="literal">GIO_ERROR_CANCELLED</code> will be returned. Other 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 <code class="literal">G_IO_ERROR</code> domains. -</p> -<p> -The stream is not closed. -</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>stream</code></em> :</span></p></td> -<td>a <span class="type">GInputStream</span> to load the pixbuf from</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td> -<td>optional <span class="type">GCancellable</span> object, <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to ignore</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> -<td>Return location for an error</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A newly-created pixbuf, 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 occurred: the file could not be opened, the image format is -not supported, there was not enough memory to allocate the image buffer, -the stream contained invalid data, or the operation was cancelled.</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.14</p> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-new-from-stream-async"></a><h3>gdk_pixbuf_new_from_stream_async ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> gdk_pixbuf_new_from_stream_async (<em class="parameter"><code><span class="type">GInputStream</span> *stream</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p> -Creates a new pixbuf by asynchronously loading an image from an input stream. -</p> -<p> -For more details see <a class="link" href="gdk-pixbuf-File-Loading.html#gdk-pixbuf-new-from-stream" title="gdk_pixbuf_new_from_stream ()"><code class="function">gdk_pixbuf_new_from_stream()</code></a>, which is the synchronous -version of this function. -</p> -<p> -When the operation is finished, <em class="parameter"><code>callback</code></em> will be called in the main thread. -You can then call <a class="link" href="gdk-pixbuf-File-Loading.html#gdk-pixbuf-new-from-stream-finish" title="gdk_pixbuf_new_from_stream_finish ()"><code class="function">gdk_pixbuf_new_from_stream_finish()</code></a> to get the result of the operation. -</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>stream</code></em> :</span></p></td> -<td>a <span class="type">GInputStream</span> from which to load the pixbuf</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td> -<td>optional <span class="type">GCancellable</span> object, <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to ignore</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td> -<td>a <span class="type">GAsyncReadyCallback</span> to call when the the pixbuf is loaded</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> -<td>the data to pass to the callback function</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-new-from-stream-finish"></a><h3>gdk_pixbuf_new_from_stream_finish ()</h3> -<pre class="programlisting"><a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * gdk_pixbuf_new_from_stream_finish (<em class="parameter"><code><span class="type">GAsyncResult</span> *async_result</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p> -Finishes an asynchronous pixbuf creation operation started with -<a class="link" href="gdk-pixbuf-File-Loading.html#gdk-pixbuf-new-from-stream-async" title="gdk_pixbuf_new_from_stream_async ()"><code class="function">gdk_pixbuf_new_from_stream_async()</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>async_result</code></em> :</span></p></td> -<td>a <span class="type">GAsyncResult</span> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> -<td>a <span class="type">GError</span>, or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> -</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>a <a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> or <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> on error. Free the returned -object with <code class="function">g_object_unref()</code>.</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-new-from-stream-at-scale"></a><h3>gdk_pixbuf_new_from_stream_at_scale ()</h3> -<pre class="programlisting"><a class="link" href="gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * gdk_pixbuf_new_from_stream_at_scale (<em class="parameter"><code><span class="type">GInputStream</span> *stream</code></em>, - <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">gboolean</span> preserve_aspect_ratio</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p> -Creates a new pixbuf by loading an image from an input stream. -</p> -<p> -The file format is detected automatically. If <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> is returned, then -<em class="parameter"><code>error</code></em> will be set. The <em class="parameter"><code>cancellable</code></em> can be used to abort the operation -from another thread. If the operation was cancelled, the error -<code class="literal">GIO_ERROR_CANCELLED</code> will be returned. Other 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 <code class="literal">G_IO_ERROR</code> domains. -</p> -<p> -The image will be scaled to fit in the requested size, optionally -preserving the image's aspect ratio. When preserving the aspect ratio, -a <em class="parameter"><code>width</code></em> of -1 will cause the image to be scaled to the exact given -height, and a <em class="parameter"><code>height</code></em> of -1 will cause the image to be scaled to the -exact given width. When not preserving aspect ratio, a <em class="parameter"><code>width</code></em> or -<em class="parameter"><code>height</code></em> of -1 means to not scale the image at all in that dimension. -</p> -<p> -The stream is not closed. -</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>stream</code></em> :</span></p></td> -<td>a <span class="type">GInputStream</span> to load the pixbuf from</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td> -<td>The width the image should have or -1 to not constrain the width</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td> -<td>The height the image should have or -1 to not constrain the height</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>preserve_aspect_ratio</code></em> :</span></p></td> -<td> -<code class="literal">TRUE</code> to preserve the image's aspect ratio</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td> -<td>optional <span class="type">GCancellable</span> object, <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to ignore</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> -<td>Return location for an error</td> -</tr> -<tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A newly-created pixbuf, 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 occurred: the file could not be opened, the image format is -not supported, there was not enough memory to allocate the image buffer, -the stream contained invalid data, or the operation was cancelled.</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.14</p> -</div> -<hr> -<div class="refsect2"> -<a name="gdk-pixbuf-new-from-stream-at-scale-async"></a><h3>gdk_pixbuf_new_from_stream_at_scale_async ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> gdk_pixbuf_new_from_stream_at_scale_async - (<em class="parameter"><code><span class="type">GInputStream</span> *stream</code></em>, - <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">gboolean</span> preserve_aspect_ratio</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p> -Creates a new pixbuf by asynchronously loading an image from an input stream. -</p> -<p> -For more details see <a class="link" href="gdk-pixbuf-File-Loading.html#gdk-pixbuf-new-from-stream-at-scale" title="gdk_pixbuf_new_from_stream_at_scale ()"><code class="function">gdk_pixbuf_new_from_stream_at_scale()</code></a>, which is the synchronous -version of this function. -</p> -<p> -When the operation is finished, <em class="parameter"><code>callback</code></em> will be called in the main thread. -You can then call <a class="link" href="gdk-pixbuf-File-Loading.html#gdk-pixbuf-new-from-stream-finish" title="gdk_pixbuf_new_from_stream_finish ()"><code class="function">gdk_pixbuf_new_from_stream_finish()</code></a> to get the result of the operation. -</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>stream</code></em> :</span></p></td> -<td>a <span class="type">GInputStream</span> from which to load the pixbuf</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td> -<td>the width the image should have or -1 to not constrain the width</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td> -<td>the height the image should have or -1 to not constrain the height</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>preserve_aspect_ratio</code></em> :</span></p></td> -<td> -<code class="literal">TRUE</code> to preserve the image's aspect ratio</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td> -<td>optional <span class="type">GCancellable</span> object, <a href="/home/mclasen/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> to ignore</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td> -<td>a <span class="type">GAsyncReadyCallback</span> to call when the the pixbuf is loaded</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> -<td>the data to pass to the callback function</td> -</tr> -</tbody> -</table></div> -<p class="since">Since 2.24</p> -</div> -</div> -<div class="refsect1"> -<a name="gdk-pixbuf-File-Loading.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 |