← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/html/libgimp-gimpselection.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/html/libgimp-gimpselection.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gimpselection</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
7
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
8
 
<link rel="up" href="libgimp-image.html" title="Manupulating Images and all their Properties">
 
8
<link rel="up" href="libgimp-image.html" title="Manupulating Images and their Properties">
9
9
<link rel="prev" href="libgimp-gimpregioniterator.html" title="gimpregioniterator">
10
10
<link rel="next" href="libgimp-gimptexttool.html" title="gimptexttool">
11
 
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
14
 
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;GIMP Library">
 
13
<link rel="part" href="libgimp.html" title="Part&#160;I.&#160;GIMP Library">
15
14
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
16
 
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
 
15
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
17
16
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
18
17
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
19
 
<link rel="part" href="libgimpui.html" title="Part&#160;III.&#160;GIMP User Interface Library">
 
18
<link rel="part" href="libgimpui.html" title="Part&#160;II.&#160;GIMP User Interface Library">
20
19
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
 
20
<link rel="index" href="libgimp-index.html" title="Index">
 
21
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
 
22
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
 
23
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
21
24
</head>
22
25
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
23
26
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
28
31
<th width="100%" align="center">GIMP Library Reference Manual</th>
29
32
<td><a accesskey="n" href="libgimp-gimptexttool.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
30
33
</tr>
31
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2566315" class="shortcut">Top</a>
 
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2594198" class="shortcut">Top</a>
32
35
                  &#160;|&#160;
33
 
                  <a href="#id2619523" class="shortcut">Description</a></nobr></td></tr>
 
36
                  <a href="#id2660756" class="shortcut">Description</a></nobr></td></tr>
34
37
</table>
35
38
<div class="refentry" lang="en">
36
39
<a name="libgimp-gimpselection"></a><div class="titlepage"></div>
37
40
<div class="refnamediv"><table width="100%"><tr>
38
41
<td valign="top">
39
42
<h2>
40
 
<a name="id2566315"></a><span class="refentrytitle">gimpselection</span>
 
43
<a name="id2594198"></a><span class="refentrytitle">gimpselection</span>
41
44
</h2>
42
45
<p>gimpselection &#8212; Functions for manipulating selections.</p>
43
46
</td>
49
52
 
50
53
 
51
54
 
52
 
gboolean    <a href="libgimp-gimpselection.html#gimp-selection-bounds">gimp_selection_bounds</a>           (gint32 image_ID,
53
 
                                             gboolean *non_empty,
54
 
                                             gint *x1,
55
 
                                             gint *y1,
56
 
                                             gint *x2,
57
 
                                             gint *y2);
58
 
gboolean    <a href="libgimp-gimpselection.html#gimp-selection-all">gimp_selection_all</a>              (gint32 image_ID);
59
 
gboolean    <a href="libgimp-gimpselection.html#gimp-selection-none">gimp_selection_none</a>             (gint32 image_ID);
60
 
gboolean    <a href="libgimp-gimpselection.html#gimp-selection-clear">gimp_selection_clear</a>            (gint32 image_ID);
61
 
gboolean    <a href="libgimp-gimpselection.html#gimp-selection-is-empty">gimp_selection_is_empty</a>         (gint32 image_ID);
62
 
gint32      <a href="libgimp-gimpselection.html#gimp-selection-float">gimp_selection_float</a>            (gint32 image_ID,
63
 
                                             gint32 drawable_ID,
64
 
                                             gint offx,
65
 
                                             gint offy);
66
 
gboolean    <a href="libgimp-gimpselection.html#gimp-selection-load">gimp_selection_load</a>             (gint32 channel_ID);
67
 
gint32      <a href="libgimp-gimpselection.html#gimp-selection-save">gimp_selection_save</a>             (gint32 image_ID);
68
 
gint        <a href="libgimp-gimpselection.html#gimp-selection-value">gimp_selection_value</a>            (gint32 image_ID,
69
 
                                             gint x,
70
 
                                             gint y);
71
 
gboolean    <a href="libgimp-gimpselection.html#gimp-selection-grow">gimp_selection_grow</a>             (gint32 image_ID,
72
 
                                             gint steps);
73
 
gboolean    <a href="libgimp-gimpselection.html#gimp-selection-shrink">gimp_selection_shrink</a>           (gint32 image_ID,
74
 
                                             gint radius);
75
 
gboolean    <a href="libgimp-gimpselection.html#gimp-selection-invert">gimp_selection_invert</a>           (gint32 image_ID);
76
 
