1
<?xml version="1.0" encoding="UTF-8" ?>
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
5
<refentry id="libgimp-gimptools">
7
<refentrytitle>gimptools</refentrytitle>
8
<manvolnum>3</manvolnum>
9
<refmiscinfo>LIBGIMP Library</refmiscinfo>
13
<refname>gimptools</refname><refpurpose>Access to common toolbox tools.</refpurpose>
16
<refsynopsisdiv><title>Synopsis</title>
22
<link linkend="gboolean">gboolean</link> <link linkend="gimp-airbrush">gimp_airbrush</link> (<link linkend="gint32">gint32</link> drawable_ID,
23
<link linkend="gdouble">gdouble</link> pressure,
24
<link linkend="gint">gint</link> num_strokes,
25
const <link linkend="gdouble">gdouble</link> *strokes);
26
<link linkend="gboolean">gboolean</link> <link linkend="gimp-airbrush-default">gimp_airbrush_default</link> (<link linkend="gint32">gint32</link> drawable_ID,
27
<link linkend="gint">gint</link> num_strokes,
28
const <link linkend="gdouble">gdouble</link> *strokes);
29
<link linkend="gboolean">gboolean</link> <link linkend="gimp-by-color-select">gimp_by_color_select</link> (<link linkend="gint32">gint32</link> drawable_ID,
30
const <link linkend="GimpRGB">GimpRGB</link> *color,
31
<link linkend="gint">gint</link> threshold,
32
<link linkend="GimpChannelOps">GimpChannelOps</link> operation,
33
<link linkend="gboolean">gboolean</link> antialias,
34
<link linkend="gboolean">gboolean</link> feather,
35
<link linkend="gdouble">gdouble</link> feather_radius,
36
<link linkend="gboolean">gboolean</link> sample_merged);
37
<link linkend="gboolean">gboolean</link> <link linkend="gimp-clone">gimp_clone</link> (<link linkend="gint32">gint32</link> drawable_ID,
38
<link linkend="gint32">gint32</link> src_drawable_ID,
39
<link linkend="GimpCloneType">GimpCloneType</link> clone_type,
40
<link linkend="gdouble">gdouble</link> src_x,
41
<link linkend="gdouble">gdouble</link> src_y,
42
<link linkend="gint">gint</link> num_strokes,
43
const <link linkend="gdouble">gdouble</link> *strokes);
44
<link linkend="gboolean">gboolean</link> <link linkend="gimp-clone-default">gimp_clone_default</link> (<link linkend="gint32">gint32</link> drawable_ID,
45
<link linkend="gint">gint</link> num_strokes,
46
const <link linkend="gdouble">gdouble</link> *strokes);
47
<link linkend="gboolean">gboolean</link> <link linkend="gimp-convolve">gimp_convolve</link> (<link linkend="gint32">gint32</link> drawable_ID,
48
<link linkend="gdouble">gdouble</link> pressure,
49
<link linkend="GimpConvolveType">GimpConvolveType</link> convolve_type,
50
<link linkend="gint">gint</link> num_strokes,
51
const <link linkend="gdouble">gdouble</link> *strokes);
52
<link linkend="gboolean">gboolean</link> <link linkend="gimp-convolve-default">gimp_convolve_default</link> (<link linkend="gint32">gint32</link> drawable_ID,
53
<link linkend="gint">gint</link> num_strokes,
54
const <link linkend="gdouble">gdouble</link> *strokes);
55
<link linkend="gboolean">gboolean</link> <link linkend="gimp-dodgeburn">gimp_dodgeburn</link> (<link linkend="gint32">gint32</link> drawable_ID,
56
<link linkend="gdouble">gdouble</link> exposure,
57
<link linkend="GimpDodgeBurnType">GimpDodgeBurnType</link> dodgeburn_type,
58
<link linkend="GimpTransferMode">GimpTransferMode</link> dodgeburn_mode,
59
<link linkend="gint">gint</link> num_strokes,
60
const <link linkend="gdouble">gdouble</link> *strokes);
61
<link linkend="gboolean">gboolean</link> <link linkend="gimp-dodgeburn-default">gimp_dodgeburn_default</link> (<link linkend="gint32">gint32</link> drawable_ID,
62
<link linkend="gint">gint</link> num_strokes,
63
const <link linkend="gdouble">gdouble</link> *strokes);
64
<link linkend="gboolean">gboolean</link> <link linkend="gimp-ellipse-select">gimp_ellipse_select</link> (<link linkend="gint32">gint32</link> image_ID,
65
<link linkend="gdouble">gdouble</link> x,
66
<link linkend="gdouble">gdouble</link> y,
67
<link linkend="gdouble">gdouble</link> width,
68
<link linkend="gdouble">gdouble</link> height,
69
<link linkend="GimpChannelOps">GimpChannelOps</link> operation,
70
<link linkend="gboolean">gboolean</link> antialias,
71
<link linkend="gboolean">gboolean</link> feather,
72
<link linkend="gdouble">gdouble</link> feather_radius);
73
<link linkend="gboolean">gboolean</link> <link linkend="gimp-eraser">gimp_eraser</link> (<link linkend="gint32">gint32</link> drawable_ID,
74
<link linkend="gint">gint</link> num_strokes,
75
const <link linkend="gdouble">gdouble</link> *strokes,
76
<link linkend="GimpBrushApplicationMode">GimpBrushApplicationMode</link> hardness,
77
<link linkend="GimpPaintApplicationMode">GimpPaintApplicationMode</link> method);
78
<link linkend="gboolean">gboolean</link> <link linkend="gimp-eraser-default">gimp_eraser_default</link> (<link linkend="gint32">gint32</link> drawable_ID,
79
<link linkend="gint">gint</link> num_strokes,
80
const <link linkend="gdouble">gdouble</link> *strokes);
81
<link linkend="gint32">gint32</link> <link linkend="gimp-flip">gimp_flip</link> (<link linkend="gint32">gint32</link> drawable_ID,
82
<link linkend="GimpOrientationType">GimpOrientationType</link> flip_type);
83
<link linkend="gboolean">gboolean</link> <link linkend="gimp-free-select">gimp_free_select</link> (<link linkend="gint32">gint32</link> image_ID,
84
<link linkend="gint">gint</link> num_segs,
85
const <link linkend="gdouble">gdouble</link> *segs,
86
<link linkend="GimpChannelOps">GimpChannelOps</link> operation,
87
<link linkend="gboolean">gboolean</link> antialias,
88
<link linkend="gboolean">gboolean</link> feather,
89
<link linkend="gdouble">gdouble</link> feather_radius);
90
<link linkend="gboolean">gboolean</link> <link linkend="gimp-fuzzy-select">gimp_fuzzy_select</link> (<link linkend="gint32">gint32</link> drawable_ID,
91
<link linkend="gdouble">gdouble</link> x,
92
<link linkend="gdouble">gdouble</link> y,
93
<link linkend="gint">gint</link> threshold,
94
<link linkend="GimpChannelOps">GimpChannelOps</link> operation,
95
<link linkend="gboolean">gboolean</link> antialias,
96
<link linkend="gboolean">gboolean</link> feather,
97
<link linkend="gdouble">gdouble</link> feather_radius,
98
<link linkend="gboolean">gboolean</link> sample_merged);
99
<link linkend="gboolean">gboolean</link> <link linkend="gimp-paintbrush">gimp_paintbrush</link> (<link linkend="gint32">gint32</link> drawable_ID,
100
<link linkend="gdouble">gdouble</link> fade_out,
101
<link linkend="gint">gint</link> num_strokes,
102
const <link linkend="gdouble">gdouble</link> *strokes,
103
<link linkend="GimpPaintApplicationMode">GimpPaintApplicationMode</link> method,
104
<link linkend="gdouble">gdouble</link> gradient_length);
105
<link linkend="gboolean">gboolean</link> <link linkend="gimp-paintbrush-default">gimp_paintbrush_default</link> (<link linkend="gint32">gint32</link> drawable_ID,
106
<link linkend="gint">gint</link> num_strokes,
107
const <link linkend="gdouble">gdouble</link> *strokes);
108
<link linkend="gboolean">gboolean</link> <link linkend="gimp-pencil">gimp_pencil</link> (<link linkend="gint32">gint32</link> drawable_ID,
109
<link linkend="gint">gint</link> num_strokes,
110
const <link linkend="gdouble">gdouble</link> *strokes);
111
<link linkend="gint32">gint32</link> <link linkend="gimp-perspective">gimp_perspective</link> (<link linkend="gint32">gint32</link> drawable_ID,
112
<link linkend="gboolean">gboolean</link> interpolation,
113
<link linkend="gdouble">gdouble</link> x0,
114
<link linkend="gdouble">gdouble</link> y0,
115
<link linkend="gdouble">gdouble</link> x1,
116
<link linkend="gdouble">gdouble</link> y1,
117
<link linkend="gdouble">gdouble</link> x2,
118
<link linkend="gdouble">gdouble</link> y2,
119
<link linkend="gdouble">gdouble</link> x3,
120
<link linkend="gdouble">gdouble</link> y3);
121
<link linkend="gboolean">gboolean</link> <link linkend="gimp-rect-select">gimp_rect_select</link> (<link linkend="gint32">gint32</link> image_ID,
122
<link linkend="gdouble">gdouble</link> x,
123
<link linkend="gdouble">gdouble</link> y,
124
<link linkend="gdouble">gdouble</link> width,
125
<link linkend="gdouble">gdouble</link> height,
126
<link linkend="GimpChannelOps">GimpChannelOps</link> operation,
127
<link linkend="gboolean">gboolean</link> feather,
128
<link linkend="gdouble">gdouble</link> feather_radius);
129
<link linkend="gint32">gint32</link> <link linkend="gimp-rotate">gimp_rotate</link> (<link linkend="gint32">gint32</link> drawable_ID,
130
<link linkend="gboolean">gboolean</link> interpolation,
131
<link linkend="gdouble">gdouble</link> angle);
132
<link linkend="gint32">gint32</link> <link linkend="gimp-scale">gimp_scale</link> (<link linkend="gint32">gint32</link> drawable_ID,
133
<link linkend="gboolean">gboolean</link> interpolation,
134
<link linkend="gdouble">gdouble</link> x0,
135
<link linkend="gdouble">gdouble</link> y0,
136
<link linkend="gdouble">gdouble</link> x1,
137
<link linkend="gdouble">gdouble</link> y1);
138
<link linkend="gint32">gint32</link> <link linkend="gimp-shear">gimp_shear</link> (<link linkend="gint32">gint32</link> drawable_ID,
139
<link linkend="gboolean">gboolean</link> interpolation,
140
<link linkend="GimpOrientationType">GimpOrientationType</link> shear_type,
141
<link linkend="gdouble">gdouble</link> magnitude);
142
<link linkend="gboolean">gboolean</link> <link linkend="gimp-smudge">gimp_smudge</link> (<link linkend="gint32">gint32</link> drawable_ID,
143
<link linkend="gdouble">gdouble</link> pressure,
144
<link linkend="gint">gint</link> num_strokes,
145
const <link linkend="gdouble">gdouble</link> *strokes);
146
<link linkend="gboolean">gboolean</link> <link linkend="gimp-smudge-default">gimp_smudge_default</link> (<link linkend="gint32">gint32</link> drawable_ID,
147
<link linkend="gint">gint</link> num_strokes,
148
const <link linkend="gdouble">gdouble</link> *strokes);
149
<link linkend="gint32">gint32</link> <link linkend="gimp-transform-2d">gimp_transform_2d</link> (<link linkend="gint32">gint32</link> drawable_ID,
150
<link linkend="gboolean">gboolean</link> interpolation,
151
<link linkend="gdouble">gdouble</link> source_x,
152
<link linkend="gdouble">gdouble</link> source_y,
153
<link linkend="gdouble">gdouble</link> scale_x,
154
<link linkend="gdouble">gdouble</link> scale_y,
155
<link linkend="gdouble">gdouble</link> angle,
156
<link linkend="gdouble">gdouble</link> dest_x,
157
<link linkend="gdouble">gdouble</link> dest_y);
170
<title>Description</title>
172
Functions giving access to common toolbox tools.
178
<title>Details</title>
180
<title><anchor id="gimp-airbrush"/>gimp_airbrush ()</title>
181
<indexterm><primary>gimp_airbrush</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_airbrush (<link linkend="gint32">gint32</link> drawable_ID,
182
<link linkend="gdouble">gdouble</link> pressure,
183
<link linkend="gint">gint</link> num_strokes,
184
const <link linkend="gdouble">gdouble</link> *strokes);</programlisting>
186
Paint in the current brush with varying pressure. Paint application
190
This tool simulates the use of an airbrush. Paint pressure
191
represents the relative intensity of the paint application. High
192
pressure results in a thicker layer of paint while low pressure
193
results in a thinner layer.</para>
196
</para><variablelist role="params">
197
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
198
<listitem><simpara> The affected drawable.
199
</simpara></listitem></varlistentry>
200
<varlistentry><term><parameter>pressure</parameter> :</term>
201
<listitem><simpara> The pressure of the airbrush strokes.
202
</simpara></listitem></varlistentry>
203
<varlistentry><term><parameter>num_strokes</parameter> :</term>
204
<listitem><simpara> Number of stroke control points (count each coordinate as 2 points).
205
</simpara></listitem></varlistentry>
206
<varlistentry><term><parameter>strokes</parameter> :</term>
207
<listitem><simpara> Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.
208
</simpara></listitem></varlistentry>
209
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
210
</simpara></listitem></varlistentry>
211
</variablelist></refsect2>
213
<title><anchor id="gimp-airbrush-default"/>gimp_airbrush_default ()</title>
214
<indexterm><primary>gimp_airbrush_default</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_airbrush_default (<link linkend="gint32">gint32</link> drawable_ID,
215
<link linkend="gint">gint</link> num_strokes,
216
const <link linkend="gdouble">gdouble</link> *strokes);</programlisting>
218
Paint in the current brush with varying pressure. Paint application
222
This tool simulates the use of an airbrush. It is similar to
223
gimp_airbrush except that the pressure is derived from the airbrush
224
tools options box. It the option has not been set the default for
225
the option will be used.</para>
228
</para><variablelist role="params">
229
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
230
<listitem><simpara> The affected drawable.
231
</simpara></listitem></varlistentry>
232
<varlistentry><term><parameter>num_strokes</parameter> :</term>
233
<listitem><simpara> Number of stroke control points (count each coordinate as 2 points).
234
</simpara></listitem></varlistentry>
235
<varlistentry><term><parameter>strokes</parameter> :</term>
236
<listitem><simpara> Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.
237
</simpara></listitem></varlistentry>
238
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
239
</simpara></listitem></varlistentry>
240
</variablelist></refsect2>
242
<title><anchor id="gimp-by-color-select"/>gimp_by_color_select ()</title>
243
<indexterm><primary>gimp_by_color_select</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_by_color_select (<link linkend="gint32">gint32</link> drawable_ID,
244
const <link linkend="GimpRGB">GimpRGB</link> *color,
245
<link linkend="gint">gint</link> threshold,
246
<link linkend="GimpChannelOps">GimpChannelOps</link> operation,
247
<link linkend="gboolean">gboolean</link> antialias,
248
<link linkend="gboolean">gboolean</link> feather,
249
<link linkend="gdouble">gdouble</link> feather_radius,
250
<link linkend="gboolean">gboolean</link> sample_merged);</programlisting>
252
Create a selection by selecting all pixels (in the specified
253
drawable) with the same (or similar) color to that specified.
256
This tool creates a selection over the specified image. A by-color
257
selection is determined by the supplied color under the constraints
258
of the specified threshold. Essentially, all pixels (in the
259
drawable) that have color sufficiently close to the specified color
260
(as determined by the threshold value) are included in the
261
selection. The antialiasing parameter allows the final selection
262
mask to contain intermediate values based on close misses to the
263
threshold bar. Feathering can be enabled optionally and is
264
controlled with the \"feather_radius\" parameter. If the
265
sample_merged parameter is non-zero, the data of the composite image
266
will be used instead of that for the specified drawable. This is
267
equivalent to sampling for colors after merging all visible layers.
268
In the case of a merged sampling, the supplied drawable is ignored.</para>
271
</para><variablelist role="params">
272
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
273
<listitem><simpara> The affected drawable.
274
</simpara></listitem></varlistentry>
275
<varlistentry><term><parameter>color</parameter> :</term>
276
<listitem><simpara> The color to select.
277
</simpara></listitem></varlistentry>
278
<varlistentry><term><parameter>threshold</parameter> :</term>
279
<listitem><simpara> Threshold in intensity levels %<literal>desc</literal>%%.
280
</simpara></listitem></varlistentry>
281
<varlistentry><term><parameter>operation</parameter> :</term>
282
<listitem><simpara> The selection operation.
283
</simpara></listitem></varlistentry>
284
<varlistentry><term><parameter>antialias</parameter> :</term>
285
<listitem><simpara> Antialiasing.
286
</simpara></listitem></varlistentry>
287
<varlistentry><term><parameter>feather</parameter> :</term>
288
<listitem><simpara> Feather option for selections.
289
</simpara></listitem></varlistentry>
290
<varlistentry><term><parameter>feather_radius</parameter> :</term>
291
<listitem><simpara> Radius for feather operation.
292
</simpara></listitem></varlistentry>
293
<varlistentry><term><parameter>sample_merged</parameter> :</term>
294
<listitem><simpara> Use the composite image, not the drawable.
295
</simpara></listitem></varlistentry>
296
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
297
</simpara></listitem></varlistentry>
298
</variablelist></refsect2>
300
<title><anchor id="gimp-clone"/>gimp_clone ()</title>
301
<indexterm><primary>gimp_clone</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_clone (<link linkend="gint32">gint32</link> drawable_ID,
302
<link linkend="gint32">gint32</link> src_drawable_ID,
303
<link linkend="GimpCloneType">GimpCloneType</link> clone_type,
304
<link linkend="gdouble">gdouble</link> src_x,
305
<link linkend="gdouble">gdouble</link> src_y,
306
<link linkend="gint">gint</link> num_strokes,
307
const <link linkend="gdouble">gdouble</link> *strokes);</programlisting>
309
Clone from the source to the dest drawable using the current brush
312
This tool clones (copies) from the source drawable starting at the
313
specified source coordinates to the dest drawable. If the
314
\"clone_type\" argument is set to PATTERN-CLONE, then the current
315
pattern is used as the source and the \"src_drawable\" argument is
316
ignored. Pattern cloning assumes a tileable pattern and mods the sum
317
of the src coordinates and subsequent stroke offsets with the width
318
and height of the pattern. For image cloning, if the sum of the src
319
coordinates and subsequent stroke offsets exceeds the extents of the
320
src drawable, then no paint is transferred. The clone tool is
321
capable of transforming between any image types including
322
RGB->Indexed--although converting from any type to indexed is
323
significantly slower.</para>
326
</para><variablelist role="params">
327
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
328
<listitem><simpara> The affected drawable.
329
</simpara></listitem></varlistentry>
330
<varlistentry><term><parameter>src_drawable_ID</parameter> :</term>
331
<listitem><simpara> The source drawable.
332
</simpara></listitem></varlistentry>
333
<varlistentry><term><parameter>clone_type</parameter> :</term>
334
<listitem><simpara> The type of clone.
335
</simpara></listitem></varlistentry>
336
<varlistentry><term><parameter>src_x</parameter> :</term>
337
<listitem><simpara> The x coordinate in the source image.
338
</simpara></listitem></varlistentry>
339
<varlistentry><term><parameter>src_y</parameter> :</term>
340
<listitem><simpara> The y coordinate in the source image.
341
</simpara></listitem></varlistentry>
342
<varlistentry><term><parameter>num_strokes</parameter> :</term>
343
<listitem><simpara> Number of stroke control points (count each coordinate as 2 points).
344
</simpara></listitem></varlistentry>
345
<varlistentry><term><parameter>strokes</parameter> :</term>
346
<listitem><simpara> Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.
347
</simpara></listitem></varlistentry>
348
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
349
</simpara></listitem></varlistentry>
350
</variablelist></refsect2>
352
<title><anchor id="gimp-clone-default"/>gimp_clone_default ()</title>
353
<indexterm><primary>gimp_clone_default</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_clone_default (<link linkend="gint32">gint32</link> drawable_ID,
354
<link linkend="gint">gint</link> num_strokes,
355
const <link linkend="gdouble">gdouble</link> *strokes);</programlisting>
357
Clone from the source to the dest drawable using the current brush
360
This tool clones (copies) from the source drawable starting at the
361
specified source coordinates to the dest drawable. This function
362
performs exactly the same as the gimp_clone function except that the
363
tools arguments are obtained from the clones option dialog. It this
364
dialog has not been activated then the dialogs default values will
368
</para><variablelist role="params">
369
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
370
<listitem><simpara> The affected drawable.
371
</simpara></listitem></varlistentry>
372
<varlistentry><term><parameter>num_strokes</parameter> :</term>
373
<listitem><simpara> Number of stroke control points (count each coordinate as 2 points).
374
</simpara></listitem></varlistentry>
375
<varlistentry><term><parameter>strokes</parameter> :</term>
376
<listitem><simpara> Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.
377
</simpara></listitem></varlistentry>
378
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
379
</simpara></listitem></varlistentry>
380
</variablelist></refsect2>
382
<title><anchor id="gimp-convolve"/>gimp_convolve ()</title>
383
<indexterm><primary>gimp_convolve</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_convolve (<link linkend="gint32">gint32</link> drawable_ID,
384
<link linkend="gdouble">gdouble</link> pressure,
385
<link linkend="GimpConvolveType">GimpConvolveType</link> convolve_type,
386
<link linkend="gint">gint</link> num_strokes,
387
const <link linkend="gdouble">gdouble</link> *strokes);</programlisting>
389
Convolve (Blur, Sharpen) using the current brush.
392
This tool convolves the specified drawable with either a sharpening
393
or blurring kernel. The pressure parameter controls the magnitude of
394
the operation. Like the paintbrush, this tool linearly interpolates
395
between the specified stroke coordinates.</para>
398
</para><variablelist role="params">
399
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
400
<listitem><simpara> The affected drawable.
401
</simpara></listitem></varlistentry>
402
<varlistentry><term><parameter>pressure</parameter> :</term>
403
<listitem><simpara> The pressure.
404
</simpara></listitem></varlistentry>
405
<varlistentry><term><parameter>convolve_type</parameter> :</term>
406
<listitem><simpara> Convolve type.
407
</simpara></listitem></varlistentry>
408
<varlistentry><term><parameter>num_strokes</parameter> :</term>
409
<listitem><simpara> Number of stroke control points (count each coordinate as 2 points).
410
</simpara></listitem></varlistentry>
411
<varlistentry><term><parameter>strokes</parameter> :</term>
412
<listitem><simpara> Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.
413
</simpara></listitem></varlistentry>
414
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
415
</simpara></listitem></varlistentry>
416
</variablelist></refsect2>
418
<title><anchor id="gimp-convolve-default"/>gimp_convolve_default ()</title>
419
<indexterm><primary>gimp_convolve_default</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_convolve_default (<link linkend="gint32">gint32</link> drawable_ID,
420
<link linkend="gint">gint</link> num_strokes,
421
const <link linkend="gdouble">gdouble</link> *strokes);</programlisting>
423
Convolve (Blur, Sharpen) using the current brush.
426
This tool convolves the specified drawable with either a sharpening
427
or blurring kernel. This function performs exactly the same as the
428
gimp_convolve function except that the tools arguments are obtained
429
from the convolve option dialog. It this dialog has not been
430
activated then the dialogs default values will be used.</para>
433
</para><variablelist role="params">
434
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
435
<listitem><simpara> The affected drawable.
436
</simpara></listitem></varlistentry>
437
<varlistentry><term><parameter>num_strokes</parameter> :</term>
438
<listitem><simpara> Number of stroke control points (count each coordinate as 2 points).
439
</simpara></listitem></varlistentry>
440
<varlistentry><term><parameter>strokes</parameter> :</term>
441
<listitem><simpara> Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.
442
</simpara></listitem></varlistentry>
443
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
444
</simpara></listitem></varlistentry>
445
</variablelist></refsect2>
447
<title><anchor id="gimp-dodgeburn"/>gimp_dodgeburn ()</title>
448
<indexterm><primary>gimp_dodgeburn</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_dodgeburn (<link linkend="gint32">gint32</link> drawable_ID,
449
<link linkend="gdouble">gdouble</link> exposure,
450
<link linkend="GimpDodgeBurnType">GimpDodgeBurnType</link> dodgeburn_type,
451
<link linkend="GimpTransferMode">GimpTransferMode</link> dodgeburn_mode,
452
<link linkend="gint">gint</link> num_strokes,
453
const <link linkend="gdouble">gdouble</link> *strokes);</programlisting>
455
Dodgeburn image with varying exposure.
458
Dodgeburn. More details here later.</para>
461
</para><variablelist role="params">
462
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
463
<listitem><simpara> The affected drawable.
464
</simpara></listitem></varlistentry>
465
<varlistentry><term><parameter>exposure</parameter> :</term>
466
<listitem><simpara> The exposer of the strokes.
467
</simpara></listitem></varlistentry>
468
<varlistentry><term><parameter>dodgeburn_type</parameter> :</term>
469
<listitem><simpara> The type either dodge or burn.
470
</simpara></listitem></varlistentry>
471
<varlistentry><term><parameter>dodgeburn_mode</parameter> :</term>
472
<listitem><simpara> The mode.
473
</simpara></listitem></varlistentry>
474
<varlistentry><term><parameter>num_strokes</parameter> :</term>
475
<listitem><simpara> Number of stroke control points (count each coordinate as 2 points).
476
</simpara></listitem></varlistentry>
477
<varlistentry><term><parameter>strokes</parameter> :</term>
478
<listitem><simpara> Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.
479
</simpara></listitem></varlistentry>
480
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
481
</simpara></listitem></varlistentry>
482
</variablelist></refsect2>
484
<title><anchor id="gimp-dodgeburn-default"/>gimp_dodgeburn_default ()</title>
485
<indexterm><primary>gimp_dodgeburn_default</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_dodgeburn_default (<link linkend="gint32">gint32</link> drawable_ID,
486
<link linkend="gint">gint</link> num_strokes,
487
const <link linkend="gdouble">gdouble</link> *strokes);</programlisting>
489
Dodgeburn image with varying exposure. This is the same as the
490
gimp_dodgeburn function except that the exposure, type and mode are
491
taken from the tools option dialog. If the dialog has not been
492
activated then the defaults as used by the dialog will be used.
495
Dodgeburn. More details here later.</para>
498
</para><variablelist role="params">
499
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
500
<listitem><simpara> The affected drawable.
501
</simpara></listitem></varlistentry>
502
<varlistentry><term><parameter>num_strokes</parameter> :</term>
503
<listitem><simpara> Number of stroke control points (count each coordinate as 2 points).
504
</simpara></listitem></varlistentry>
505
<varlistentry><term><parameter>strokes</parameter> :</term>
506
<listitem><simpara> Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.
507
</simpara></listitem></varlistentry>
508
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
509
</simpara></listitem></varlistentry>
510
</variablelist></refsect2>
512
<title><anchor id="gimp-ellipse-select"/>gimp_ellipse_select ()</title>
513
<indexterm><primary>gimp_ellipse_select</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_ellipse_select (<link linkend="gint32">gint32</link> image_ID,
514
<link linkend="gdouble">gdouble</link> x,
515
<link linkend="gdouble">gdouble</link> y,
516
<link linkend="gdouble">gdouble</link> width,
517
<link linkend="gdouble">gdouble</link> height,
518
<link linkend="GimpChannelOps">GimpChannelOps</link> operation,
519
<link linkend="gboolean">gboolean</link> antialias,
520
<link linkend="gboolean">gboolean</link> feather,
521
<link linkend="gdouble">gdouble</link> feather_radius);</programlisting>
523
Create an elliptical selection over the specified image.
526
This tool creates an elliptical selection over the specified image.
527
The elliptical region can be either added to, subtracted from, or
528
replace the contents of the previous selection mask. If antialiasing
529
is turned on, the edges of the elliptical region will contain
530
intermediate values which give the appearance of a sharper, less
531
pixelized edge. This should be set as TRUE most of the time. If the
532
feather option is enabled, the resulting selection is blurred before
533
combining. The blur is a gaussian blur with the specified feather
537
</para><variablelist role="params">
538
<varlistentry><term><parameter>image_ID</parameter> :</term>
539
<listitem><simpara> The image.
540
</simpara></listitem></varlistentry>
541
<varlistentry><term><parameter>x</parameter> :</term>
542
<listitem><simpara> x coordinate of upper-left corner of ellipse bounding box.
543
</simpara></listitem></varlistentry>
544
<varlistentry><term><parameter>y</parameter> :</term>
545
<listitem><simpara> y coordinate of upper-left corner of ellipse bounding box.
546
</simpara></listitem></varlistentry>
547
<varlistentry><term><parameter>width</parameter> :</term>
548
<listitem><simpara> The width of the ellipse.
549
</simpara></listitem></varlistentry>
550
<varlistentry><term><parameter>height</parameter> :</term>
551
<listitem><simpara> The height of the ellipse.
552
</simpara></listitem></varlistentry>
553
<varlistentry><term><parameter>operation</parameter> :</term>
554
<listitem><simpara> The selection operation.
555
</simpara></listitem></varlistentry>
556
<varlistentry><term><parameter>antialias</parameter> :</term>
557
<listitem><simpara> Antialiasing.
558
</simpara></listitem></varlistentry>
559
<varlistentry><term><parameter>feather</parameter> :</term>
560
<listitem><simpara> Feather option for selections.
561
</simpara></listitem></varlistentry>
562
<varlistentry><term><parameter>feather_radius</parameter> :</term>
563
<listitem><simpara> Radius for feather operation.
564
</simpara></listitem></varlistentry>
565
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
566
</simpara></listitem></varlistentry>
567
</variablelist></refsect2>
569
<title><anchor id="gimp-eraser"/>gimp_eraser ()</title>
570
<indexterm><primary>gimp_eraser</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_eraser (<link linkend="gint32">gint32</link> drawable_ID,
571
<link linkend="gint">gint</link> num_strokes,
572
const <link linkend="gdouble">gdouble</link> *strokes,
573
<link linkend="GimpBrushApplicationMode">GimpBrushApplicationMode</link> hardness,
574
<link linkend="GimpPaintApplicationMode">GimpPaintApplicationMode</link> method);</programlisting>
576
Erase using the current brush.
579
This tool erases using the current brush mask. If the specified
580
drawable contains an alpha channel, then the erased pixels will
581
become transparent. Otherwise, the eraser tool replaces the contents
582
of the drawable with the background color. Like paintbrush, this
583
tool linearly interpolates between the specified stroke coordinates.</para>
586
</para><variablelist role="params">
587
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
588
<listitem><simpara> The affected drawable.
589
</simpara></listitem></varlistentry>
590
<varlistentry><term><parameter>num_strokes</parameter> :</term>
591
<listitem><simpara> Number of stroke control points (count each coordinate as 2 points).
592
</simpara></listitem></varlistentry>
593
<varlistentry><term><parameter>strokes</parameter> :</term>
594
<listitem><simpara> Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.
595
</simpara></listitem></varlistentry>
596
<varlistentry><term><parameter>hardness</parameter> :</term>
597
<listitem><simpara> %<literal>desc</literal>%%.
598
</simpara></listitem></varlistentry>
599
<varlistentry><term><parameter>method</parameter> :</term>
600
<listitem><simpara> %<literal>desc</literal>%%.
601
</simpara></listitem></varlistentry>
602
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
603
</simpara></listitem></varlistentry>
604
</variablelist></refsect2>
606
<title><anchor id="gimp-eraser-default"/>gimp_eraser_default ()</title>
607
<indexterm><primary>gimp_eraser_default</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_eraser_default (<link linkend="gint32">gint32</link> drawable_ID,
608
<link linkend="gint">gint</link> num_strokes,
609
const <link linkend="gdouble">gdouble</link> *strokes);</programlisting>
611
Erase using the current brush.
614
This tool erases using the current brush mask. This function
615
performs exactly the same as the gimp_eraser function except that
616
the tools arguments are obtained from the eraser option dialog. It
617
this dialog has not been activated then the dialogs default values
621
</para><variablelist role="params">
622
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
623
<listitem><simpara> The affected drawable.
624
</simpara></listitem></varlistentry>
625
<varlistentry><term><parameter>num_strokes</parameter> :</term>
626
<listitem><simpara> Number of stroke control points (count each coordinate as 2 points).
627
</simpara></listitem></varlistentry>
628
<varlistentry><term><parameter>strokes</parameter> :</term>
629
<listitem><simpara> Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.
630
</simpara></listitem></varlistentry>
631
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
632
</simpara></listitem></varlistentry>
633
</variablelist></refsect2>
635
<title><anchor id="gimp-flip"/>gimp_flip ()</title>
636
<indexterm role="deprecated"><primary>gimp_flip</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_flip (<link linkend="gint32">gint32</link> drawable_ID,
637
<link linkend="GimpOrientationType">GimpOrientationType</link> flip_type);</programlisting>
638
<warning><para><literal>gimp_flip</literal> is deprecated and should not be used in newly-written code.</para></warning>
640
This procedure is deprecated! Use
641
<link linkend="gimp-drawable-transform-flip-simple"><function>gimp_drawable_transform_flip_simple()</function></link> instead.</para>
644
</para><variablelist role="params">
645
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
646
<listitem><simpara> The affected drawable.
647
</simpara></listitem></varlistentry>
648
<varlistentry><term><parameter>flip_type</parameter> :</term>
649
<listitem><simpara> Type of flip.
650
</simpara></listitem></varlistentry>
651
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The flipped drawable.
652
</simpara></listitem></varlistentry>
653
</variablelist></refsect2>
655
<title><anchor id="gimp-free-select"/>gimp_free_select ()</title>
656
<indexterm><primary>gimp_free_select</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_free_select (<link linkend="gint32">gint32</link> image_ID,
657
<link linkend="gint">gint</link> num_segs,
658
const <link linkend="gdouble">gdouble</link> *segs,
659
<link linkend="GimpChannelOps">GimpChannelOps</link> operation,
660
<link linkend="gboolean">gboolean</link> antialias,
661
<link linkend="gboolean">gboolean</link> feather,
662
<link linkend="gdouble">gdouble</link> feather_radius);</programlisting>
664
Create a polygonal selection over the specified image.
667
This tool creates a polygonal selection over the specified image.
668
The polygonal region can be either added to, subtracted from, or
669
replace the contents of the previous selection mask. The polygon is
670
specified through an array of floating point numbers and its length.
671
The length of array must be 2n, where n is the number of points.
672
Each point is defined by 2 floating point values which correspond to
673
the x and y coordinates. If the final point does not connect to the
674
starting point, a connecting segment is automatically added. If the
675
feather option is enabled, the resulting selection is blurred before
676
combining. The blur is a gaussian blur with the specified feather
680
</para><variablelist role="params">
681
<varlistentry><term><parameter>image_ID</parameter> :</term>
682
<listitem><simpara> The image.
683
</simpara></listitem></varlistentry>
684
<varlistentry><term><parameter>num_segs</parameter> :</term>
685
<listitem><simpara> Number of points (count 1 coordinate as two points).
686
</simpara></listitem></varlistentry>
687
<varlistentry><term><parameter>segs</parameter> :</term>
688
<listitem><simpara> Array of points: { p1.x, p1.y, p2.x, p2.y, ..., pn.x, pn.y}.
689
</simpara></listitem></varlistentry>
690
<varlistentry><term><parameter>operation</parameter> :</term>
691
<listitem><simpara> The selection operation.
692
</simpara></listitem></varlistentry>
693
<varlistentry><term><parameter>antialias</parameter> :</term>
694
<listitem><simpara> Antialiasing.
695
</simpara></listitem></varlistentry>
696
<varlistentry><term><parameter>feather</parameter> :</term>
697
<listitem><simpara> Feather option for selections.
698
</simpara></listitem></varlistentry>
699
<varlistentry><term><parameter>feather_radius</parameter> :</term>
700
<listitem><simpara> Radius for feather operation.
701
</simpara></listitem></varlistentry>
702
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
703
</simpara></listitem></varlistentry>
704
</variablelist></refsect2>
706
<title><anchor id="gimp-fuzzy-select"/>gimp_fuzzy_select ()</title>
707
<indexterm><primary>gimp_fuzzy_select</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_fuzzy_select (<link linkend="gint32">gint32</link> drawable_ID,
708
<link linkend="gdouble">gdouble</link> x,
709
<link linkend="gdouble">gdouble</link> y,
710
<link linkend="gint">gint</link> threshold,
711
<link linkend="GimpChannelOps">GimpChannelOps</link> operation,
712
<link linkend="gboolean">gboolean</link> antialias,
713
<link linkend="gboolean">gboolean</link> feather,
714
<link linkend="gdouble">gdouble</link> feather_radius,
715
<link linkend="gboolean">gboolean</link> sample_merged);</programlisting>
717
Create a fuzzy selection starting at the specified coordinates on
718
the specified drawable.
721
This tool creates a fuzzy selection over the specified image. A
722
fuzzy selection is determined by a seed fill under the constraints
723
of the specified threshold. Essentially, the color at the specified
724
coordinates (in the drawable) is measured and the selection expands
725
outwards from that point to any adjacent pixels which are not
726
significantly different (as determined by the threshold value). This
727
process continues until no more expansion is possible. The
728
antialiasing parameter allows the final selection mask to contain
729
intermediate values based on close misses to the threshold bar at
730
pixels along the seed fill boundary. Feathering can be enabled
731
optionally and is controlled with the \"feather_radius\" paramter.
732
If the sample_merged parameter is non-zero, the data of the
733
composite image will be used instead of that for the specified
734
drawable. This is equivalent to sampling for colors after merging
735
all visible layers. In the case of a merged sampling, the supplied
736
drawable is ignored. If the sample is merged, the specified
737
coordinates are relative to the image origin; otherwise, they are
738
relative to the drawable's origin.</para>
741
</para><variablelist role="params">
742
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
743
<listitem><simpara> The affected drawable.
744
</simpara></listitem></varlistentry>
745
<varlistentry><term><parameter>x</parameter> :</term>
746
<listitem><simpara> x coordinate of initial seed fill point: (image coordinates).
747
</simpara></listitem></varlistentry>
748
<varlistentry><term><parameter>y</parameter> :</term>
749
<listitem><simpara> y coordinate of initial seed fill point: (image coordinates).
750
</simpara></listitem></varlistentry>
751
<varlistentry><term><parameter>threshold</parameter> :</term>
752
<listitem><simpara> Threshold in intensity levels %<literal>desc</literal>%%.
753
</simpara></listitem></varlistentry>
754
<varlistentry><term><parameter>operation</parameter> :</term>
755
<listitem><simpara> The selection operation.
756
</simpara></listitem></varlistentry>
757
<varlistentry><term><parameter>antialias</parameter> :</term>
758
<listitem><simpara> Antialiasing.
759
</simpara></listitem></varlistentry>
760
<varlistentry><term><parameter>feather</parameter> :</term>
761
<listitem><simpara> Feather option for selections.
762
</simpara></listitem></varlistentry>
763
<varlistentry><term><parameter>feather_radius</parameter> :</term>
764
<listitem><simpara> Radius for feather operation.
765
</simpara></listitem></varlistentry>
766
<varlistentry><term><parameter>sample_merged</parameter> :</term>
767
<listitem><simpara> Use the composite image, not the drawable.
768
</simpara></listitem></varlistentry>
769
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
770
</simpara></listitem></varlistentry>
771
</variablelist></refsect2>
773
<title><anchor id="gimp-paintbrush"/>gimp_paintbrush ()</title>
774
<indexterm><primary>gimp_paintbrush</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_paintbrush (<link linkend="gint32">gint32</link> drawable_ID,
775
<link linkend="gdouble">gdouble</link> fade_out,
776
<link linkend="gint">gint</link> num_strokes,
777
const <link linkend="gdouble">gdouble</link> *strokes,
778
<link linkend="GimpPaintApplicationMode">GimpPaintApplicationMode</link> method,
779
<link linkend="gdouble">gdouble</link> gradient_length);</programlisting>
781
Paint in the current brush with optional fade out parameter and pull
782
colors from a gradient.
785
This tool is the standard paintbrush. It draws linearly interpolated
786
lines through the specified stroke coordinates. It operates on the
787
specified drawable in the foreground color with the active brush.
788
The \"fade_out\" parameter is measured in pixels and allows the
789
brush stroke to linearly fall off. The pressure is set to the
790
maximum at the beginning of the stroke. As the distance of the
791
stroke nears the fade_out value, the pressure will approach zero.
792
The gradient_length is the distance to spread the gradient over. It
793
is measured in pixels. If the gradient_length is 0, no gradient is
797
</para><variablelist role="params">
798
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
799
<listitem><simpara> The affected drawable.
800
</simpara></listitem></varlistentry>
801
<varlistentry><term><parameter>fade_out</parameter> :</term>
802
<listitem><simpara> Fade out parameter.
803
</simpara></listitem></varlistentry>
804
<varlistentry><term><parameter>num_strokes</parameter> :</term>
805
<listitem><simpara> Number of stroke control points (count each coordinate as 2 points).
806
</simpara></listitem></varlistentry>
807
<varlistentry><term><parameter>strokes</parameter> :</term>
808
<listitem><simpara> Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.
809
</simpara></listitem></varlistentry>
810
<varlistentry><term><parameter>method</parameter> :</term>
811
<listitem><simpara> %<literal>desc</literal>%%.
812
</simpara></listitem></varlistentry>
813
<varlistentry><term><parameter>gradient_length</parameter> :</term>
814
<listitem><simpara> Length of gradient to draw.
815
</simpara></listitem></varlistentry>
816
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
817
</simpara></listitem></varlistentry>
818
</variablelist></refsect2>
820
<title><anchor id="gimp-paintbrush-default"/>gimp_paintbrush_default ()</title>
821
<indexterm><primary>gimp_paintbrush_default</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_paintbrush_default (<link linkend="gint32">gint32</link> drawable_ID,
822
<link linkend="gint">gint</link> num_strokes,
823
const <link linkend="gdouble">gdouble</link> *strokes);</programlisting>
825
Paint in the current brush. The fade out parameter and pull colors
826
from a gradient parameter are set from the paintbrush options
827
dialog. If this dialog has not been activated then the dialog
828
defaults will be used.
831
This tool is similar to the standard paintbrush. It draws linearly
832
interpolated lines through the specified stroke coordinates. It
833
operates on the specified drawable in the foreground color with the
834
active brush. The \"fade_out\" parameter is measured in pixels and
835
allows the brush stroke to linearly fall off (value obtained from
836
the option dialog). The pressure is set to the maximum at the
837
beginning of the stroke. As the distance of the stroke nears the
838
fade_out value, the pressure will approach zero. The gradient_length
839
(value obtained from the option dialog) is the distance to spread
840
the gradient over. It is measured in pixels. If the gradient_length
841
is 0, no gradient is used.</para>
844
</para><variablelist role="params">
845
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
846
<listitem><simpara> The affected drawable.
847
</simpara></listitem></varlistentry>
848
<varlistentry><term><parameter>num_strokes</parameter> :</term>
849
<listitem><simpara> Number of stroke control points (count each coordinate as 2 points).
850
</simpara></listitem></varlistentry>
851
<varlistentry><term><parameter>strokes</parameter> :</term>
852
<listitem><simpara> Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.
853
</simpara></listitem></varlistentry>
854
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
855
</simpara></listitem></varlistentry>
856
</variablelist></refsect2>
858
<title><anchor id="gimp-pencil"/>gimp_pencil ()</title>
859
<indexterm><primary>gimp_pencil</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_pencil (<link linkend="gint32">gint32</link> drawable_ID,
860
<link linkend="gint">gint</link> num_strokes,
861
const <link linkend="gdouble">gdouble</link> *strokes);</programlisting>
863
Paint in the current brush without sub-pixel sampling.
866
This tool is the standard pencil. It draws linearly interpolated
867
lines through the specified stroke coordinates. It operates on the
868
specified drawable in the foreground color with the active brush.
869
The brush mask is treated as though it contains only black and white
870
values. Any value below half is treated as black; any above half, as
874
</para><variablelist role="params">
875
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
876
<listitem><simpara> The affected drawable.
877
</simpara></listitem></varlistentry>
878
<varlistentry><term><parameter>num_strokes</parameter> :</term>
879
<listitem><simpara> Number of stroke control points (count each coordinate as 2 points).
880
</simpara></listitem></varlistentry>
881
<varlistentry><term><parameter>strokes</parameter> :</term>
882
<listitem><simpara> Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.
883
</simpara></listitem></varlistentry>
884
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
885
</simpara></listitem></varlistentry>
886
</variablelist></refsect2>
888
<title><anchor id="gimp-perspective"/>gimp_perspective ()</title>
889
<indexterm role="deprecated"><primary>gimp_perspective</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_perspective (<link linkend="gint32">gint32</link> drawable_ID,
890
<link linkend="gboolean">gboolean</link> interpolation,
891
<link linkend="gdouble">gdouble</link> x0,
892
<link linkend="gdouble">gdouble</link> y0,
893
<link linkend="gdouble">gdouble</link> x1,
894
<link linkend="gdouble">gdouble</link> y1,
895
<link linkend="gdouble">gdouble</link> x2,
896
<link linkend="gdouble">gdouble</link> y2,
897
<link linkend="gdouble">gdouble</link> x3,
898
<link linkend="gdouble">gdouble</link> y3);</programlisting>
899
<warning><para><literal>gimp_perspective</literal> is deprecated and should not be used in newly-written code.</para></warning>
901
This procedure is deprecated! Use
902
<link linkend="gimp-drawable-transform-perspective-default"><function>gimp_drawable_transform_perspective_default()</function></link> instead.</para>
905
</para><variablelist role="params">
906
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
907
<listitem><simpara> The affected drawable.
908
</simpara></listitem></varlistentry>
909
<varlistentry><term><parameter>interpolation</parameter> :</term>
910
<listitem><simpara> Whether to use interpolation.
911
</simpara></listitem></varlistentry>
912
<varlistentry><term><parameter>x0</parameter> :</term>
913
<listitem><simpara> The new x coordinate of upper-left corner of original bounding box.
914
</simpara></listitem></varlistentry>
915
<varlistentry><term><parameter>y0</parameter> :</term>
916
<listitem><simpara> The new y coordinate of upper-left corner of original bounding box.
917
</simpara></listitem></varlistentry>
918
<varlistentry><term><parameter>x1</parameter> :</term>
919
<listitem><simpara> The new x coordinate of upper-right corner of original bounding box.
920
</simpara></listitem></varlistentry>
921
<varlistentry><term><parameter>y1</parameter> :</term>
922
<listitem><simpara> The new y coordinate of upper-right corner of original bounding box.
923
</simpara></listitem></varlistentry>
924
<varlistentry><term><parameter>x2</parameter> :</term>
925
<listitem><simpara> The new x coordinate of lower-left corner of original bounding box.
926
</simpara></listitem></varlistentry>
927
<varlistentry><term><parameter>y2</parameter> :</term>
928
<listitem><simpara> The new y coordinate of lower-left corner of original bounding box.
929
</simpara></listitem></varlistentry>
930
<varlistentry><term><parameter>x3</parameter> :</term>
931
<listitem><simpara> The new x coordinate of lower-right corner of original bounding box.
932
</simpara></listitem></varlistentry>
933
<varlistentry><term><parameter>y3</parameter> :</term>
934
<listitem><simpara> The new y coordinate of lower-right corner of original bounding box.
935
</simpara></listitem></varlistentry>
936
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly mapped drawable.
937
</simpara></listitem></varlistentry>
938
</variablelist></refsect2>
940
<title><anchor id="gimp-rect-select"/>gimp_rect_select ()</title>
941
<indexterm><primary>gimp_rect_select</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_rect_select (<link linkend="gint32">gint32</link> image_ID,
942
<link linkend="gdouble">gdouble</link> x,
943
<link linkend="gdouble">gdouble</link> y,
944
<link linkend="gdouble">gdouble</link> width,
945
<link linkend="gdouble">gdouble</link> height,
946
<link linkend="GimpChannelOps">GimpChannelOps</link> operation,
947
<link linkend="gboolean">gboolean</link> feather,
948
<link linkend="gdouble">gdouble</link> feather_radius);</programlisting>
950
Create a rectangular selection over the specified image;
953
This tool creates a rectangular selection over the specified image.
954
The rectangular region can be either added to, subtracted from, or
955
replace the contents of the previous selection mask. If the feather
956
option is enabled, the resulting selection is blurred before
957
combining. The blur is a gaussian blur with the specified feather
961
</para><variablelist role="params">
962
<varlistentry><term><parameter>image_ID</parameter> :</term>
963
<listitem><simpara> The image.
964
</simpara></listitem></varlistentry>
965
<varlistentry><term><parameter>x</parameter> :</term>
966
<listitem><simpara> x coordinate of upper-left corner of rectangle.
967
</simpara></listitem></varlistentry>
968
<varlistentry><term><parameter>y</parameter> :</term>
969
<listitem><simpara> y coordinate of upper-left corner of rectangle.
970
</simpara></listitem></varlistentry>
971
<varlistentry><term><parameter>width</parameter> :</term>
972
<listitem><simpara> The width of the rectangle.
973
</simpara></listitem></varlistentry>
974
<varlistentry><term><parameter>height</parameter> :</term>
975
<listitem><simpara> The height of the rectangle.
976
</simpara></listitem></varlistentry>
977
<varlistentry><term><parameter>operation</parameter> :</term>
978
<listitem><simpara> The selection operation.
979
</simpara></listitem></varlistentry>
980
<varlistentry><term><parameter>feather</parameter> :</term>
981
<listitem><simpara> Feather option for selections.
982
</simpara></listitem></varlistentry>
983
<varlistentry><term><parameter>feather_radius</parameter> :</term>
984
<listitem><simpara> Radius for feather operation.
985
</simpara></listitem></varlistentry>
986
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
987
</simpara></listitem></varlistentry>
988
</variablelist></refsect2>
990
<title><anchor id="gimp-rotate"/>gimp_rotate ()</title>
991
<indexterm role="deprecated"><primary>gimp_rotate</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_rotate (<link linkend="gint32">gint32</link> drawable_ID,
992
<link linkend="gboolean">gboolean</link> interpolation,
993
<link linkend="gdouble">gdouble</link> angle);</programlisting>
994
<warning><para><literal>gimp_rotate</literal> is deprecated and should not be used in newly-written code.</para></warning>
996
This procedure is deprecated! Use
997
<link linkend="gimp-drawable-transform-rotate-default"><function>gimp_drawable_transform_rotate_default()</function></link> instead.</para>
1000
</para><variablelist role="params">
1001
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
1002
<listitem><simpara> The affected drawable.
1003
</simpara></listitem></varlistentry>
1004
<varlistentry><term><parameter>interpolation</parameter> :</term>
1005
<listitem><simpara> Whether to use interpolation.
1006
</simpara></listitem></varlistentry>
1007
<varlistentry><term><parameter>angle</parameter> :</term>
1008
<listitem><simpara> The angle of rotation (radians).
1009
</simpara></listitem></varlistentry>
1010
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The rotated drawable.
1011
</simpara></listitem></varlistentry>
1012
</variablelist></refsect2>
1014
<title><anchor id="gimp-scale"/>gimp_scale ()</title>
1015
<indexterm role="deprecated"><primary>gimp_scale</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_scale (<link linkend="gint32">gint32</link> drawable_ID,
1016
<link linkend="gboolean">gboolean</link> interpolation,
1017
<link linkend="gdouble">gdouble</link> x0,
1018
<link linkend="gdouble">gdouble</link> y0,
1019
<link linkend="gdouble">gdouble</link> x1,
1020
<link linkend="gdouble">gdouble</link> y1);</programlisting>
1021
<warning><para><literal>gimp_scale</literal> is deprecated and should not be used in newly-written code.</para></warning>
1023
This procedure is deprecated! Use
1024
<link linkend="gimp-drawable-transform-scale-default"><function>gimp_drawable_transform_scale_default()</function></link> instead.</para>
1027
</para><variablelist role="params">
1028
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
1029
<listitem><simpara> The affected drawable.
1030
</simpara></listitem></varlistentry>
1031
<varlistentry><term><parameter>interpolation</parameter> :</term>
1032
<listitem><simpara> Whether to use interpolation.
1033
</simpara></listitem></varlistentry>
1034
<varlistentry><term><parameter>x0</parameter> :</term>
1035
<listitem><simpara> The new x coordinate of upper-left corner of newly scaled region.
1036
</simpara></listitem></varlistentry>
1037
<varlistentry><term><parameter>y0</parameter> :</term>
1038
<listitem><simpara> The new y coordinate of upper-left corner of newly scaled region.
1039
</simpara></listitem></varlistentry>
1040
<varlistentry><term><parameter>x1</parameter> :</term>
1041
<listitem><simpara> The new x coordinate of lower-right corner of newly scaled region.
1042
</simpara></listitem></varlistentry>
1043
<varlistentry><term><parameter>y1</parameter> :</term>
1044
<listitem><simpara> The new y coordinate of lower-right corner of newly scaled region.
1045
</simpara></listitem></varlistentry>
1046
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The scaled drawable.
1047
</simpara></listitem></varlistentry>
1048
</variablelist></refsect2>
1050
<title><anchor id="gimp-shear"/>gimp_shear ()</title>
1051
<indexterm role="deprecated"><primary>gimp_shear</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_shear (<link linkend="gint32">gint32</link> drawable_ID,
1052
<link linkend="gboolean">gboolean</link> interpolation,
1053
<link linkend="GimpOrientationType">GimpOrientationType</link> shear_type,
1054
<link linkend="gdouble">gdouble</link> magnitude);</programlisting>
1055
<warning><para><literal>gimp_shear</literal> is deprecated and should not be used in newly-written code.</para></warning>
1057
This procedure is deprecated! Use
1058
<link linkend="gimp-drawable-transform-shear-default"><function>gimp_drawable_transform_shear_default()</function></link> instead.</para>
1061
</para><variablelist role="params">
1062
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
1063
<listitem><simpara> The affected drawable.
1064
</simpara></listitem></varlistentry>
1065
<varlistentry><term><parameter>interpolation</parameter> :</term>
1066
<listitem><simpara> Whether to use interpolation.
1067
</simpara></listitem></varlistentry>
1068
<varlistentry><term><parameter>shear_type</parameter> :</term>
1069
<listitem><simpara> Type of shear.
1070
</simpara></listitem></varlistentry>
1071
<varlistentry><term><parameter>magnitude</parameter> :</term>
1072
<listitem><simpara> The magnitude of the shear.
1073
</simpara></listitem></varlistentry>
1074
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The sheared drawable.
1075
</simpara></listitem></varlistentry>
1076
</variablelist></refsect2>
1078
<title><anchor id="gimp-smudge"/>gimp_smudge ()</title>
1079
<indexterm><primary>gimp_smudge</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_smudge (<link linkend="gint32">gint32</link> drawable_ID,
1080
<link linkend="gdouble">gdouble</link> pressure,
1081
<link linkend="gint">gint</link> num_strokes,
1082
const <link linkend="gdouble">gdouble</link> *strokes);</programlisting>
1084
Smudge image with varying pressure.
1087
This tool simulates a smudge using the current brush. High pressure
1088
results in a greater smudge of paint while low pressure results in a
1089
lesser smudge.</para>
1092
</para><variablelist role="params">
1093
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
1094
<listitem><simpara> The affected drawable.
1095
</simpara></listitem></varlistentry>
1096
<varlistentry><term><parameter>pressure</parameter> :</term>
1097
<listitem><simpara> The pressure of the smudge strokes.
1098
</simpara></listitem></varlistentry>
1099
<varlistentry><term><parameter>num_strokes</parameter> :</term>
1100
<listitem><simpara> Number of stroke control points (count each coordinate as 2 points).
1101
</simpara></listitem></varlistentry>
1102
<varlistentry><term><parameter>strokes</parameter> :</term>
1103
<listitem><simpara> Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.
1104
</simpara></listitem></varlistentry>
1105
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
1106
</simpara></listitem></varlistentry>
1107
</variablelist></refsect2>
1109
<title><anchor id="gimp-smudge-default"/>gimp_smudge_default ()</title>
1110
<indexterm><primary>gimp_smudge_default</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_smudge_default (<link linkend="gint32">gint32</link> drawable_ID,
1111
<link linkend="gint">gint</link> num_strokes,
1112
const <link linkend="gdouble">gdouble</link> *strokes);</programlisting>
1114
Smudge image with varying pressure.
1117
This tool simulates a smudge using the current brush. It behaves
1118
exactly the same as gimp_smudge except that the pressure value is
1119
taken from the smudge tool options or the options default if the
1120
tools option dialog has not been activated.</para>
1123
</para><variablelist role="params">
1124
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
1125
<listitem><simpara> The affected drawable.
1126
</simpara></listitem></varlistentry>
1127
<varlistentry><term><parameter>num_strokes</parameter> :</term>
1128
<listitem><simpara> Number of stroke control points (count each coordinate as 2 points).
1129
</simpara></listitem></varlistentry>
1130
<varlistentry><term><parameter>strokes</parameter> :</term>
1131
<listitem><simpara> Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.
1132
</simpara></listitem></varlistentry>
1133
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
1134
</simpara></listitem></varlistentry>
1135
</variablelist></refsect2>
1137
<title><anchor id="gimp-transform-2d"/>gimp_transform_2d ()</title>
1138
<indexterm role="deprecated"><primary>gimp_transform_2d</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_transform_2d (<link linkend="gint32">gint32</link> drawable_ID,
1139
<link linkend="gboolean">gboolean</link> interpolation,
1140
<link linkend="gdouble">gdouble</link> source_x,
1141
<link linkend="gdouble">gdouble</link> source_y,
1142
<link linkend="gdouble">gdouble</link> scale_x,
1143
<link linkend="gdouble">gdouble</link> scale_y,
1144
<link linkend="gdouble">gdouble</link> angle,
1145
<link linkend="gdouble">gdouble</link> dest_x,
1146
<link linkend="gdouble">gdouble</link> dest_y);</programlisting>
1147
<warning><para><literal>gimp_transform_2d</literal> is deprecated and should not be used in newly-written code.</para></warning>
1149
This procedure is deprecated! Use
1150
<link linkend="gimp-drawable-transform-2d-default"><function>gimp_drawable_transform_2d_default()</function></link> instead.</para>
1153
</para><variablelist role="params">
1154
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
1155
<listitem><simpara> The affected drawable.
1156
</simpara></listitem></varlistentry>
1157
<varlistentry><term><parameter>interpolation</parameter> :</term>
1158
<listitem><simpara> Whether to use interpolation.
1159
</simpara></listitem></varlistentry>
1160
<varlistentry><term><parameter>source_x</parameter> :</term>
1161
<listitem><simpara> X coordinate of the transformation center.
1162
</simpara></listitem></varlistentry>
1163
<varlistentry><term><parameter>source_y</parameter> :</term>
1164
<listitem><simpara> Y coordinate of the transformation center.
1165
</simpara></listitem></varlistentry>
1166
<varlistentry><term><parameter>scale_x</parameter> :</term>
1167
<listitem><simpara> Amount to scale in x direction.
1168
</simpara></listitem></varlistentry>
1169
<varlistentry><term><parameter>scale_y</parameter> :</term>
1170
<listitem><simpara> Amount to scale in y direction.
1171
</simpara></listitem></varlistentry>
1172
<varlistentry><term><parameter>angle</parameter> :</term>
1173
<listitem><simpara> The angle of rotation (radians).
1174
</simpara></listitem></varlistentry>
1175
<varlistentry><term><parameter>dest_x</parameter> :</term>
1176
<listitem><simpara> X coordinate of where the centre goes.
1177
</simpara></listitem></varlistentry>
1178
<varlistentry><term><parameter>dest_y</parameter> :</term>
1179
<listitem><simpara> Y coordinate of where the centre goes.
1180
</simpara></listitem></varlistentry>
1181
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The transformed drawable.
1182
</simpara></listitem></varlistentry>
1183
</variablelist></refsect2>
added
removed
devel-docs/libgimp/xml/gimptools.xml
