Files
gimp/devel-docs/libgimp/html/libgimp-gimpimageselect.html
2021-07-18 14:31:43 -04:00

564 lines
30 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpimageselect: GIMP Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manipulating Images and their Properties">
<link rel="prev" href="libgimp-gimpimagesamplepoints.html" title="gimpimagesamplepoints">
<link rel="next" href="libgimp-gimpimagetransform.html" title="gimpimagetransform">
<meta name="generator" content="GTK-Doc V1.33.1 (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-gimpimageselect.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-gimpimagesamplepoints.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimp-gimpimagetransform.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp-gimpimageselect"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp-gimpimageselect.top_of_page"></a>gimpimageselect</span></h2>
<p>gimpimageselect — Modify the image's selection.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp-gimpimageselect.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-color" title="gimp_image_select_color ()">gimp_image_select_color</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-contiguous-color" title="gimp_image_select_contiguous_color ()">gimp_image_select_contiguous_color</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-rectangle" title="gimp_image_select_rectangle ()">gimp_image_select_rectangle</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-round-rectangle" title="gimp_image_select_round_rectangle ()">gimp_image_select_round_rectangle</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-ellipse" title="gimp_image_select_ellipse ()">gimp_image_select_ellipse</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-polygon" title="gimp_image_select_polygon ()">gimp_image_select_polygon</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimpimageselect.html#gimp-image-select-item" title="gimp_image_select_item ()">gimp_image_select_item</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp-gimpimageselect.description"></a><h2>Description</h2>
<p>Functions to modify the image's selection.</p>
</div>
<div class="refsect1">
<a name="libgimp-gimpimageselect.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-image-select-color"></a><h3>gimp_image_select_color ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_image_select_color (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpChannelOps"><span class="type">GimpChannelOps</span></a> operation</code></em>,
<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code>const <a href="../html/libgimpcolor-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *color</code></em>);</pre>
<p>Create a selection by selecting all pixels (in the specified
drawable) with the same (or similar) color to that specified.</p>
<p>This tool creates a selection over the specified image. A by-color
selection is determined by the supplied color under the constraints
of the current context settings. Essentially, all pixels (in the
drawable) that have color sufficiently close to the specified color
(as determined by the threshold and criterion context values) are
included in the selection. To select transparent regions, the color
specified must also have minimum alpha.</p>
<p>This procedure is affected by the following context setters:
<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>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-feather" title="gimp_context_set_feather ()"><code class="function">gimp_context_set_feather()</code></a>,
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-feather-radius" title="gimp_context_set_feather_radius ()"><code class="function">gimp_context_set_feather_radius()</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-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-transparent" title="gimp_context_set_sample_transparent ()"><code class="function">gimp_context_set_sample_transparent()</code></a>.</p>
<p>In the case of a merged sampling, the supplied drawable is ignored.</p>
<div class="refsect3">
<a name="gimp-image-select-color.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>image_ID</p></td>
<td class="parameter_description"><p>The affected image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>operation</p></td>
<td class="parameter_description"><p>The selection operation.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<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>color</p></td>
<td class="parameter_description"><p>The color to select.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-image-select-color.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-select-contiguous-color"></a><h3>gimp_image_select_contiguous_color ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_image_select_contiguous_color (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpChannelOps"><span class="type">GimpChannelOps</span></a> operation</code></em>,
<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y</code></em>);</pre>
<p>Create a selection by selecting all pixels around specified
coordinates with the same (or similar) color to that at the
coordinates.</p>
<p>This tool creates a contiguous selection over the specified image. A
contiguous color selection is determined by a seed fill under the
constraints of the current context settings. Essentially, the color
at the specified coordinates (in the drawable) is measured and the
selection expands outwards from that point to any adjacent pixels
which are not significantly different (as determined by the
threshold and criterion context settings). This process continues
until no more expansion is possible. If antialiasing is turned on,
the final selection mask will contain intermediate values based on
close misses to the threshold bar at pixels along the seed fill
boundary.</p>
<p>This procedure is affected by the following context setters:
<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>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-feather" title="gimp_context_set_feather ()"><code class="function">gimp_context_set_feather()</code></a>,
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-feather-radius" title="gimp_context_set_feather_radius ()"><code class="function">gimp_context_set_feather_radius()</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-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-transparent" title="gimp_context_set_sample_transparent ()"><code class="function">gimp_context_set_sample_transparent()</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>.</p>
<p>In the case of a merged sampling, the supplied drawable is ignored.
If the sample is merged, the specified coordinates are relative to
the image origin; otherwise, they are relative to the drawable's
origin.</p>
<div class="refsect3">
<a name="gimp-image-select-contiguous-color.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>image_ID</p></td>
<td class="parameter_description"><p>The affected image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>operation</p></td>
<td class="parameter_description"><p>The selection operation.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<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>x</p></td>
<td class="parameter_description"><p>x coordinate of initial seed fill point: (image coordinates).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>y coordinate of initial seed fill point: (image coordinates).</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-image-select-contiguous-color.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-select-rectangle"></a><h3>gimp_image_select_rectangle ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_image_select_rectangle (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpChannelOps"><span class="type">GimpChannelOps</span></a> operation</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> width</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> height</code></em>);</pre>
<p>Create a rectangular selection over the specified image;</p>
<p>This tool creates a rectangular selection over the specified image.
The rectangular region can be either added to, subtracted from, or
replace the contents of the previous selection mask.</p>
<p>This procedure is affected by the following context setters:
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-feather" title="gimp_context_set_feather ()"><code class="function">gimp_context_set_feather()</code></a>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-feather-radius" title="gimp_context_set_feather_radius ()"><code class="function">gimp_context_set_feather_radius()</code></a>.</p>
<div class="refsect3">
<a name="gimp-image-select-rectangle.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>image_ID</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>operation</p></td>
<td class="parameter_description"><p>The selection operation.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>x coordinate of upper-left corner of rectangle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>y coordinate of upper-left corner of rectangle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>The width of the rectangle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>The height of the rectangle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-image-select-rectangle.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-select-round-rectangle"></a><h3>gimp_image_select_round_rectangle ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_image_select_round_rectangle (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpChannelOps"><span class="type">GimpChannelOps</span></a> operation</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> width</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> height</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> corner_radius_x</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> corner_radius_y</code></em>);</pre>
<p>Create a rectangular selection with round corners over the specified
image;</p>
<p>This tool creates a rectangular selection with round corners over
the specified image. The rectangular region can be either added to,
subtracted from, or replace the contents of the previous selection
mask.</p>
<p>This procedure is affected by the following context setters:
<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>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-feather" title="gimp_context_set_feather ()"><code class="function">gimp_context_set_feather()</code></a>,
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-feather-radius" title="gimp_context_set_feather_radius ()"><code class="function">gimp_context_set_feather_radius()</code></a>.</p>
<div class="refsect3">
<a name="gimp-image-select-round-rectangle.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>image_ID</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>operation</p></td>
<td class="parameter_description"><p>The selection operation.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>x coordinate of upper-left corner of rectangle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>y coordinate of upper-left corner of rectangle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>The width of the rectangle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>The height of the rectangle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>corner_radius_x</p></td>
<td class="parameter_description"><p>The corner radius in X direction.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>corner_radius_y</p></td>
<td class="parameter_description"><p>The corner radius in Y direction.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-image-select-round-rectangle.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-select-ellipse"></a><h3>gimp_image_select_ellipse ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_image_select_ellipse (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpChannelOps"><span class="type">GimpChannelOps</span></a> operation</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> width</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> height</code></em>);</pre>
<p>Create an elliptical selection over the specified image.</p>
<p>This tool creates an elliptical selection over the specified image.
The elliptical region can be either added to, subtracted from, or
replace the contents of the previous selection mask.</p>
<p>This procedure is affected by the following context setters:
<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>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-feather" title="gimp_context_set_feather ()"><code class="function">gimp_context_set_feather()</code></a>,
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-feather-radius" title="gimp_context_set_feather_radius ()"><code class="function">gimp_context_set_feather_radius()</code></a>.</p>
<div class="refsect3">
<a name="gimp-image-select-ellipse.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>image_ID</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>operation</p></td>
<td class="parameter_description"><p>The selection operation.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>x coordinate of upper-left corner of ellipse bounding box.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>y coordinate of upper-left corner of ellipse bounding box.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>The width of the ellipse.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>The height of the ellipse.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-image-select-ellipse.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-select-polygon"></a><h3>gimp_image_select_polygon ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_image_select_polygon (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpChannelOps"><span class="type">GimpChannelOps</span></a> operation</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_segs</code></em>,
<em class="parameter"><code>const <span class="type">gdouble</span> *segs</code></em>);</pre>
<p>Create a polygonal selection over the specified image.</p>
<p>This tool creates a polygonal selection over the specified image.
The polygonal region can be either added to, subtracted from, or
replace the contents of the previous selection mask. The polygon is
specified through an array of floating point numbers and its length.
The length of array must be 2n, where n is the number of points.
Each point is defined by 2 floating point values which correspond to
the x and y coordinates. If the final point does not connect to the
starting point, a connecting segment is automatically added.</p>
<p>This procedure is affected by the following context setters:
<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>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-feather" title="gimp_context_set_feather ()"><code class="function">gimp_context_set_feather()</code></a>,
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-feather-radius" title="gimp_context_set_feather_radius ()"><code class="function">gimp_context_set_feather_radius()</code></a>.</p>
<div class="refsect3">
<a name="gimp-image-select-polygon.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>image_ID</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>operation</p></td>
<td class="parameter_description"><p>The selection operation.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_segs</p></td>
<td class="parameter_description"><p>Number of points (count 1 coordinate as two points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>segs</p></td>
<td class="parameter_description"><p>Array of points: { p1.x, p1.y, p2.x, p2.y, ..., pn.x, pn.y}.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-image-select-polygon.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-image-select-item"></a><h3>gimp_image_select_item ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_image_select_item (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpChannelOps"><span class="type">GimpChannelOps</span></a> operation</code></em>,
<em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre>
<p>Transforms the specified item into a selection</p>
<p>This procedure renders the item's outline into the current selection
of the image the item belongs to. What exactly the item's outline is
depends on the item type: for layers, it's the layer's alpha
channel, for vectors the vector's shape.</p>
<p>This procedure is affected by the following context setters:
<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>, <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-feather" title="gimp_context_set_feather ()"><code class="function">gimp_context_set_feather()</code></a>,
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-feather-radius" title="gimp_context_set_feather_radius ()"><code class="function">gimp_context_set_feather_radius()</code></a>.</p>
<div class="refsect3">
<a name="gimp-image-select-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>image_ID</p></td>
<td class="parameter_description"><p>The image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>operation</p></td>
<td class="parameter_description"><p>The desired operation with current selection.</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 render to the selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-image-select-item.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>