gboolean    <a href="libgimp-gimpselection.html#gimp-selection-feather">gimp_selection_feather</a>          (gint32 image_ID,
77
 
                                             gdouble radius);
78
 
gboolean    <a href="libgimp-gimpselection.html#gimp-selection-sharpen">gimp_selection_sharpen</a>          (gint32 image_ID);
79
 
gboolean    <a href="libgimp-gimpselection.html#gimp-selection-border">gimp_selection_border</a>           (gint32 image_ID,
80
 
                                             gint radius);
81
 
gboolean    <a href="libgimp-gimpselection.html#gimp-selection-translate">gimp_selection_translate</a>        (gint32 image_ID,
82
 
                                             gint offx,
83
 
                                             gint offy);
84
 
gboolean    <a href="libgimp-gimpselection.html#gimp-selection-layer-alpha">gimp_selection_layer_alpha</a>      (gint32 layer_ID);
85
 
gboolean    <a href="libgimp-gimpselection.html#gimp-selection-combine">gimp_selection_combine</a>          (gint32 channel_ID,
86
 
                                             <a href="libgimp-gimpenums.html#GimpChannelOps">GimpChannelOps</a> operation);
 
55
gboolean            <a href="libgimp-gimpselection.html#gimp-selection-bounds">gimp_selection_bounds</a>               (gint32 image_ID,
 
56
                                                         gboolean *non_empty,
 
57
                                                         gint *x1,
 
58
                                                         gint *y1,
 
59
                                                         gint *x2,
 
60
                                                         gint *y2);
 
61
gboolean            <a href="libgimp-gimpselection.html#gimp-selection-all">gimp_selection_all</a>                  (gint32 image_ID);
 
62
gboolean            <a href="libgimp-gimpselection.html#gimp-selection-none">gimp_selection_none</a>                 (gint32 image_ID);
 
63
gboolean            <a href="libgimp-gimpselection.html#gimp-selection-clear">gimp_selection_clear</a>                (gint32 image_ID);
 
64
gboolean            <a href="libgimp-gimpselection.html#gimp-selection-is-empty">gimp_selection_is_empty</a>             (gint32 image_ID);
 
65
gint32              <a href="libgimp-gimpselection.html#gimp-selection-float">gimp_selection_float</a>                (gint32 image_ID,
 
66
                                                         gint32 drawable_ID,
 
67
                                                         gint offx,
 
68
                                                         gint offy);
 
69
gboolean            <a href="libgimp-gimpselection.html#gimp-selection-load">gimp_selection_load</a>                 (gint32 channel_ID);
 
70
gint32              <a href="libgimp-gimpselection.html#gimp-selection-save">gimp_selection_save</a>                 (gint32 image_ID);
 
71
gint                <a href="libgimp-gimpselection.html#gimp-selection-value">gimp_selection_value</a>                (gint32 image_ID,
 
72
                                                         gint x,
 
73
                                                         gint y);
 
74
gboolean            <a href="libgimp-gimpselection.html#gimp-selection-grow">gimp_selection_grow</a>                 (gint32 image_ID,
 
75
                                                         gint steps);
 
76
gboolean            <a href="libgimp-gimpselection.html#gimp-selection-shrink">gimp_selection_shrink</a>               (gint32 image_ID,
 
77
                                                         gint steps);
 
78
gboolean            <a href="libgimp-gimpselection.html#gimp-selection-invert">gimp_selection_invert</a>               (gint32 image_ID);
 
79
gboolean            <a href="libgimp-gimpselection.html#gimp-selection-feather">gimp_selection_feather</a>              (gint32 image_ID,
 
80
                                                         gdouble radius);
 
81
gboolean            <a href="libgimp-gimpselection.html#gimp-selection-sharpen">gimp_selection_sharpen</a>              (gint32 image_ID);
 
82
gboolean            <a href="libgimp-gimpselection.html#gimp-selection-border">gimp_selection_border</a>               (gint32 image_ID,
 
83
                                                         gint radius);
 
84
gboolean            <a href="libgimp-gimpselection.html#gimp-selection-translate">gimp_selection_translate</a>            (gint32 image_ID,
 
85
                                                         gint offx,
 
86
                                                         gint offy);
 
87
gboolean            <a href="libgimp-gimpselection.html#gimp-selection-layer-alpha">gimp_selection_layer_alpha</a>          (gint32 layer_ID);
 
88
gboolean            <a href="libgimp-gimpselection.html#gimp-selection-combine">gimp_selection_combine</a>              (gint32 channel_ID,
 
89
                                                         <a
 
90
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelOps"
 
91
>GimpChannelOps</a> operation);
87
92
</pre>
88
93
</div>
89
94
<div class="refsect1" lang="en">
90
 
