423 lines
27 KiB
HTML
423 lines
27 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<title>gimpdrawableedit: GIMP Library Reference Manual</title>
|
||
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
|
||
<link rel="home" 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-gimpdrawablecolor.html" title="gimpdrawablecolor">
|
||
<link rel="next" href="libgimp-gimpdrawabletransform.html" title="gimpdrawabletransform">
|
||
<meta name="generator" content="GTK-Doc V1.28 (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="5"><tr valign="middle">
|
||
<td width="100%" align="left" class="shortcuts">
|
||
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
|
||
<a href="#libgimp-gimpdrawableedit.description" class="shortcut">Description</a></span>
|
||
</td>
|
||
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
|
||
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
|
||
<td><a accesskey="p" href="libgimp-gimpdrawablecolor.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||
<td><a accesskey="n" href="libgimp-gimpdrawabletransform.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
|
||
</tr></table>
|
||
<div class="refentry">
|
||
<a name="libgimp-gimpdrawableedit"></a><div class="titlepage"></div>
|
||
<div class="refnamediv"><table width="100%"><tr>
|
||
<td valign="top">
|
||
<h2><span class="refentrytitle"><a name="libgimp-gimpdrawableedit.top_of_page"></a>gimpdrawableedit</span></h2>
|
||
<p>gimpdrawableedit — Drawable edit functions (clear, fill, gradient, stroke etc.)</p>
|
||
</td>
|
||
<td class="gallery_image" valign="top" align="right"></td>
|
||
</tr></table></div>
|
||
<div class="refsect1">
|
||
<a name="libgimp-gimpdrawableedit.functions"></a><h2>Functions</h2>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="functions_return">
|
||
<col class="functions_name">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="libgimp-gimpdrawableedit.html#gimp-drawable-edit-clear" title="gimp_drawable_edit_clear ()">gimp_drawable_edit_clear</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="libgimp-gimpdrawableedit.html#gimp-drawable-edit-fill" title="gimp_drawable_edit_fill ()">gimp_drawable_edit_fill</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="libgimp-gimpdrawableedit.html#gimp-drawable-edit-bucket-fill" title="gimp_drawable_edit_bucket_fill ()">gimp_drawable_edit_bucket_fill</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="libgimp-gimpdrawableedit.html#gimp-drawable-edit-gradient-fill" title="gimp_drawable_edit_gradient_fill ()">gimp_drawable_edit_gradient_fill</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="libgimp-gimpdrawableedit.html#gimp-drawable-edit-stroke-selection" title="gimp_drawable_edit_stroke_selection ()">gimp_drawable_edit_stroke_selection</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="libgimp-gimpdrawableedit.html#gimp-drawable-edit-stroke-item" title="gimp_drawable_edit_stroke_item ()">gimp_drawable_edit_stroke_item</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="libgimp-gimpdrawableedit.description"></a><h2>Description</h2>
|
||
<p>Drawable edit functions (clear, fill, gradient, stroke etc.)</p>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="libgimp-gimpdrawableedit.functions_details"></a><h2>Functions</h2>
|
||
<div class="refsect2">
|
||
<a name="gimp-drawable-edit-clear"></a><h3>gimp_drawable_edit_clear ()</h3>
|
||
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||
gimp_drawable_edit_clear (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> drawable_ID</code></em>);</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>This procedure is affected by the following context setters:
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-background" title="gimp_context_set_background ()"><code class="function">gimp_context_set_background()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gimp-drawable-edit-clear.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" 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>drawable_ID</p></td>
|
||
<td class="parameter_description"><p>The drawable to clear from.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gimp-drawable-edit-clear.returns"></a><h4>Returns</h4>
|
||
<p> TRUE on success.</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-drawable-edit-fill"></a><h3>gimp_drawable_edit_fill ()</h3>
|
||
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||
gimp_drawable_edit_fill (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> drawable_ID</code></em>,
|
||
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpFillType"><span class="type">GimpFillType</span></a> fill_type</code></em>);</pre>
|
||
<p>Fill selected area of drawable.</p>
|
||
<p>This procedure fills the specified drawable according to fill mode.
|
||
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 class="link" href="libgimp-gimpdrawable.html#gimp-drawable-fill" title="gimp_drawable_fill ()"><code class="function">gimp_drawable_fill()</code></a>.</p>
|
||
<p>This procedure is affected by the following context setters:
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-opacity" title="gimp_context_set_opacity ()"><code class="function">gimp_context_set_opacity()</code></a>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-paint-mode" title="gimp_context_set_paint_mode ()"><code class="function">gimp_context_set_paint_mode()</code></a>,
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-foreground" title="gimp_context_set_foreground ()"><code class="function">gimp_context_set_foreground()</code></a>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-background" title="gimp_context_set_background ()"><code class="function">gimp_context_set_background()</code></a>,
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-pattern" title="gimp_context_set_pattern ()"><code class="function">gimp_context_set_pattern()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gimp-drawable-edit-fill.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" 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>drawable_ID</p></td>
|
||
<td class="parameter_description"><p>The drawable to fill to.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>fill_type</p></td>
|
||
<td class="parameter_description"><p>The type of fill.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gimp-drawable-edit-fill.returns"></a><h4>Returns</h4>
|
||
<p> TRUE on success.</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-drawable-edit-bucket-fill"></a><h3>gimp_drawable_edit_bucket_fill ()</h3>
|
||
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||
gimp_drawable_edit_bucket_fill (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> drawable_ID</code></em>,
|
||
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpFillType"><span class="type">GimpFillType</span></a> fill_type</code></em>,
|
||
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x</code></em>,
|
||
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> y</code></em>);</pre>
|
||
<p>Fill the area by a seed fill starting at the specified coordinates.</p>
|
||
<p>This procedure does a seed fill at the specified coordinates, using
|
||
various parameters from the current context.
|
||
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>This procedure is affected by the following context setters:
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-opacity" title="gimp_context_set_opacity ()"><code class="function">gimp_context_set_opacity()</code></a>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-paint-mode" title="gimp_context_set_paint_mode ()"><code class="function">gimp_context_set_paint_mode()</code></a>,
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-foreground" title="gimp_context_set_foreground ()"><code class="function">gimp_context_set_foreground()</code></a>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-background" title="gimp_context_set_background ()"><code class="function">gimp_context_set_background()</code></a>,
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-pattern" title="gimp_context_set_pattern ()"><code class="function">gimp_context_set_pattern()</code></a>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-sample-threshold" title="gimp_context_set_sample_threshold ()"><code class="function">gimp_context_set_sample_threshold()</code></a>,
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-sample-merged" title="gimp_context_set_sample_merged ()"><code class="function">gimp_context_set_sample_merged()</code></a>,
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-sample-criterion" title="gimp_context_set_sample_criterion ()"><code class="function">gimp_context_set_sample_criterion()</code></a>,
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-diagonal-neighbors" title="gimp_context_set_diagonal_neighbors ()"><code class="function">gimp_context_set_diagonal_neighbors()</code></a>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-antialias" title="gimp_context_set_antialias ()"><code class="function">gimp_context_set_antialias()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gimp-drawable-edit-bucket-fill.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" 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>drawable_ID</p></td>
|
||
<td class="parameter_description"><p>The affected drawable.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>fill_type</p></td>
|
||
<td class="parameter_description"><p>The type of fill.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>x</p></td>
|
||
<td class="parameter_description"><p>The x coordinate of this bucket fill's application.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>y</p></td>
|
||
<td class="parameter_description"><p>The y coordinate of this bucket fill's application.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gimp-drawable-edit-bucket-fill.returns"></a><h4>Returns</h4>
|
||
<p> TRUE on success.</p>
|
||
</div>
|
||
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-drawable-edit-gradient-fill"></a><h3>gimp_drawable_edit_gradient_fill ()</h3>
|
||
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||
gimp_drawable_edit_gradient_fill (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> drawable_ID</code></em>,
|
||
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpGradientType"><span class="type">GimpGradientType</span></a> gradient_type</code></em>,
|
||
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> offset</code></em>,
|
||
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> supersample</code></em>,
|
||
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> supersample_max_depth</code></em>,
|
||
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> supersample_threshold</code></em>,
|
||
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> dither</code></em>,
|
||
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x1</code></em>,
|
||
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> y1</code></em>,
|
||
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x2</code></em>,
|
||
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> y2</code></em>);</pre>
|
||
<p>Draw a gradient between the starting and ending coordinates with the
|
||
specified gradient type.</p>
|
||
<p>This tool requires information on the gradient type. It creates the
|
||
specified variety of gradient using the starting and ending
|
||
coordinates as defined for each gradient type. For shapeburst
|
||
gradient types, the context's distance metric is also relevant and
|
||
can be updated with <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-distance-metric" title="gimp_context_set_distance_metric ()"><code class="function">gimp_context_set_distance_metric()</code></a>.</p>
|
||
<p>This procedure is affected by the following context setters:
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-opacity" title="gimp_context_set_opacity ()"><code class="function">gimp_context_set_opacity()</code></a>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-paint-mode" title="gimp_context_set_paint_mode ()"><code class="function">gimp_context_set_paint_mode()</code></a>,
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-foreground" title="gimp_context_set_foreground ()"><code class="function">gimp_context_set_foreground()</code></a>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-background" title="gimp_context_set_background ()"><code class="function">gimp_context_set_background()</code></a>,
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-gradient" title="gimp_context_set_gradient ()"><code class="function">gimp_context_set_gradient()</code></a> and all gradient property settings,
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-distance-metric" title="gimp_context_set_distance_metric ()"><code class="function">gimp_context_set_distance_metric()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gimp-drawable-edit-gradient-fill.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" 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>drawable_ID</p></td>
|
||
<td class="parameter_description"><p>The affected drawable.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>gradient_type</p></td>
|
||
<td class="parameter_description"><p>The type of gradient.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>offset</p></td>
|
||
<td class="parameter_description"><p>Offset relates to the starting and ending coordinates specified for the blend. This parameter is mode dependent.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>supersample</p></td>
|
||
<td class="parameter_description"><p>Do adaptive supersampling.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>supersample_max_depth</p></td>
|
||
<td class="parameter_description"><p>Maximum recursion levels for supersampling.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>supersample_threshold</p></td>
|
||
<td class="parameter_description"><p>Supersampling threshold.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>dither</p></td>
|
||
<td class="parameter_description"><p>Use dithering to reduce banding.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>x1</p></td>
|
||
<td class="parameter_description"><p>The x coordinate of this gradient's starting point.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>y1</p></td>
|
||
<td class="parameter_description"><p>The y coordinate of this gradient's starting point.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>x2</p></td>
|
||
<td class="parameter_description"><p>The x coordinate of this gradient's ending point.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>y2</p></td>
|
||
<td class="parameter_description"><p>The y coordinate of this gradient's ending point.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gimp-drawable-edit-gradient-fill.returns"></a><h4>Returns</h4>
|
||
<p> TRUE on success.</p>
|
||
</div>
|
||
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-drawable-edit-stroke-selection"></a><h3>gimp_drawable_edit_stroke_selection ()</h3>
|
||
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||
gimp_drawable_edit_stroke_selection (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> drawable_ID</code></em>);</pre>
|
||
<p>Stroke the current selection</p>
|
||
<p>This procedure strokes the current selection, painting along the
|
||
selection boundary with the active paint method and brush, or using
|
||
a plain line with configurable properties. The paint is applied to
|
||
the specified drawable regardless of the active selection.</p>
|
||
<p>This procedure is affected by the following context setters:
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-opacity" title="gimp_context_set_opacity ()"><code class="function">gimp_context_set_opacity()</code></a>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-paint-mode" title="gimp_context_set_paint_mode ()"><code class="function">gimp_context_set_paint_mode()</code></a>,
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-paint-method" title="gimp_context_set_paint_method ()"><code class="function">gimp_context_set_paint_method()</code></a>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-stroke-method" title="gimp_context_set_stroke_method ()"><code class="function">gimp_context_set_stroke_method()</code></a>,
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-foreground" title="gimp_context_set_foreground ()"><code class="function">gimp_context_set_foreground()</code></a>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-brush" title="gimp_context_set_brush ()"><code class="function">gimp_context_set_brush()</code></a> and all
|
||
brush property settings, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-gradient" title="gimp_context_set_gradient ()"><code class="function">gimp_context_set_gradient()</code></a> and all
|
||
gradient property settings, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-line-width" title="gimp_context_set_line_width ()"><code class="function">gimp_context_set_line_width()</code></a> and all
|
||
line property settings, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-antialias" title="gimp_context_set_antialias ()"><code class="function">gimp_context_set_antialias()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gimp-drawable-edit-stroke-selection.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" 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>drawable_ID</p></td>
|
||
<td class="parameter_description"><p>The drawable to stroke to.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gimp-drawable-edit-stroke-selection.returns"></a><h4>Returns</h4>
|
||
<p> TRUE on success.</p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-drawable-edit-stroke-item"></a><h3>gimp_drawable_edit_stroke_item ()</h3>
|
||
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
|
||
gimp_drawable_edit_stroke_item (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> drawable_ID</code></em>,
|
||
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> item_ID</code></em>);</pre>
|
||
<p>Stroke the specified item</p>
|
||
<p>This procedure strokes the specified item, painting along its
|
||
outline (e.g. along a path, or along a channel's boundary), with the
|
||
active paint method and brush, or using a plain line with
|
||
configurable properties.</p>
|
||
<p>This procedure is affected by the following context setters:
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-opacity" title="gimp_context_set_opacity ()"><code class="function">gimp_context_set_opacity()</code></a>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-paint-mode" title="gimp_context_set_paint_mode ()"><code class="function">gimp_context_set_paint_mode()</code></a>,
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-paint-method" title="gimp_context_set_paint_method ()"><code class="function">gimp_context_set_paint_method()</code></a>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-stroke-method" title="gimp_context_set_stroke_method ()"><code class="function">gimp_context_set_stroke_method()</code></a>,
|
||
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-foreground" title="gimp_context_set_foreground ()"><code class="function">gimp_context_set_foreground()</code></a>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-brush" title="gimp_context_set_brush ()"><code class="function">gimp_context_set_brush()</code></a> and all
|
||
brush property settings, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-gradient" title="gimp_context_set_gradient ()"><code class="function">gimp_context_set_gradient()</code></a> and all
|
||
gradient property settings, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-line-width" title="gimp_context_set_line_width ()"><code class="function">gimp_context_set_line_width()</code></a> and all
|
||
line property settings, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-antialias" title="gimp_context_set_antialias ()"><code class="function">gimp_context_set_antialias()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gimp-drawable-edit-stroke-item.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" 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>drawable_ID</p></td>
|
||
<td class="parameter_description"><p>The drawable to stroke to.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>item_ID</p></td>
|
||
<td class="parameter_description"><p>The item to stroke.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gimp-drawable-edit-stroke-item.returns"></a><h4>Returns</h4>
|
||
<p> TRUE on success.</p>
|
||
</div>
|
||
<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="libgimp-gimpdrawableedit.other_details"></a><h2>Types and Values</h2>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<hr>Generated by GTK-Doc V1.28</div>
|
||
</body>
|
||
</html> |