Imported Upstream version 2.6.12

This commit is contained in:
Ari Pollak
2012-02-18 13:51:51 -05:00
parent 357cf155b6
commit 3fcab19200
550 changed files with 140833 additions and 99740 deletions

View File

@ -3,12 +3,12 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpbuffer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="prev" href="libgimp-gimpenums.html" title="gimpenums">
<link rel="next" href="libgimp-gimpcontext.html" title="gimpcontext">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@ -26,7 +26,7 @@
<a href="#libgimp-gimpbuffer.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="gimpbuffer">
<div class="refentry">
<a name="libgimp-gimpbuffer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
@ -35,30 +35,30 @@
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<div class="refsynopsisdiv">
<a name="libgimp-gimpbuffer.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>** <a class="link" href="libgimp-gimpbuffer.html#gimp-buffers-get-list" title="gimp_buffers_get_list ()">gimp_buffers_get_list</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filter</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *num_buffers</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="libgimp-gimpbuffer.html#gimp-buffer-rename" title="gimp_buffer_rename ()">gimp_buffer_rename</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *new_name</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgimp-gimpbuffer.html#gimp-buffer-delete" title="gimp_buffer_delete ()">gimp_buffer_delete</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="libgimp-gimpbuffer.html#gimp-buffer-get-width" title="gimp_buffer_get_width ()">gimp_buffer_get_width</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="libgimp-gimpbuffer.html#gimp-buffer-get-height" title="gimp_buffer_get_height ()">gimp_buffer_get_height</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="libgimp-gimpbuffer.html#gimp-buffer-get-bytes" title="gimp_buffer_get_bytes ()">gimp_buffer_get_bytes</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);
<a href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageBaseType"><span class="returnvalue">GimpImageBaseType</span></a> <a class="link" href="libgimp-gimpbuffer.html#gimp-buffer-get-image-type" title="gimp_buffer_get_image_type ()">gimp_buffer_get_image_type</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);
<pre class="synopsis"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> ** <a class="link" href="libgimp-gimpbuffer.html#gimp-buffers-get-list" title="gimp_buffers_get_list ()">gimp_buffers_get_list</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filter</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *num_buffers</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libgimp-gimpbuffer.html#gimp-buffer-rename" title="gimp_buffer_rename ()">gimp_buffer_rename</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *new_name</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgimp-gimpbuffer.html#gimp-buffer-delete" title="gimp_buffer_delete ()">gimp_buffer_delete</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="libgimp-gimpbuffer.html#gimp-buffer-get-width" title="gimp_buffer_get_width ()">gimp_buffer_get_width</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="libgimp-gimpbuffer.html#gimp-buffer-get-height" title="gimp_buffer_get_height ()">gimp_buffer_get_height</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="libgimp-gimpbuffer.html#gimp-buffer-get-bytes" title="gimp_buffer_get_bytes ()">gimp_buffer_get_bytes</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);
<a href="/usr/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageBaseType"><span class="returnvalue">GimpImageBaseType</span></a> <a class="link" href="libgimp-gimpbuffer.html#gimp-buffer-get-image-type" title="gimp_buffer_get_image_type ()">gimp_buffer_get_image_type</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<div class="refsect1">
<a name="libgimp-gimpbuffer.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<div class="refsect1">
<a name="libgimp-gimpbuffer.details"></a><h2>Details</h2>
<div class="refsect2" title="gimp_buffers_get_list ()">
<div class="refsect2">
<a name="gimp-buffers-get-list"></a><h3>gimp_buffers_get_list ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>** gimp_buffers_get_list (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filter</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *num_buffers</code></em>);</pre>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> ** gimp_buffers_get_list (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filter</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *num_buffers</code></em>);</pre>
<p>
Retrieve a complete listing of the available buffers.
</p>
@ -71,29 +71,25 @@ buffers.
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td>An optional regular expression used to filter the list.
</td>
<td>An optional regular expression used to filter the list.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num_buffers</code></em> :</span></p></td>
<td>The number of buffers.
</td>
<td>The number of buffers.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The list of buffer names.
</td>
<td>The list of buffer names.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2" title="gimp_buffer_rename ()">
<div class="refsect2">
<a name="gimp-buffer-rename"></a><h3>gimp_buffer_rename ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* gimp_buffer_rename (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *new_name</code></em>);</pre>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gimp_buffer_rename (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *new_name</code></em>);</pre>
<p>
Renames a named buffer.
</p>
@ -105,28 +101,24 @@ This procedure renames a named buffer.
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer_name</code></em> :</span></p></td>
<td>The buffer name.
</td>
<td>The buffer name.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_name</code></em> :</span></p></td>
<td>The buffer's new name.
</td>
<td>The buffer's new name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The real name given to the buffer.
</td>
<td>The real name given to the buffer.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2" title="gimp_buffer_delete ()">
<div class="refsect2">
<a name="gimp-buffer-delete"></a><h3>gimp_buffer_delete ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gimp_buffer_delete (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);</pre>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gimp_buffer_delete (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);</pre>
<p>
Deletes a named buffer.
</p>
@ -138,23 +130,20 @@ This procedure deletes a named buffer.
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer_name</code></em> :</span></p></td>
<td>The buffer name.
</td>
<td>The buffer name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE on success.
</td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2" title="gimp_buffer_get_width ()">
<div class="refsect2">
<a name="gimp-buffer-get-width"></a><h3>gimp_buffer_get_width ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gimp_buffer_get_width (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);</pre>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gimp_buffer_get_width (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);</pre>
<p>
Retrieves the specified buffer's width.
</p>
@ -166,23 +155,20 @@ This procedure retrieves the specified named buffer's width.
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer_name</code></em> :</span></p></td>
<td>The buffer name.
</td>
<td>The buffer name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The buffer width.
</td>
<td>The buffer width.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2" title="gimp_buffer_get_height ()">
<div class="refsect2">
<a name="gimp-buffer-get-height"></a><h3>gimp_buffer_get_height ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gimp_buffer_get_height (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);</pre>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gimp_buffer_get_height (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);</pre>
<p>
Retrieves the specified buffer's height.
</p>
@ -194,23 +180,20 @@ This procedure retrieves the specified named buffer's height.
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer_name</code></em> :</span></p></td>
<td>The buffer name.
</td>
<td>The buffer name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The buffer height.
</td>
<td>The buffer height.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2" title="gimp_buffer_get_bytes ()">
<div class="refsect2">
<a name="gimp-buffer-get-bytes"></a><h3>gimp_buffer_get_bytes ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gimp_buffer_get_bytes (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);</pre>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gimp_buffer_get_bytes (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);</pre>
<p>
Retrieves the specified buffer's bytes.
</p>
@ -222,23 +205,20 @@ This procedure retrieves the specified named buffer's bytes.
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer_name</code></em> :</span></p></td>
<td>The buffer name.
</td>
<td>The buffer name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The buffer bpp.
</td>
<td>The buffer bpp.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2" title="gimp_buffer_get_image_type ()">
<div class="refsect2">
<a name="gimp-buffer-get-image-type"></a><h3>gimp_buffer_get_image_type ()</h3>
<pre class="programlisting"><a href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageBaseType"><span class="returnvalue">GimpImageBaseType</span></a> gimp_buffer_get_image_type (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);</pre>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageBaseType"><span class="returnvalue">GimpImageBaseType</span></a> gimp_buffer_get_image_type (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);</pre>
<p>
Retrieves the specified buffer's image type.
</p>
@ -250,14 +230,11 @@ This procedure retrieves the specified named buffer's image type.
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer_name</code></em> :</span></p></td>
<td>The buffer name.
</td>
<td>The buffer name.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The buffer image type.
</td>
<td>The buffer image type.</td>
</tr>
</tbody>
</table></div>
@ -267,6 +244,6 @@ This procedure retrieves the specified named buffer's image type.
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.15</div>
Generated by GTK-Doc V1.18</div>
</body>
</html>