<a name="id2619523"></a><h2>Description</h2>
 
95
<a name="id2660756"></a><h2>Description</h2>
91
96
<p>
92
97
Functions for manipulating selections.
93
98
 
94
99
</p>
95
100
</div>
96
101
<div class="refsect1" lang="en">
97
 
<a name="id2619539"></a><h2>Details</h2>
 
102
<a name="id2660772"></a><h2>Details</h2>
98
103
<div class="refsect2" lang="en">
99
 
<a name="id2619549"></a><h3>
 
104
<a name="id2660782"></a><h3>
100
105
<a name="gimp-selection-bounds"></a>gimp_selection_bounds ()</h3>
101
 
<a class="indexterm" name="id2619561"></a><pre class="programlisting">gboolean    gimp_selection_bounds           (gint32 image_ID,
102
 
                                             gboolean *non_empty,
103
 
                                             gint *x1,
104
 
                                             gint *y1,
105
 
                                             gint *x2,
106
 
                                             gint *y2);</pre>
 
106
<a class="indexterm" name="id2664489"></a><pre class="programlisting">gboolean            gimp_selection_bounds               (gint32 image_ID,
 
107
                                                         gboolean *non_empty,
 
108
                                                         gint *x1,
 
109
                                                         gint *y1,
 
110
                                                         gint *x2,
 
111
                                                         gint *y2);</pre>
107
112
<p>
108
113
Find the bounding box of the current selection.
109
114
</p>
123
128
<col align="left" valign="top">
124
129
<tbody>
125
130
<tr>
126
 
<td>
127
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
131
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
128
132
<td> The image.
129
133
</td>
130
134
</tr>
131
135
<tr>
132
 
<td>
133
 
<span class="term"><em class="parameter"><code>non_empty</code></em>&#160;:</span></td>
134
 
<td> True if there is a selection.
 
136
<td><span class="term"><em class="parameter"><code>non_empty</code></em>&#160;:</span></td>
 
137
<td> TRUE if there is a selection.
135
138
</td>
136
139
</tr>
137
140
<tr>
138
 
<td>
139
 
<span class="term"><em class="parameter"><code>x1</code></em>&#160;:</span></td>
 
141
<td><span class="term"><em class="parameter"><code>x1</code></em>&#160;:</span></td>
140
142
<td> x coordinate of upper left corner of selection bounds.
141
143
</td>
142
144
</tr>
143
145
<tr>
144
 
<td>
145
 
<span class="term"><em class="parameter"><code>y1</code></em>&#160;:</span></td>
 
146
<td><span class="term"><em class="parameter"><code>y1</code></em>&#160;:</span></td>
146
147
<td> y coordinate of upper left corner of selection bounds.
147
148
</td>
148
149
</tr>
149
150
<tr>
150
 
<td>
151
 
<span class="term"><em class="parameter"><code>x2</code></em>&#160;:</span></td>
 
151
<td><span class="term"><em class="parameter"><code>x2</code></em>&#160;:</span></td>
152
152
<td> x coordinate of lower right corner of selection bounds.
153
153
</td>
154
154
</tr>
155
155
<tr>
156
 
<td>
157
 
<span class="term"><em class="parameter"><code>y2</code></em>&#160;:</span></td>
 
156
<td><span class="term"><em class="parameter"><code>y2</code></em>&#160;:</span></td>
158
157
<td> y coordinate of lower right corner of selection bounds.
159
158
</td>
160
159
</tr>
161
160
<tr>
162
 
<td>
163
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
161
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
164
162
<td> TRUE on success.
165
163
</td>
166
164
</tr>
169
167
</div>
170
168
<hr>
171
169
<div class="refsect2" lang="en">
172
 
<a name="id2617295"></a><h3>
 
170
<a name="id2664671"></a><h3>
173
171
<a name="gimp-selection-all"></a>gimp_selection_all ()</h3>
174
 
<a class="indexterm" name="id2617307"></a><pre class="programlisting">gboolean    gimp_selection_all              (gint32 image_ID);</pre>
 
172
<a class="indexterm" name="id2664683"></a><pre class="programlisting">gboolean            gimp_selection_all                  (gint32 image_ID);</pre>
175
173
<p>
176
174
Select all of the image.
177
175
</p>
185
183
<col align="left" valign="top">
186
184
<tbody>
187
185
<tr>
188
 
