865 lines
34 KiB
HTML
865 lines
34 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>gimpedit</title>
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
|
|
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
|
|
<link rel="up" href="libgimp-image.html" title="Manupulating Images and their Properties">
|
|
<link rel="prev" href="libgimp-gimpdrawabletransform.html" title="gimpdrawabletransform">
|
|
<link rel="next" href="libgimp-gimpfileops.html" title="gimpfileops">
|
|
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
|
<link rel="part" href="libgimp.html" title="Part I. 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 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 II. GIMP User Interface Library">
|
|
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
|
|
<link rel="index" href="libgimp-index.html" title="Index">
|
|
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
|
|
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
|
|
<link rel="index" href="libgimp-index-deprecated.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-gimpdrawabletransform.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
|
|
<td><a accesskey="u" href="libgimp-image.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-gimpfileops.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="#id2600292" class="shortcut">Top</a>
|
|
 | 
|
|
<a href="#id2631512" class="shortcut">Description</a></nobr></td></tr>
|
|
</table>
|
|
<div class="refentry" lang="en">
|
|
<a name="libgimp-gimpedit"></a><div class="titlepage"></div>
|
|
<div class="refnamediv"><table width="100%"><tr>
|
|
<td valign="top">
|
|
<h2>
|
|
<a name="id2600292"></a><span class="refentrytitle">gimpedit</span>
|
|
</h2>
|
|
<p>gimpedit — Edit menu functions (cut, copy, paste, clear, etc.)</p>
|
|
</td>
|
|
<td valign="top" align="right"></td>
|
|
</tr></table></div>
|
|
<div class="refsynopsisdiv">
|
|
<h2>Synopsis</h2>
|
|
<pre class="synopsis">
|
|
|
|
|
|
|
|
gboolean <a href="libgimp-gimpedit.html#gimp-edit-cut">gimp_edit_cut</a> (gint32 drawable_ID);
|
|
gboolean <a href="libgimp-gimpedit.html#gimp-edit-copy">gimp_edit_copy</a> (gint32 drawable_ID);
|
|
gboolean <a href="libgimp-gimpedit.html#gimp-edit-copy-visible">gimp_edit_copy_visible</a> (gint32 image_ID);
|
|
gint32 <a href="libgimp-gimpedit.html#gimp-edit-paste">gimp_edit_paste</a> (gint32 drawable_ID,
|
|
gboolean paste_into);
|
|
gint32 <a href="libgimp-gimpedit.html#gimp-edit-paste-as-new">gimp_edit_paste_as_new</a> (void);
|
|
gchar* <a href="libgimp-gimpedit.html#gimp-edit-named-cut">gimp_edit_named_cut</a> (gint32 drawable_ID,
|
|
const gchar *buffer_name);
|
|
gchar* <a href="libgimp-gimpedit.html#gimp-edit-named-copy">gimp_edit_named_copy</a> (gint32 drawable_ID,
|
|
const gchar *buffer_name);
|
|
gchar* <a href="libgimp-gimpedit.html#gimp-edit-named-copy-visible">gimp_edit_named_copy_visible</a> (gint32 image_ID,
|
|
const gchar *buffer_name);
|
|
gint32 <a href="libgimp-gimpedit.html#gimp-edit-named-paste">gimp_edit_named_paste</a> (gint32 drawable_ID,
|
|
const gchar *buffer_name,
|
|
gboolean paste_into);
|
|
gint32 <a href="libgimp-gimpedit.html#gimp-edit-named-paste-as-new">gimp_edit_named_paste_as_new</a> (const gchar *buffer_name);
|
|
gboolean <a href="libgimp-gimpedit.html#gimp-edit-clear">gimp_edit_clear</a> (gint32 drawable_ID);
|
|
gboolean <a href="libgimp-gimpedit.html#gimp-edit-fill">gimp_edit_fill</a> (gint32 drawable_ID,
|
|
<a href="libgimp-gimpenums.html#GimpFillType">GimpFillType</a> fill_type);
|
|
gboolean <a href="libgimp-gimpedit.html#gimp-edit-bucket-fill">gimp_edit_bucket_fill</a> (gint32 drawable_ID,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpBucketFillMode"
|
|
>GimpBucketFillMode</a> fill_mode,
|
|
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
|
|
gdouble opacity,
|
|
gdouble threshold,
|
|
gboolean sample_merged,
|
|
gdouble x,
|
|
gdouble y);
|
|
gboolean <a href="libgimp-gimpedit.html#gimp-edit-blend">gimp_edit_blend</a> (gint32 drawable_ID,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpBlendMode"
|
|
>GimpBlendMode</a> blend_mode,
|
|
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpGradientType"
|
|
>GimpGradientType</a> gradient_type,
|
|
gdouble opacity,
|
|
gdouble offset,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpRepeatMode"
|
|
>GimpRepeatMode</a> repeat,
|
|
gboolean reverse,
|
|
gboolean supersample,
|
|
gint max_depth,
|
|
gdouble threshold,
|
|
gboolean dither,
|
|
gdouble x1,
|
|
gdouble y1,
|
|
gdouble x2,
|
|
gdouble y2);
|
|
gboolean <a href="libgimp-gimpedit.html#gimp-edit-stroke">gimp_edit_stroke</a> (gint32 drawable_ID);
|
|
gboolean <a href="libgimp-gimpedit.html#gimp-edit-stroke-vectors">gimp_edit_stroke_vectors</a> (gint32 drawable_ID,
|
|
gint32 vectors_ID);
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2631512"></a><h2>Description</h2>
|
|
<p>
|
|
Edit menu functions (cut, copy, paste, clear, etc.)
|
|
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2631528"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2631539"></a><h3>
|
|
<a name="gimp-edit-cut"></a>gimp_edit_cut ()</h3>
|
|
<a class="indexterm" name="id2631551"></a><pre class="programlisting">gboolean gimp_edit_cut (gint32 drawable_ID);</pre>
|
|
<p>
|
|
Cut from the specified drawable.
|
|
</p>
|
|
<p>
|
|
If there is a selection in the image, then the area specified by the
|
|
selection is cut from the specified drawable and placed in an
|
|
internal GIMP edit buffer. It can subsequently be retrieved using
|
|
the <a href="libgimp-gimpedit.html#gimp-edit-paste"><code class="function">gimp_edit_paste()</code></a> command. If there is no selection, then the
|
|
specified drawable will be removed and its contents stored in the
|
|
internal GIMP edit 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>drawable_ID</code></em> :</span></td>
|
|
<td> The drawable to cut from.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> TRUE if the cut was successful, FALSE if the selection contained only transparent pixels.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2631631"></a><h3>
|
|
<a name="gimp-edit-copy"></a>gimp_edit_copy ()</h3>
|
|
<a class="indexterm" name="id2631644"></a><pre class="programlisting">gboolean gimp_edit_copy (gint32 drawable_ID);</pre>
|
|
<p>
|
|
Copy from the specified drawable.
|
|
</p>
|
|
<p>
|
|
If there is a selection in the image, then the area specified by the
|
|
selection is copied from the specified drawable and placed in an
|
|
internal GIMP edit buffer. It can subsequently be retrieved using
|
|
the <a href="libgimp-gimpedit.html#gimp-edit-paste"><code class="function">gimp_edit_paste()</code></a> command. If there is no selection, then the
|
|
specified drawable's contents will be stored in the internal GIMP
|
|
edit 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>drawable_ID</code></em> :</span></td>
|
|
<td> The drawable to copy from.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> TRUE if the copy was successful, FALSE if the selection contained only transparent pixels.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2631724"></a><h3>
|
|
<a name="gimp-edit-copy-visible"></a>gimp_edit_copy_visible ()</h3>
|
|
<a class="indexterm" name="id2631737"></a><pre class="programlisting">gboolean gimp_edit_copy_visible (gint32 image_ID);</pre>
|
|
<p>
|
|
Copy from the projection.
|
|
</p>
|
|
<p>
|
|
If there is a selection in the image, then the area specified by the
|
|
selection is copied from the projection and placed in an internal
|
|
GIMP edit buffer. It can subsequently be retrieved using the
|
|
<a href="libgimp-gimpedit.html#gimp-edit-paste"><code class="function">gimp_edit_paste()</code></a> command. If there is no selection, then the
|
|
projection's contents will be stored in the internal GIMP edit
|
|
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>image_ID</code></em> :</span></td>
|
|
<td> The image to copy from.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> TRUE if the copy was successful, FALSE if the selection contained only transparent pixels.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p class="since">Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2631824"></a><h3>
|
|
<a name="gimp-edit-paste"></a>gimp_edit_paste ()</h3>
|
|
<a class="indexterm" name="id2631836"></a><pre class="programlisting">gint32 gimp_edit_paste (gint32 drawable_ID,
|
|
gboolean paste_into);</pre>
|
|
<p>
|
|
Paste buffer to the specified drawable.
|
|
</p>
|
|
<p>
|
|
This procedure pastes a copy of the internal GIMP edit buffer to the
|
|
specified drawable. The GIMP edit buffer will be empty unless a call
|
|
was previously made to either <a href="libgimp-gimpedit.html#gimp-edit-cut"><code class="function">gimp_edit_cut()</code></a> or <a href="libgimp-gimpedit.html#gimp-edit-copy"><code class="function">gimp_edit_copy()</code></a>.
|
|
The \"paste_into\" option specifies whether to clear the current
|
|
image selection, or to paste the buffer \"behind\" the selection.
|
|
This allows the selection to act as a mask for the pasted buffer.
|
|
Anywhere that the selection mask is non-zero, the pasted buffer will
|
|
show through. The pasted buffer will be a new layer in the image
|
|
which is designated as the image floating selection. If the image
|
|
has a floating selection at the time of pasting, the old floating
|
|
selection will be anchored to it's drawable before the new floating
|
|
selection is added. This procedure returns the new floating layer.
|
|
The resulting floating selection will already be attached to the
|
|
specified drawable, and a subsequent call to floating_sel_attach is
|
|
not needed.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></td>
|
|
<td> The drawable to paste to.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>paste_into</code></em> :</span></td>
|
|
<td> Clear selection, or paste behind it?
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The new floating selection.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2620358"></a><h3>
|
|
<a name="gimp-edit-paste-as-new"></a>gimp_edit_paste_as_new ()</h3>
|
|
<a class="indexterm" name="id2620371"></a><pre class="programlisting">gint32 gimp_edit_paste_as_new (void);</pre>
|
|
<p>
|
|
Paste buffer to a new image.
|
|
</p>
|
|
<p>
|
|
This procedure pastes a copy of the internal GIMP edit buffer to a
|
|
new image. The GIMP edit buffer will be empty unless a call was
|
|
previously made to either <a href="libgimp-gimpedit.html#gimp-edit-cut"><code class="function">gimp_edit_cut()</code></a> or <a href="libgimp-gimpedit.html#gimp-edit-copy"><code class="function">gimp_edit_copy()</code></a>. This
|
|
procedure returns the new image or -1 if the edit buffer was empty.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody><tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The new image.
|
|
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
<p class="since">Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2620445"></a><h3>
|
|
<a name="gimp-edit-named-cut"></a>gimp_edit_named_cut ()</h3>
|
|
<a class="indexterm" name="id2620459"></a><pre class="programlisting">gchar* gimp_edit_named_cut (gint32 drawable_ID,
|
|
const gchar *buffer_name);</pre>
|
|
<p>
|
|
Cut into a named buffer.
|
|
</p>
|
|
<p>
|
|
This procedure works like <a href="libgimp-gimpedit.html#gimp-edit-cut"><code class="function">gimp_edit_cut()</code></a>, but additionally stores
|
|
the cut buffer into a named buffer that will stay available for
|
|
later pasting, regardless of any intermediate copy or cut
|
|
operations.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></td>
|
|
<td> The drawable to cut from.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>buffer_name</code></em> :</span></td>
|
|
<td> The name of the buffer to create.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The real name given to the buffer, or NULL if the selection contained only transparent pixels.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p class="since">Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2620565"></a><h3>
|
|
<a name="gimp-edit-named-copy"></a>gimp_edit_named_copy ()</h3>
|
|
<a class="indexterm" name="id2620578"></a><pre class="programlisting">gchar* gimp_edit_named_copy (gint32 drawable_ID,
|
|
const gchar *buffer_name);</pre>
|
|
<p>
|
|
Copy into a named buffer.
|
|
</p>
|
|
<p>
|
|
This procedure works like <a href="libgimp-gimpedit.html#gimp-edit-copy"><code class="function">gimp_edit_copy()</code></a>, but additionally stores
|
|
the copied buffer into a named buffer that will stay available for
|
|
later pasting, regardless of any intermediate copy or cut
|
|
operations.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></td>
|
|
<td> The drawable to copy from.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>buffer_name</code></em> :</span></td>
|
|
<td> The name of the buffer to create.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The real name given to the buffer, or NULL if the selection contained only transparent pixels.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p class="since">Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2620683"></a><h3>
|
|
<a name="gimp-edit-named-copy-visible"></a>gimp_edit_named_copy_visible ()</h3>
|
|
<a class="indexterm" name="id2620697"></a><pre class="programlisting">gchar* gimp_edit_named_copy_visible (gint32 image_ID,
|
|
const gchar *buffer_name);</pre>
|
|
<p>
|
|
Copy from the projection into a named buffer.
|
|
</p>
|
|
<p>
|
|
This procedure works like <a href="libgimp-gimpedit.html#gimp-edit-copy-visible"><code class="function">gimp_edit_copy_visible()</code></a>, but additionally
|
|
stores the copied buffer into a named buffer that will stay
|
|
available for later pasting, regardless of any intermediate copy or
|
|
cut operations.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
|
|
<td> The image to copy from.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>buffer_name</code></em> :</span></td>
|
|
<td> The name of the buffer to create.
|
|
</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 class="since">Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2620800"></a><h3>
|
|
<a name="gimp-edit-named-paste"></a>gimp_edit_named_paste ()</h3>
|
|
<a class="indexterm" name="id2620814"></a><pre class="programlisting">gint32 gimp_edit_named_paste (gint32 drawable_ID,
|
|
const gchar *buffer_name,
|
|
gboolean paste_into);</pre>
|
|
<p>
|
|
Paste named buffer to the specified drawable.
|
|
</p>
|
|
<p>
|
|
This procedure works like <a href="libgimp-gimpedit.html#gimp-edit-paste"><code class="function">gimp_edit_paste()</code></a> but pastes a named
|
|
buffer instead of the global 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>drawable_ID</code></em> :</span></td>
|
|
<td> The drawable to paste to.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>buffer_name</code></em> :</span></td>
|
|
<td> The name of the buffer to paste.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>paste_into</code></em> :</span></td>
|
|
<td> Clear selection, or paste behind it?
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The new floating selection.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p class="since">Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2620937"></a><h3>
|
|
<a name="gimp-edit-named-paste-as-new"></a>gimp_edit_named_paste_as_new ()</h3>
|
|
<a class="indexterm" name="id2620953"></a><pre class="programlisting">gint32 gimp_edit_named_paste_as_new (const gchar *buffer_name);</pre>
|
|
<p>
|
|
Paste named buffer to a new image.
|
|
</p>
|
|
<p>
|
|
This procedure works like <a href="libgimp-gimpedit.html#gimp-edit-paste-as-new"><code class="function">gimp_edit_paste_as_new()</code></a> but pastes a
|
|
named buffer instead of the global 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 name of the buffer to paste.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The new image.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p class="since">Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2621034"></a><h3>
|
|
<a name="gimp-edit-clear"></a>gimp_edit_clear ()</h3>
|
|
<a class="indexterm" name="id2621047"></a><pre class="programlisting">gboolean gimp_edit_clear (gint32 drawable_ID);</pre>
|
|
<p>
|
|
Clear selected area of drawable.
|
|
</p>
|
|
<p>
|
|
This procedure clears the specified drawable. If the drawable has an
|
|
alpha channel, the cleared pixels will become transparent. If the
|
|
drawable does not have an alpha channel, cleared pixels will be set
|
|
to the background color. This procedure only affects regions within
|
|
a selection if there is a selection active.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></td>
|
|
<td> The drawable to clear from.
|
|
</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>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2621117"></a><h3>
|
|
<a name="gimp-edit-fill"></a>gimp_edit_fill ()</h3>
|
|
<a class="indexterm" name="id2621129"></a><pre class="programlisting">gboolean gimp_edit_fill (gint32 drawable_ID,
|
|
<a href="libgimp-gimpenums.html#GimpFillType">GimpFillType</a> fill_type);</pre>
|
|
<p>
|
|
Fill selected area of drawable.
|
|
</p>
|
|
<p>
|
|
This procedure fills the specified drawable with the fill mode. If
|
|
the fill mode is foreground, the current foreground color is used.
|
|
If the fill mode is background, the current background color is
|
|
used. Other fill modes should not be used. This procedure only
|
|
affects regions within a selection if there is a selection active.
|
|
If you want to fill the whole drawable, regardless of the selection,
|
|
use <a href="libgimp-gimpdrawable.html#gimp-drawable-fill"><code class="function">gimp_drawable_fill()</code></a>.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></td>
|
|
<td> The drawable to fill to.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>fill_type</code></em> :</span></td>
|
|
<td> The type of fill.
|
|
</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>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2621231"></a><h3>
|
|
<a name="gimp-edit-bucket-fill"></a>gimp_edit_bucket_fill ()</h3>
|
|
<a class="indexterm" name="id2621242"></a><pre class="programlisting">gboolean gimp_edit_bucket_fill (gint32 drawable_ID,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpBucketFillMode"
|
|
>GimpBucketFillMode</a> fill_mode,
|
|
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
|
|
gdouble opacity,
|
|
gdouble threshold,
|
|
gboolean sample_merged,
|
|
gdouble x,
|
|
gdouble y);</pre>
|
|
<p>
|
|
Fill the area specified either by the current selection if there is
|
|
one, or by a seed fill starting at the specified coordinates.
|
|
</p>
|
|
<p>
|
|
This tool requires information on the paint application mode, and
|
|
the fill mode, which can either be in the foreground color, or in
|
|
the currently active pattern. If there is no selection, a seed fill
|
|
is executed at the specified coordinates and extends outward in
|
|
keeping with the threshold parameter. If there is a selection in the
|
|
target image, the threshold, sample merged, x, and y arguments are
|
|
unused. If the sample_merged parameter is TRUE, the data of the
|
|
composite image will be used instead of that for the specified
|
|
drawable. This is equivalent to sampling for colors after merging
|
|
all visible layers. In the case of merged sampling, the x and y
|
|
coordinates are relative to the image's origin; otherwise, they are
|
|
relative to the drawable's origin.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></td>
|
|
<td> The affected drawable.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>fill_mode</code></em> :</span></td>
|
|
<td> The type of fill.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
|
|
<td> The paint application mode.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
|
|
<td> The opacity of the final bucket fill.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>threshold</code></em> :</span></td>
|
|
<td> The threshold determines how extensive the seed fill will be. It's value is specified in terms of intensity levels. This parameter is only valid when there is no selection in the specified image.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>sample_merged</code></em> :</span></td>
|
|
<td> Use the composite image, not the drawable.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>x</code></em> :</span></td>
|
|
<td> The x coordinate of this bucket fill's application. This parameter is only valid when there is no selection in the specified image.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>y</code></em> :</span></td>
|
|
<td> The y coordinate of this bucket fill's application. This parameter is only valid when there is no selection in the specified image.
|
|
</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>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2621478"></a><h3>
|
|
<a name="gimp-edit-blend"></a>gimp_edit_blend ()</h3>
|
|
<a class="indexterm" name="id2621490"></a><pre class="programlisting">gboolean gimp_edit_blend (gint32 drawable_ID,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpBlendMode"
|
|
>GimpBlendMode</a> blend_mode,
|
|
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpGradientType"
|
|
>GimpGradientType</a> gradient_type,
|
|
gdouble opacity,
|
|
gdouble offset,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpRepeatMode"
|
|
>GimpRepeatMode</a> repeat,
|
|
gboolean reverse,
|
|
gboolean supersample,
|
|
gint max_depth,
|
|
gdouble threshold,
|
|
gboolean dither,
|
|
gdouble x1,
|
|
gdouble y1,
|
|
gdouble x2,
|
|
gdouble y2);</pre>
|
|
<p>
|
|
Blend between the starting and ending coordinates with the specified
|
|
blend mode and gradient type.
|
|
</p>
|
|
<p>
|
|
This tool requires information on the paint application mode, the
|
|
blend mode, and the gradient type. It creates the specified variety
|
|
of blend using the starting and ending coordinates as defined for
|
|
each gradient 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>drawable_ID</code></em> :</span></td>
|
|
<td> The affected drawable.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>blend_mode</code></em> :</span></td>
|
|
<td> The type of blend.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
|
|
<td> The paint application mode.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>gradient_type</code></em> :</span></td>
|
|
<td> The type of gradient.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
|
|
<td> The opacity of the final blend.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>offset</code></em> :</span></td>
|
|
<td> Offset relates to the starting and ending coordinates specified for the blend. This parameter is mode dependent.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>repeat</code></em> :</span></td>
|
|
<td> Repeat mode.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>reverse</code></em> :</span></td>
|
|
<td> Use the reverse gradient.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>supersample</code></em> :</span></td>
|
|
<td> Do adaptive supersampling.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>max_depth</code></em> :</span></td>
|
|
<td> Maximum recursion levels for supersampling.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>threshold</code></em> :</span></td>
|
|
<td> Supersampling threshold.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>dither</code></em> :</span></td>
|
|
<td> Use dithering to reduce banding.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>x1</code></em> :</span></td>
|
|
<td> The x coordinate of this blend's starting point.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>y1</code></em> :</span></td>
|
|
<td> The y coordinate of this blend's starting point.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>x2</code></em> :</span></td>
|
|
<td> The x coordinate of this blend's ending point.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>y2</code></em> :</span></td>
|
|
<td> The y coordinate of this blend's ending point.
|
|
</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>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2621885"></a><h3>
|
|
<a name="gimp-edit-stroke"></a>gimp_edit_stroke ()</h3>
|
|
<a class="indexterm" name="id2621897"></a><pre class="programlisting">gboolean gimp_edit_stroke (gint32 drawable_ID);</pre>
|
|
<p>
|
|
Stroke the current selection
|
|
</p>
|
|
<p>
|
|
This procedure strokes the current selection, painting along the
|
|
selection boundary with the active brush and foreground color. The
|
|
paint is applied to the specified drawable regardless of the active
|
|
selection.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></td>
|
|
<td> The drawable to stroke to.
|
|
</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>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2621966"></a><h3>
|
|
<a name="gimp-edit-stroke-vectors"></a>gimp_edit_stroke_vectors ()</h3>
|
|
<a class="indexterm" name="id2621979"></a><pre class="programlisting">gboolean gimp_edit_stroke_vectors (gint32 drawable_ID,
|
|
gint32 vectors_ID);</pre>
|
|
<p>
|
|
Stroke the specified vectors object
|
|
</p>
|
|
<p>
|
|
This procedure strokes the specified vectors object, painting along
|
|
the path with the active brush and foreground color.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></td>
|
|
<td> The drawable to stroke to.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>vectors_ID</code></em> :</span></td>
|
|
<td> The vectors object.
|
|
</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 class="since">Since GIMP 2.4
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|