337 lines
10 KiB
HTML
337 lines
10 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>gimpbuffer</title>
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.70.1">
|
|
<link rel="start" 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-gimp.html" title="gimp">
|
|
<link rel="next" href="libgimp-gimpcontext.html" title="gimpcontext">
|
|
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
|
<link rel="part" href="gimpdefinitions.html" title="Part I. GIMP Constants">
|
|
<link rel="part" href="libgimp.html" title="Part II. GIMP Library">
|
|
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
|
|
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
|
|
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
|
|
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
|
|
<link rel="part" href="libgimpui.html" title="Part III. GIMP User Interface Library">
|
|
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
|
|
<link rel="index" href="ix01.html" title="Index">
|
|
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
|
|
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
|
|
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
|
|
</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="libgimp-gimp.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
|
|
<td><a accesskey="u" href="libgimp-general.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">GIMP Library Reference Manual</th>
|
|
<td><a accesskey="n" href="libgimp-gimpcontext.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
|
|
</tr>
|
|
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2579915" class="shortcut">Top</a>
|
|
 | 
|
|
<a href="#id2602955" class="shortcut">Description</a></nobr></td></tr>
|
|
</table>
|
|
<div class="refentry" lang="en">
|
|
<a name="libgimp-gimpbuffer"></a><div class="titlepage"></div>
|
|
<div class="refnamediv"><table width="100%"><tr>
|
|
<td valign="top">
|
|
<h2>
|
|
<a name="id2579915"></a><span class="refentrytitle">gimpbuffer</span>
|
|
</h2>
|
|
<p>gimpbuffer — </p>
|
|
</td>
|
|
<td valign="top" align="right"></td>
|
|
</tr></table></div>
|
|
<div class="refsynopsisdiv">
|
|
<h2>Synopsis</h2>
|
|
<pre class="synopsis">
|
|
|
|
|
|
|
|
gchar** <a href="libgimp-gimpbuffer.html#gimp-buffers-get-list">gimp_buffers_get_list</a> (const gchar *filter,
|
|
gint *num_buffers);
|
|
gchar* <a href="libgimp-gimpbuffer.html#gimp-buffer-rename">gimp_buffer_rename</a> (const gchar *buffer_name,
|
|
const gchar *new_name);
|
|
gboolean <a href="libgimp-gimpbuffer.html#gimp-buffer-delete">gimp_buffer_delete</a> (const gchar *buffer_name);
|
|
gint <a href="libgimp-gimpbuffer.html#gimp-buffer-get-width">gimp_buffer_get_width</a> (const gchar *buffer_name);
|
|
gint <a href="libgimp-gimpbuffer.html#gimp-buffer-get-height">gimp_buffer_get_height</a> (const gchar *buffer_name);
|
|
gint <a href="libgimp-gimpbuffer.html#gimp-buffer-get-bytes">gimp_buffer_get_bytes</a> (const gchar *buffer_name);
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageBaseType"
|
|
>GimpImageBaseType</a> <a href="libgimp-gimpbuffer.html#gimp-buffer-get-image-type">gimp_buffer_get_image_type</a>
|
|
(const gchar *buffer_name);
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2602955"></a><h2>Description</h2>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2598303"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2598313"></a><h3>
|
|
<a name="gimp-buffers-get-list"></a>gimp_buffers_get_list ()</h3>
|
|
<a class="indexterm" name="id2598327"></a><pre class="programlisting">gchar** gimp_buffers_get_list (const gchar *filter,
|
|
gint *num_buffers);</pre>
|
|
<p>
|
|
Retrieve a complete listing of the available buffers.
|
|
</p>
|
|
<p>
|
|
This procedure returns a complete listing of available named
|
|
buffers.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>filter</code></em> :</span></td>
|
|
<td> An optional regular expression used to filter the list.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>num_buffers</code></em> :</span></td>
|
|
<td> The number of buffers.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The list of buffer names.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2598418"></a><h3>
|
|
<a name="gimp-buffer-rename"></a>gimp_buffer_rename ()</h3>
|
|
<a class="indexterm" name="id2597086"></a><pre class="programlisting">gchar* gimp_buffer_rename (const gchar *buffer_name,
|
|
const gchar *new_name);</pre>
|
|
<p>
|
|
Renames a named buffer.
|
|
</p>
|
|
<p>
|
|
This procedure renames a named buffer.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>buffer_name</code></em> :</span></td>
|
|
<td> The buffer name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>new_name</code></em> :</span></td>
|
|
<td> The buffer's new name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The real name given to the buffer.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2597176"></a><h3>
|
|
<a name="gimp-buffer-delete"></a>gimp_buffer_delete ()</h3>
|
|
<a class="indexterm" name="id2597190"></a><pre class="programlisting">gboolean gimp_buffer_delete (const gchar *buffer_name);</pre>
|
|
<p>
|
|
Deletes a named buffer.
|
|
</p>
|
|
<p>
|
|
This procedure deletes a named buffer.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>buffer_name</code></em> :</span></td>
|
|
<td> The buffer name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> TRUE on success.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2599599"></a><h3>
|
|
<a name="gimp-buffer-get-width"></a>gimp_buffer_get_width ()</h3>
|
|
<a class="indexterm" name="id2599612"></a><pre class="programlisting">gint gimp_buffer_get_width (const gchar *buffer_name);</pre>
|
|
<p>
|
|
Retrieves the specified buffer's width.
|
|
</p>
|
|
<p>
|
|
This procedure retrieves the specified named buffer's width.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>buffer_name</code></em> :</span></td>
|
|
<td> The buffer name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The buffer width.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2599681"></a><h3>
|
|
<a name="gimp-buffer-get-height"></a>gimp_buffer_get_height ()</h3>
|
|
<a class="indexterm" name="id2599695"></a><pre class="programlisting">gint gimp_buffer_get_height (const gchar *buffer_name);</pre>
|
|
<p>
|
|
Retrieves the specified buffer's height.
|
|
</p>
|
|
<p>
|
|
This procedure retrieves the specified named buffer's height.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>buffer_name</code></em> :</span></td>
|
|
<td> The buffer name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The buffer height.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2599764"></a><h3>
|
|
<a name="gimp-buffer-get-bytes"></a>gimp_buffer_get_bytes ()</h3>
|
|
<a class="indexterm" name="id2599778"></a><pre class="programlisting">gint gimp_buffer_get_bytes (const gchar *buffer_name);</pre>
|
|
<p>
|
|
Retrieves the specified buffer's bytes.
|
|
</p>
|
|
<p>
|
|
This procedure retrieves the specified named buffer's bytes.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>buffer_name</code></em> :</span></td>
|
|
<td> The buffer name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The buffer bpp.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2599847"></a><h3>
|
|
<a name="gimp-buffer-get-image-type"></a>gimp_buffer_get_image_type ()</h3>
|
|
<a class="indexterm" name="id2598760"></a><pre class="programlisting"><a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageBaseType"
|
|
>GimpImageBaseType</a> gimp_buffer_get_image_type
|
|
(const gchar *buffer_name);</pre>
|
|
<p>
|
|
Retrieves the specified buffer's image type.
|
|
</p>
|
|
<p>
|
|
This procedure retrieves the specified named buffer's image type.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>buffer_name</code></em> :</span></td>
|
|
<td> The buffer name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The buffer image type.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|