<td>
189
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
186
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
190
187
<td> The image.
191
188
</td>
192
189
</tr>
193
190
<tr>
194
 
<td>
195
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
191
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
196
192
<td> TRUE on success.
197
193
</td>
198
194
</tr>
201
197
</div>
202
198
<hr>
203
199
<div class="refsect2" lang="en">
204
 
<a name="id2617372"></a><h3>
 
200
<a name="id2649887"></a><h3>
205
201
<a name="gimp-selection-none"></a>gimp_selection_none ()</h3>
206
 
<a class="indexterm" name="id2617384"></a><pre class="programlisting">gboolean    gimp_selection_none             (gint32 image_ID);</pre>
 
202
<a class="indexterm" name="id2649899"></a><pre class="programlisting">gboolean            gimp_selection_none                 (gint32 image_ID);</pre>
207
203
<p>
208
204
Deselect the entire image.
209
205
</p>
217
213
<col align="left" valign="top">
218
214
<tbody>
219
215
<tr>
220
 
<td>
221
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
216
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
222
217
<td> The image.
223
218
</td>
224
219
</tr>
225
220
<tr>
226
 
<td>
227
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
221
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
228
222
<td> TRUE on success.
229
223
</td>
230
224
</tr>
233
227
</div>
234
228
<hr>
235
229
<div class="refsect2" lang="en">
236
 
<a name="id2617448"></a><h3>
 
230
<a name="id2649965"></a><h3>
237
231
<a name="gimp-selection-clear"></a>gimp_selection_clear ()</h3>
238
 
<a class="indexterm" name="id2617462"></a><pre class="programlisting">gboolean    gimp_selection_clear            (gint32 image_ID);</pre>
 
232
<a class="indexterm" name="id2649978"></a><pre class="programlisting">gboolean            gimp_selection_clear                (gint32 image_ID);</pre>
239
233
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
240
234
<h3 class="title">Warning</h3>
241
235
<p><code class="literal">gimp_selection_clear</code> is deprecated and should not be used in newly-written code.</p>
249
243
<col align="left" valign="top">
250
244
<tbody>
251
245
<tr>
252
 
<td>
253
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
246
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
254
247
<td> The image.
255
248
</td>
256
249
</tr>
257
250
<tr>
258
 
<td>
259
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
251
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
260
252
<td> TRUE on success.
261
253
</td>
262
254
</tr>
265
257
</div>
266
258
<hr>
267
259
<div class="refsect2" lang="en">
268
 
<a name="id2624084"></a><h3>
 
260
<a name="id2650060"></a><h3>
269
261
<a name="gimp-selection-is-empty"></a>gimp_selection_is_empty ()</h3>
270
 
<a class="indexterm" name="id2624094"></a><pre class="programlisting">gboolean    gimp_selection_is_empty         (gint32 image_ID);</pre>
 
262
<a class="indexterm" name="id2650071"></a><pre class="programlisting">gboolean            gimp_selection_is_empty             (gint32 image_ID);</pre>
271
263
<p>
272
264
Determine whether the selection is empty.
273
265
</p>
274
266
<p>
275
 
This procedure returns non-zero if the selection for the specified
276
 
image is not empty.</p>
 
267
This procedure returns TRUE if the selection for the specified image
 
268
is not empty.</p>
277
269
<p>
278
270
 
279
271
</p>
281
273
<col align="left" valign="top">
282
274
<tbody>
283
275
<tr>
284
 
<td>
285
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
276
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
286
277
<td> The image.
287
278
</td>
288
279
</tr>
289
280
<tr>
290
 
<td>
291
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
281
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
292
282
<td> Is the selection empty?
293
283
</td>
294
284
</tr>
297
287
</div>
298
288
<hr>
299
289
<div class="refsect2" lang="en">
300
 
<a name="id2624153"></a><h3>
 
290
<a name="id2650135"></a><h3>
301
291
<a name="gimp-selection-float"></a>gimp_selection_float ()</h3>
302
 
<a class="indexterm" name="id2624163"></a><pre class="programlisting">gint32      gimp_selection_float            (gint32 image_ID,
303
 
                                             gint32 drawable_ID,
304
 
                                             gint offx,
305
 
                                             gint offy);</pre>
 
292
<a class="indexterm" name="id2650147"></a><pre class="programlisting">gint32              gimp_selection_float                (gint32 image_ID,
 
293
                                                         gint32 drawable_ID,
 
294
                                                         gint offx,
 
295
                                                         gint offy);</pre>
306
296
<p>
307
297
Float the selection from the specified drawable with initial offsets
308
298
as specified.
320
310
<col align="left" valign="top">
321
311
<tbody>
322
312
<tr>
323
 
