Imported Upstream version 2.8.16

This commit is contained in:
Ari Pollak
2015-11-24 14:17:30 -05:00
parent bf2f572083
commit 66d1b776a9
842 changed files with 251623 additions and 240362 deletions

View File

@ -2,13 +2,13 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GIMP Library Reference Manual: gimpbuffer</title>
<title>gimpbuffer: GIMP Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.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.21 (XML mode)">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@ -27,7 +27,7 @@
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp-gimpbuffer.top_of_page"></a>gimpbuffer</span></h2>
<p>gimpbuffer — Functions for manipulating cut buffers.</p>
<p>gimpbuffer</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
@ -41,7 +41,7 @@
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> **
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpbuffer.html#gimp-buffers-get-list" title="gimp_buffers_get_list ()">gimp_buffers_get_list</a> <span class="c_punctuation">()</span>
@ -49,7 +49,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpbuffer.html#gimp-buffer-rename" title="gimp_buffer_rename ()">gimp_buffer_rename</a> <span class="c_punctuation">()</span>
@ -57,7 +57,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpbuffer.html#gimp-buffer-delete" title="gimp_buffer_delete ()">gimp_buffer_delete</a> <span class="c_punctuation">()</span>
@ -65,7 +65,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpbuffer.html#gimp-buffer-get-width" title="gimp_buffer_get_width ()">gimp_buffer_get_width</a> <span class="c_punctuation">()</span>
@ -73,7 +73,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpbuffer.html#gimp-buffer-get-height" title="gimp_buffer_get_height ()">gimp_buffer_get_height</a> <span class="c_punctuation">()</span>
@ -81,7 +81,7 @@
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpbuffer.html#gimp-buffer-get-bytes" title="gimp_buffer_get_bytes ()">gimp_buffer_get_bytes</a> <span class="c_punctuation">()</span>
@ -89,7 +89,7 @@
</tr>
<tr>
<td class="function_type">
<a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageBaseType"><span class="returnvalue">GimpImageBaseType</span></a>
<a href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageBaseType"><span class="returnvalue">GimpImageBaseType</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpbuffer.html#gimp-buffer-get-image-type" title="gimp_buffer_get_image_type ()">gimp_buffer_get_image_type</a> <span class="c_punctuation">()</span>
@ -100,228 +100,58 @@
</div>
<div class="refsect1">
<a name="libgimp-gimpbuffer.description"></a><h2>Description</h2>
<p>Functions related to named cut buffers.</p>
</div>
<div class="refsect1">
<a name="libgimp-gimpbuffer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-buffers-get-list"></a><h3>gimp_buffers_get_list ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> **
gimp_buffers_get_list (<em class="parameter"><code>const <span class="type">gchar</span> *filter</code></em>,
<em class="parameter"><code><span class="type">gint</span> *num_buffers</code></em>);</pre>
<p>Retrieve a complete listing of the available buffers.</p>
<p>This procedure returns a complete listing of available named
buffers.</p>
<div class="refsect3">
<a name="id-1.2.3.4.5.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filter</p></td>
<td class="parameter_description"><p>An optional regular expression used to filter the list.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_buffers</p></td>
<td class="parameter_description"><p>The number of buffers.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.4.5.2.7"></a><h4>Returns</h4>
<p> The list of buffer names.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
gimp_buffers_get_list (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filter</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *num_buffers</code></em>);</pre>
<p class="since">Since: GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-buffer-rename"></a><h3>gimp_buffer_rename ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gimp_buffer_rename (<em class="parameter"><code>const <span class="type">gchar</span> *buffer_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *new_name</code></em>);</pre>
<p>Renames a named buffer.</p>
<p>This procedure renames a named buffer.</p>
<div class="refsect3">
<a name="id-1.2.3.4.5.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>buffer_name</p></td>
<td class="parameter_description"><p>The buffer name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>new_name</p></td>
<td class="parameter_description"><p>The buffer's new name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.4.5.3.7"></a><h4>Returns</h4>
<p> The real name given to the buffer.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gimp_buffer_rename (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *new_name</code></em>);</pre>
<p class="since">Since: GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-buffer-delete"></a><h3>gimp_buffer_delete ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_buffer_delete (<em class="parameter"><code>const <span class="type">gchar</span> *buffer_name</code></em>);</pre>
<p>Deletes a named buffer.</p>
<p>This procedure deletes a named buffer.</p>
<div class="refsect3">
<a name="id-1.2.3.4.5.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>buffer_name</p></td>
<td class="parameter_description"><p>The buffer name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.4.5.4.7"></a><h4>Returns</h4>
<p> TRUE on success.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gimp_buffer_delete (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);</pre>
<p class="since">Since: GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-buffer-get-width"></a><h3>gimp_buffer_get_width ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
gimp_buffer_get_width (<em class="parameter"><code>const <span class="type">gchar</span> *buffer_name</code></em>);</pre>
<p>Retrieves the specified buffer's width.</p>
<p>This procedure retrieves the specified named buffer's width.</p>
<div class="refsect3">
<a name="id-1.2.3.4.5.5.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>buffer_name</p></td>
<td class="parameter_description"><p>The buffer name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.4.5.5.7"></a><h4>Returns</h4>
<p> The buffer width.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
gimp_buffer_get_width (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);</pre>
<p class="since">Since: GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-buffer-get-height"></a><h3>gimp_buffer_get_height ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
gimp_buffer_get_height (<em class="parameter"><code>const <span class="type">gchar</span> *buffer_name</code></em>);</pre>
<p>Retrieves the specified buffer's height.</p>
<p>This procedure retrieves the specified named buffer's height.</p>
<div class="refsect3">
<a name="id-1.2.3.4.5.6.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>buffer_name</p></td>
<td class="parameter_description"><p>The buffer name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.4.5.6.7"></a><h4>Returns</h4>
<p> The buffer height.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
gimp_buffer_get_height (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);</pre>
<p class="since">Since: GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-buffer-get-bytes"></a><h3>gimp_buffer_get_bytes ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
gimp_buffer_get_bytes (<em class="parameter"><code>const <span class="type">gchar</span> *buffer_name</code></em>);</pre>
<p>Retrieves the specified buffer's bytes.</p>
<p>This procedure retrieves the specified named buffer's bytes.</p>
<div class="refsect3">
<a name="id-1.2.3.4.5.7.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>buffer_name</p></td>
<td class="parameter_description"><p>The buffer name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.4.5.7.7"></a><h4>Returns</h4>
<p> The buffer bpp.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
gimp_buffer_get_bytes (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);</pre>
<p class="since">Since: GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-buffer-get-image-type"></a><h3>gimp_buffer_get_image_type ()</h3>
<pre class="programlisting"><a href="/local/head/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 <span class="type">gchar</span> *buffer_name</code></em>);</pre>
<p>Retrieves the specified buffer's image type.</p>
<p>This procedure retrieves the specified named buffer's image type.</p>
<div class="refsect3">
<a name="id-1.2.3.4.5.8.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>buffer_name</p></td>
<td class="parameter_description"><p>The buffer name.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.4.5.8.7"></a><h4>Returns</h4>
<p> The buffer image type.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<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="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer_name</code></em>);</pre>
<p class="since">Since: GIMP 2.4</p>
</div>
</div>
<div class="refsect1">
@ -329,7 +159,6 @@ gimp_buffer_get_image_type (<em class="parameter"><code>const <span class="type"
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>