<td>
324
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
313
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
325
314
<td> ignored
326
315
</td>
327
316
</tr>
328
317
<tr>
329
 
<td>
330
 
<span class="term"><em class="parameter"><code>drawable_ID</code></em>&#160;:</span></td>
 
318
<td><span class="term"><em class="parameter"><code>drawable_ID</code></em>&#160;:</span></td>
331
319
<td> The drawable from which to float selection.
332
320
</td>
333
321
</tr>
334
322
<tr>
335
 
<td>
336
 
<span class="term"><em class="parameter"><code>offx</code></em>&#160;:</span></td>
 
323
<td><span class="term"><em class="parameter"><code>offx</code></em>&#160;:</span></td>
337
324
<td> x offset for translation.
338
325
</td>
339
326
</tr>
340
327
<tr>
341
 
<td>
342
 
<span class="term"><em class="parameter"><code>offy</code></em>&#160;:</span></td>
 
328
<td><span class="term"><em class="parameter"><code>offy</code></em>&#160;:</span></td>
343
329
<td> y offset for translation.
344
330
</td>
345
331
</tr>
346
332
<tr>
347
 
<td>
348
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
333
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
349
334
<td> The floated layer.
350
335
</td>
351
336
</tr>
354
339
</div>
355
340
<hr>
356
341
<div class="refsect2" lang="en">
357
 
<a name="id2624289"></a><h3>
 
342
<a name="id2650280"></a><h3>
358
343
<a name="gimp-selection-load"></a>gimp_selection_load ()</h3>
359
 
<a class="indexterm" name="id2624301"></a><pre class="programlisting">gboolean    gimp_selection_load             (gint32 channel_ID);</pre>
 
344
<a class="indexterm" name="id2650293"></a><pre class="programlisting">gboolean            gimp_selection_load                 (gint32 channel_ID);</pre>
360
345
<p>
361
346
Transfer the specified channel to the selection mask.
362
347
</p>
369
354
<col align="left" valign="top">
370
355
<tbody>
371
356
<tr>
372
 
<td>
373
 
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
 
357
<td><span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
374
358
<td> The channel.
375
359
</td>
376
360
</tr>
377
361
<tr>
378
 
<td>
379
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
362
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
380
363
<td> TRUE on success.
381
364
</td>
382
365
</tr>
385
368
</div>
386
369
<hr>
387
370
<div class="refsect2" lang="en">
388
 
<a name="id2624367"></a><h3>
 
371
<a name="id2666558"></a><h3>
389
372
<a name="gimp-selection-save"></a>gimp_selection_save ()</h3>
390
 
<a class="indexterm" name="id2624379"></a><pre class="programlisting">gint32      gimp_selection_save             (gint32 image_ID);</pre>
 
373
<a class="indexterm" name="id2666569"></a><pre class="programlisting">gint32              gimp_selection_save                 (gint32 image_ID);</pre>
391
374
<p>
392
375
Copy the selection mask to a new channel.
393
376
</p>
402
385
<col align="left" valign="top">
403
386
<tbody>
404
387
<tr>
405
 
<td>
406
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
388
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
407
389
<td> The image.
408
390
</td>
409
391
</tr>
410
392
<tr>
411
 
<td>
412
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
393
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
413
394
<td> The new channel.
414
395
</td>
415
396
</tr>
418
399
</div>
419
400
<hr>
420
401
<div class="refsect2" lang="en">
421
 
<a name="id2624446"></a><h3>
 
402
<a name="id2666628"></a><h3>
422
403
<a name="gimp-selection-value"></a>gimp_selection_value ()</h3>
423
 
<a class="indexterm" name="id2624458"></a><pre class="programlisting">gint        gimp_selection_value            (gint32 image_ID,
424
 
                                             gint x,
425
 
                                             gint y);</pre>
 
404
<a class="indexterm" name="id2666639"></a><pre class="programlisting">gint                gimp_selection_value                (gint32 image_ID,
 
405
                                                         gint x,
 
406
                                                         gint y);</pre>
426
407
<p>
427
408
Find the value of the selection at the specified coordinates.
428
409
</p>
436
417
<col align="left" valign="top">
437
418
<tbody>
438
419
<tr>
439
 
<td>
440
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
420
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
441
421
<td> The image.
442
422
</td>
443
423
</tr>
444
424
<tr>
445
 
<td>
446
 
<span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
 
425
<td><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
447
426
<td> x coordinate of value.
448
427
</td>
449
428
</tr>
450
429
<tr>
451
 
<td>
452
 
<span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
 
430
<td><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
453
431
<td> y coordinate of value.
454
432
</td>
455
433
</tr>
456
434
<tr>
457
 
<td>
458
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
435
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
459
436
<td> Value of the selection.
460
437
</td>
461
438
</tr>
464
441
</div>
465
442
<hr>
466
443
<div class="refsect2" lang="en">
467
 
<a name="id2624566"></a><h3>
 
444
<a name="id2666737"></a><h3>
468
445
<a name="gimp-selection-grow"></a>gimp_selection_grow ()</h3>
469
 
<a class="indexterm" name="id2624578"></a><pre class="programlisting">gboolean    gimp_selection_grow             (gint32 image_ID,
470
 
                                             gint steps);</pre>
 
446
<a class="indexterm" name="id2666748"></a><pre class="programlisting">gboolean            gimp_selection_grow                 (gint32 image_ID,
 
447
                                                         gint steps);</pre>
471
448
<p>
472
449
Grow the image's selection
473
450
</p>
481
458
<col align="left" valign="top">
482
459
<tbody>
483
460
<tr>
484
 
<td>
485
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
461
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
486
462
<td> The image.
487
463
</td>
488
464
</tr>
489
465
<tr>
490
 
<td>
491
 
<span class="term"><em class="parameter"><code>steps</code></em>&#160;:</span></td>
 
466
<td><span class="term"><em class="parameter"><code>steps</code></em>&#160;:</span></td>
492
467
<td> Steps of grow (in pixels).
493
468
</td>
494
469
</tr>
495
470
<tr>
496
 
<td>
497
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
471
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
498
472
<td> TRUE on success.
499
473
</td>
500
474
</tr>
503
477
</div>
504
478
<hr>
505
479
<div class="refsect2" lang="en">
506
 
<a name="id2624664"></a><h3>
 
480
<a name="id2666826"></a><h3>
507
481
<a name="gimp-selection-shrink"></a>gimp_selection_shrink ()</h3>
508
 
<a class="indexterm" name="id2624676"></a><pre class="programlisting">gboolean    gimp_selection_shrink           (gint32 image_ID,
509
 
                                             gint radius);</pre>
 
482
<a class="indexterm" name="id2666836"></a><pre class="programlisting">gboolean            gimp_selection_shrink               (gint32 image_ID,
 
483
                                                         gint steps);</pre>
510
484
<p>
511
485
Shrink the image's selection
512
486
</p>
521
495
<col align="left" valign="top">
522
496
<tbody>
523
497
<tr>
524
 
<td>
525
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
498
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
526
499
<td> The image.
527
500
</td>
528
501
</tr>
529
502
<tr>
530
 
<td>
531
 
<span class="term"><em class="parameter"><code>radius</code></em>&#160;:</span></td>
532
 
<td> Radius of shrink (in pixels).
 
503
<td><span class="term"><em class="parameter"><code>steps</code></em>&#160;:</span></td>
 
504
<td> Steps of shrink (in pixels).
533
505
</td>
534
506
</tr>
535
507
<tr>
536
 
<td>
537
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
508
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
538
509
<td> TRUE on success.
539
510
</td>
540
511
</tr>
543
514
</div>
544
515
<hr>
545
516
<div class="refsect2" lang="en">
546
 
<a name="id2624762"></a><h3>
 
517
<a name="id2666915"></a><h3>
547
518
<a name="gimp-selection-invert"></a>gimp_selection_invert ()</h3>
548
 
<a class="indexterm" name="id2624773"></a><pre class="programlisting">gboolean    gimp_selection_invert           (gint32 image_ID);</pre>
 
519
<a class="indexterm" name="id2666925"></a><pre class="programlisting">gboolean            gimp_selection_invert               (gint32 image_ID);</pre>
549
520
<p>
550
521
Invert the selection mask.
551
522
</p>
552
523
<p>
553
524
This procedure inverts the selection mask. For every pixel in the
554
 
selection channel, its new value is calculated as (255 - old_value).</p>
 
525
selection channel, its new value is calculated as (255 - old-value).</p>
555
526
<p>
556
527
 
557
528
</p>
559
530
<col align="left" valign="top">
560
531
<tbody>
561
532
<tr>
562
 
<td>
563
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
533
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
564
534
<td> The image.
565
535
</td>
566
536
</tr>
567
537
<tr>
568
 
<td>
569
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
538
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
570
539
<td> TRUE on success.
571
540
</td>
572
541
</tr>
575
544
</div>
576
545
<hr>
577
546
<div class="refsect2" lang="en">
578
 
<a name="id2624839"></a><h3>
 
547
<a name="id2666984"></a><h3>
579
548
<a name="gimp-selection-feather"></a>gimp_selection_feather ()</h3>
580
 
<a class="indexterm" name="id2624850"></a><pre class="programlisting">gboolean    gimp_selection_feather          (gint32 image_ID,
581
 
                                             gdouble radius);</pre>
 
549
<a class="indexterm" name="id2666995"></a><pre class="programlisting">gboolean            gimp_selection_feather              (gint32 image_ID,
 
550
                                                         gdouble radius);</pre>
582
551
<p>
583
552
Feather the image's selection
584
553
</p>
592
561
<col align="left" valign="top">
593
562
<tbody>
594
563
<tr>
595
 
<td>
596
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
564
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
597
565
<td> The image.
598
566
</td>
599
567
</tr>
600
568
<tr>
601
 
<td>
602
 
<span class="term"><em class="parameter"><code>radius</code></em>&#160;:</span></td>
 
569
<td><span class="term"><em class="parameter"><code>radius</code></em>&#160;:</span></td>
603
570
<td> Radius of feather (in pixels).
604
571
</td>
605
572
</tr>
606
573
<tr>
607
 
<td>
608
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
574
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
609
575
<td> TRUE on success.
610
576
</td>
611
577
</tr>
614
580
</div>
615
581
<hr>
616
582
<div class="refsect2" lang="en">
617
 
<a name="id2624936"></a><h3>
 
583
<a name="id2667072"></a><h3>
618
584
<a name="gimp-selection-sharpen"></a>gimp_selection_sharpen ()</h3>
619
 
<a class="indexterm" name="id2624947"></a><pre class="programlisting">gboolean    gimp_selection_sharpen          (gint32 image_ID);</pre>
 
585
<a class="indexterm" name="id2667082"></a><pre class="programlisting">gboolean            gimp_selection_sharpen              (gint32 image_ID);</pre>
620
586
<p>
621
587
Sharpen the selection mask.
622
588
</p>
623
589
<p>
624
590
This procedure sharpens the selection mask. For every pixel in the
625
 
selection channel, if the value is &gt; 0, the new pixel is assigned
626
 
a value of 255. This removes any \"anti-aliasing\" that might exist
627
 
in the selection mask's boundary.</p>
 
591
selection channel, if the value is &gt; 127, the new pixel is
 
592
assigned a value of 255. This removes any \"anti-aliasing\" that
 
593
might exist in the selection mask's boundary.</p>
628
594
<p>
629
595
 
630
596
</p>
632
598
<col align="left" valign="top">
633
599
<tbody>
634
600
<tr>
635
 
<td>
636
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
601
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
637
602
<td> The image.
638
603
</td>
639
604
</tr>
640
605
<tr>
641
 
<td>
642
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
606
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
643
607
<td> TRUE on success.
644
608
</td>
645
609
</tr>
648
612
</div>
649
613
<hr>
650
614
<div class="refsect2" lang="en">
651
 
<a name="id2625015"></a><h3>
 
615
<a name="id2667143"></a><h3>
652
616
<a name="gimp-selection-border"></a>gimp_selection_border ()</h3>
653
 
<a class="indexterm" name="id2625026"></a><pre class="programlisting">gboolean    gimp_selection_border           (gint32 image_ID,
654
 
                                             gint radius);</pre>
 
617
<a class="indexterm" name="id2667154"></a><pre class="programlisting">gboolean            gimp_selection_border               (gint32 image_ID,
 
618
                                                         gint radius);</pre>
655
619
<p>
656
620
Border the image's selection
657
621
</p>
666
630
<col align="left" valign="top">
667
631
<tbody>
668
632
<tr>
669
 
<td>
670
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
633
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
671
634
<td> The image.
672
635
</td>
673
636
</tr>
674
637
<tr>
675
 
<td>
676
 
<span class="term"><em class="parameter"><code>radius</code></em>&#160;:</span></td>
 
638
<td><span class="term"><em class="parameter"><code>radius</code></em>&#160;:</span></td>
677
639
<td> Radius of border (in pixels).
678
640
</td>
679
641
</tr>
680
642
<tr>
681
 
<td>
682
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
643
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
683
644
<td> TRUE on success.
684
645
</td>
685
646
</tr>
688
649
</div>
689
650
<hr>
690
651
<div class="refsect2" lang="en">
691
 
<a name="id2625113"></a><h3>
 
652
<a name="id2667233"></a><h3>
692
653
<a name="gimp-selection-translate"></a>gimp_selection_translate ()</h3>
693
 
<a class="indexterm" name="id2625124"></a><pre class="programlisting">gboolean    gimp_selection_translate        (gint32 image_ID,
694
 
                                             gint offx,
695
 
                                             gint offy);</pre>
 
654
<a class="indexterm" name="id2667243"></a><pre class="programlisting">gboolean            gimp_selection_translate            (gint32 image_ID,
 
655
                                                         gint offx,
 
656
                                                         gint offy);</pre>
696
657
<p>
697
658
Translate the selection by the specified offsets.
698
659
</p>
709
670
<col align="left" valign="top">
710
671
<tbody>
711
672
<tr>
712
 
<td>
713
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
673
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
714
674
<td> The image.
715
675
</td>
716
676
</tr>
717
677
<tr>
718
 
<td>
719
 
<span class="term"><em class="parameter"><code>offx</code></em>&#160;:</span></td>
 
678
<td><span class="term"><em class="parameter"><code>offx</code></em>&#160;:</span></td>
720
679
<td> x offset for translation.
721
680
</td>
722
681
</tr>
723
682
<tr>
724
 
<td>
725
 
<span class="term"><em class="parameter"><code>offy</code></em>&#160;:</span></td>
 
683
<td><span class="term"><em class="parameter"><code>offy</code></em>&#160;:</span></td>
726
684
<td> y offset for translation.
727
685
</td>
728
686
</tr>
729
687
<tr>
730
 
<td>
731
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
688
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
732
689
<td> TRUE on success.
733
690
</td>
734
691
</tr>
737
694
</div>
738
695
<hr>
739
696
<div class="refsect2" lang="en">
740
 
<a name="id2625235"></a><h3>
 
697
<a name="id2667344"></a><h3>
741
698
<a name="gimp-selection-layer-alpha"></a>gimp_selection_layer_alpha ()</h3>
742
 
<a class="indexterm" name="id2625246"></a><pre class="programlisting">gboolean    gimp_selection_layer_alpha      (gint32 layer_ID);</pre>
 
699
<a class="indexterm" name="id2667354"></a><pre class="programlisting">gboolean            gimp_selection_layer_alpha          (gint32 layer_ID);</pre>
743
700
<p>
744
701
Transfer the specified layer's alpha channel to the selection mask.
745
702
</p>
757
714
<col align="left" valign="top">
758
715
<tbody>
759
716
<tr>
760
 
<td>
761
 
<span class="term"><em class="parameter"><code>layer_ID</code></em>&#160;:</span></td>
 
717
<td><span class="term"><em class="parameter"><code>layer_ID</code></em>&#160;:</span></td>
762
718
<td> Layer with alpha.
763
719
</td>
764
720
</tr>
765
721
<tr>
766
 
<td>
767
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
722
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
768
723
<td> TRUE on success.
769
724
</td>
770
725
</tr>
773
728
</div>
774
729
<hr>
775
730
<div class="refsect2" lang="en">
776
 
<a name="id2625317"></a><h3>
 
731
<a name="id2667418"></a><h3>
777
732
<a name="gimp-selection-combine"></a>gimp_selection_combine ()</h3>
778
 
<a class="indexterm" name="id2625328"></a><pre class="programlisting">gboolean    gimp_selection_combine          (gint32 channel_ID,
779
 
                                             <a href="libgimp-gimpenums.html#GimpChannelOps">GimpChannelOps</a> operation);</pre>
 
733
<a class="indexterm" name="id2667429"></a><pre class="programlisting">gboolean            gimp_selection_combine              (gint32 channel_ID,
 
734
                                                         <a
 
735
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelOps"
 
736
>GimpChannelOps</a> operation);</pre>
780
737
<p>
781
738
Combines the specified channel with the selection mask.
782
739
</p>
790
747
<col align="left" valign="top">
791
748
<tbody>
792
749
<tr>
793
 
<td>
794
 
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
 
750
<td><span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
795
751
<td> The channel.
796
752
</td>
797
753
</tr>
798
754
<tr>
799
 
<td>
800
 
<span class="term"><em class="parameter"><code>operation</code></em>&#160;:</span></td>
 
755
<td><span class="term"><em class="parameter"><code>operation</code></em>&#160;:</span></td>
801
756
<td> The selection operation.
802
757
</td>
803
758
</tr>
804
759
<tr>
805
 
<td>
806
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
760
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
807
761
<td> TRUE on success.
808
762
</td>
809
763
</tr>