1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimppainttools: GIMP Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manipulating Images and their Properties">
<link rel="prev" href="libgimp-gimptile.html" title="gimptile">
<link rel="next" href="libgimp-gimpselectiontools.html" title="gimpselectiontools">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libgimp-gimppainttools.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimp-gimptile.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimp-gimpselectiontools.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp-gimppainttools"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp-gimppainttools.top_of_page"></a>gimppainttools</span></h2>
<p>gimppainttools — Access to toolbox paint tools.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp-gimppainttools.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppainttools.html#gimp-airbrush" title="gimp_airbrush ()">gimp_airbrush</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppainttools.html#gimp-airbrush-default" title="gimp_airbrush_default ()">gimp_airbrush_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppainttools.html#gimp-clone" title="gimp_clone ()">gimp_clone</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppainttools.html#gimp-clone-default" title="gimp_clone_default ()">gimp_clone_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppainttools.html#gimp-convolve" title="gimp_convolve ()">gimp_convolve</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppainttools.html#gimp-convolve-default" title="gimp_convolve_default ()">gimp_convolve_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppainttools.html#gimp-dodgeburn" title="gimp_dodgeburn ()">gimp_dodgeburn</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppainttools.html#gimp-dodgeburn-default" title="gimp_dodgeburn_default ()">gimp_dodgeburn_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppainttools.html#gimp-edit-bucket-fill-full" title="gimp_edit_bucket_fill_full ()">gimp_edit_bucket_fill_full</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppainttools.html#gimp-eraser" title="gimp_eraser ()">gimp_eraser</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppainttools.html#gimp-eraser-default" title="gimp_eraser_default ()">gimp_eraser_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppainttools.html#gimp-heal" title="gimp_heal ()">gimp_heal</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppainttools.html#gimp-heal-default" title="gimp_heal_default ()">gimp_heal_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppainttools.html#gimp-paintbrush" title="gimp_paintbrush ()">gimp_paintbrush</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppainttools.html#gimp-paintbrush-default" title="gimp_paintbrush_default ()">gimp_paintbrush_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppainttools.html#gimp-pencil" title="gimp_pencil ()">gimp_pencil</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppainttools.html#gimp-smudge" title="gimp_smudge ()">gimp_smudge</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp-gimppainttools.html#gimp-smudge-default" title="gimp_smudge_default ()">gimp_smudge_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp-gimppainttools.description"></a><h2>Description</h2>
<p>Functions giving access to toolbox paint tools.</p>
</div>
<div class="refsect1">
<a name="libgimp-gimppainttools.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-airbrush"></a><h3>gimp_airbrush ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_airbrush (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> pressure</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
<em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Paint in the current brush with varying pressure. Paint application
is time-dependent.</p>
<p>This tool simulates the use of an airbrush. Paint pressure
represents the relative intensity of the paint application. High
pressure results in a thicker layer of paint while low pressure
results in a thinner layer.</p>
<div class="refsect3">
<a name="gimp-airbrush.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pressure</p></td>
<td class="parameter_description"><p>The pressure of the airbrush strokes.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-airbrush.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-airbrush-default"></a><h3>gimp_airbrush_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_airbrush_default (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
<em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Paint in the current brush with varying pressure. Paint application
is time-dependent.</p>
<p>This tool simulates the use of an airbrush. It is similar to
<a class="link" href="libgimp-gimppainttools.html#gimp-airbrush" title="gimp_airbrush ()"><code class="function">gimp_airbrush()</code></a> except that the pressure is derived from the
airbrush tools options box. It the option has not been set the
default for the option will be used.</p>
<div class="refsect3">
<a name="gimp-airbrush-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-airbrush-default.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-clone"></a><h3>gimp_clone ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_clone (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gint32</span> src_drawable_ID</code></em>,
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpCloneType"><span class="type">GimpCloneType</span></a> clone_type</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> src_x</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> src_y</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
<em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Clone from the source to the dest drawable using the current brush</p>
<p>This tool clones (copies) from the source drawable starting at the
specified source coordinates to the dest drawable. If the
\"clone_type\" argument is set to PATTERN-CLONE, then the current
pattern is used as the source and the \"src_drawable\" argument is
ignored. Pattern cloning assumes a tileable pattern and mods the sum
of the src coordinates and subsequent stroke offsets with the width
and height of the pattern. For image cloning, if the sum of the src
coordinates and subsequent stroke offsets exceeds the extents of the
src drawable, then no paint is transferred. The clone tool is
capable of transforming between any image types including
RGB->Indexed--although converting from any type to indexed is
significantly slower.</p>
<div class="refsect3">
<a name="gimp-clone.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>src_drawable_ID</p></td>
<td class="parameter_description"><p>The source drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>clone_type</p></td>
<td class="parameter_description"><p>The type of clone.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>src_x</p></td>
<td class="parameter_description"><p>The x coordinate in the source image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>src_y</p></td>
<td class="parameter_description"><p>The y coordinate in the source image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-clone.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-clone-default"></a><h3>gimp_clone_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_clone_default (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
<em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Clone from the source to the dest drawable using the current brush</p>
<p>This tool clones (copies) from the source drawable starting at the
specified source coordinates to the dest drawable. This function
performs exactly the same as the <a class="link" href="libgimp-gimppainttools.html#gimp-clone" title="gimp_clone ()"><code class="function">gimp_clone()</code></a> function except that
the tools arguments are obtained from the clones option dialog. It
this dialog has not been activated then the dialogs default values
will be used.</p>
<div class="refsect3">
<a name="gimp-clone-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-clone-default.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-convolve"></a><h3>gimp_convolve ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_convolve (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> pressure</code></em>,
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpConvolveType"><span class="type">GimpConvolveType</span></a> convolve_type</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
<em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Convolve (Blur, Sharpen) using the current brush.</p>
<p>This tool convolves the specified drawable with either a sharpening
or blurring kernel. The pressure parameter controls the magnitude of
the operation. Like the paintbrush, this tool linearly interpolates
between the specified stroke coordinates.</p>
<div class="refsect3">
<a name="gimp-convolve.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pressure</p></td>
<td class="parameter_description"><p>The pressure.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>convolve_type</p></td>
<td class="parameter_description"><p>Convolve type.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-convolve.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-convolve-default"></a><h3>gimp_convolve_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_convolve_default (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
<em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Convolve (Blur, Sharpen) using the current brush.</p>
<p>This tool convolves the specified drawable with either a sharpening
or blurring kernel. This function performs exactly the same as the
<a class="link" href="libgimp-gimppainttools.html#gimp-convolve" title="gimp_convolve ()"><code class="function">gimp_convolve()</code></a> function except that the tools arguments are
obtained from the convolve option dialog. It this dialog has not
been activated then the dialogs default values will be used.</p>
<div class="refsect3">
<a name="gimp-convolve-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-convolve-default.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-dodgeburn"></a><h3>gimp_dodgeburn ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_dodgeburn (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> exposure</code></em>,
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpDodgeBurnType"><span class="type">GimpDodgeBurnType</span></a> dodgeburn_type</code></em>,
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpTransferMode"><span class="type">GimpTransferMode</span></a> dodgeburn_mode</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
<em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Dodgeburn image with varying exposure.</p>
<p>Dodgeburn. More details here later.</p>
<div class="refsect3">
<a name="gimp-dodgeburn.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>exposure</p></td>
<td class="parameter_description"><p>The exposure of the strokes.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dodgeburn_type</p></td>
<td class="parameter_description"><p>The type either dodge or burn.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dodgeburn_mode</p></td>
<td class="parameter_description"><p>The mode.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-dodgeburn.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-dodgeburn-default"></a><h3>gimp_dodgeburn_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_dodgeburn_default (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
<em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Dodgeburn image with varying exposure. This is the same as the
<a class="link" href="libgimp-gimppainttools.html#gimp-dodgeburn" title="gimp_dodgeburn ()"><code class="function">gimp_dodgeburn()</code></a> function except that the exposure, type and mode
are taken from the tools option dialog. If the dialog has not been
activated then the defaults as used by the dialog will be used.</p>
<p>Dodgeburn. More details here later.</p>
<div class="refsect3">
<a name="gimp-dodgeburn-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-dodgeburn-default.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-edit-bucket-fill-full"></a><h3>gimp_edit_bucket_fill_full ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_edit_bucket_fill_full (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpBucketFillMode"><span class="type">GimpBucketFillMode</span></a> fill_mode</code></em>,
<em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpLayerMode" title="enum GimpLayerMode"><span class="type">GimpLayerMode</span></a> paint_mode</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> opacity</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> threshold</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> sample_merged</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> fill_transparent</code></em>,
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpSelectCriterion"><span class="type">GimpSelectCriterion</span></a> select_criterion</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> x</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> y</code></em>);</pre>
<div class="warning">
<p><code class="literal">gimp_edit_bucket_fill_full</code> is deprecated and should not be used in newly-written code.</p>
<p>Use <a class="link" href="libgimp-gimpdrawableedit.html#gimp-drawable-edit-bucket-fill" title="gimp_drawable_edit_bucket_fill ()"><code class="function">gimp_drawable_edit_bucket_fill()</code></a> instead.</p>
</div>
<p>Fill the area specified either by the current selection if there is
one, or by a seed fill starting at the specified coordinates.</p>
<p>This tool requires information on the paint application mode, and
the fill mode, which can either be in the foreground color, or in
the currently active pattern. If there is no selection, a seed fill
is executed at the specified coordinates and extends outward in
keeping with the threshold parameter. If there is a selection in the
target image, the threshold, sample merged, x, and y arguments are
unused. If the sample_merged parameter is TRUE, the data of the
composite image will be used instead of that for the specified
drawable. This is equivalent to sampling for colors after merging
all visible layers. In the case of merged sampling, the x and y
coordinates are relative to the image's origin; otherwise, they are
relative to the drawable's origin.</p>
<div class="refsect3">
<a name="gimp-edit-bucket-fill-full.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fill_mode</p></td>
<td class="parameter_description"><p>The type of fill.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>paint_mode</p></td>
<td class="parameter_description"><p>The paint application mode.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>opacity</p></td>
<td class="parameter_description"><p>The opacity of the final bucket fill.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>threshold</p></td>
<td class="parameter_description"><p>The threshold determines how extensive the seed fill will be. It's value is specified in terms of intensity levels. This parameter is only valid when there is no selection in the specified image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sample_merged</p></td>
<td class="parameter_description"><p>Use the composite image, not the drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fill_transparent</p></td>
<td class="parameter_description"><p>Whether to consider transparent pixels for filling. If TRUE, transparency is considered as a unique fillable color.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>select_criterion</p></td>
<td class="parameter_description"><p>The criterion used to determine color similarity. SELECT_CRITERION_COMPOSITE is the standard choice.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>The x coordinate of this bucket fill's application. This parameter is only valid when there is no selection in the specified image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>The y coordinate of this bucket fill's application. This parameter is only valid when there is no selection in the specified image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-edit-bucket-fill-full.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-eraser"></a><h3>gimp_eraser ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_eraser (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
<em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>,
<em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpBrushApplicationMode" title="enum GimpBrushApplicationMode"><span class="type">GimpBrushApplicationMode</span></a> hardness</code></em>,
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpPaintApplicationMode"><span class="type">GimpPaintApplicationMode</span></a> method</code></em>);</pre>
<p>Erase using the current brush.</p>
<p>This tool erases using the current brush mask. If the specified
drawable contains an alpha channel, then the erased pixels will
become transparent. Otherwise, the eraser tool replaces the contents
of the drawable with the background color. Like paintbrush, this
tool linearly interpolates between the specified stroke coordinates.</p>
<div class="refsect3">
<a name="gimp-eraser.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>hardness</p></td>
<td class="parameter_description"><p>How to apply the brush.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>method</p></td>
<td class="parameter_description"><p>The paint method to use.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-eraser.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-eraser-default"></a><h3>gimp_eraser_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_eraser_default (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
<em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Erase using the current brush.</p>
<p>This tool erases using the current brush mask. This function
performs exactly the same as the <a class="link" href="libgimp-gimppainttools.html#gimp-eraser" title="gimp_eraser ()"><code class="function">gimp_eraser()</code></a> function except that
the tools arguments are obtained from the eraser option dialog. It
this dialog has not been activated then the dialogs default values
will be used.</p>
<div class="refsect3">
<a name="gimp-eraser-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-eraser-default.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-heal"></a><h3>gimp_heal ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_heal (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gint32</span> src_drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> src_x</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> src_y</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
<em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Heal from the source to the dest drawable using the current brush</p>
<p>This tool heals the source drawable starting at the specified source
coordinates to the dest drawable. For image healing, if the sum of
the src coordinates and subsequent stroke offsets exceeds the
extents of the src drawable, then no paint is transferred. The
healing tool is capable of transforming between any image types
except RGB->Indexed.</p>
<div class="refsect3">
<a name="gimp-heal.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>src_drawable_ID</p></td>
<td class="parameter_description"><p>The source drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>src_x</p></td>
<td class="parameter_description"><p>The x coordinate in the source image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>src_y</p></td>
<td class="parameter_description"><p>The y coordinate in the source image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-heal.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-heal-default"></a><h3>gimp_heal_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_heal_default (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
<em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Heal from the source to the dest drawable using the current brush</p>
<p>This tool heals from the source drawable starting at the specified
source coordinates to the dest drawable. This function performs
exactly the same as the <a class="link" href="libgimp-gimppainttools.html#gimp-heal" title="gimp_heal ()"><code class="function">gimp_heal()</code></a> function except that the tools
arguments are obtained from the healing option dialog. It this
dialog has not been activated then the dialogs default values will
be used.</p>
<div class="refsect3">
<a name="gimp-heal-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-heal-default.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-paintbrush"></a><h3>gimp_paintbrush ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_paintbrush (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> fade_out</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
<em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>,
<em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpPaintApplicationMode"><span class="type">GimpPaintApplicationMode</span></a> method</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> gradient_length</code></em>);</pre>
<p>Paint in the current brush with optional fade out parameter and pull
colors from a gradient.</p>
<p>This tool is the standard paintbrush. It draws linearly interpolated
lines through the specified stroke coordinates. It operates on the
specified drawable in the foreground color with the active brush.
The 'fade-out' parameter is measured in pixels and allows the brush
stroke to linearly fall off. The pressure is set to the maximum at
the beginning of the stroke. As the distance of the stroke nears the
fade-out value, the pressure will approach zero. The gradient-length
is the distance to spread the gradient over. It is measured in
pixels. If the gradient-length is 0, no gradient is used.</p>
<div class="refsect3">
<a name="gimp-paintbrush.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fade_out</p></td>
<td class="parameter_description"><p>Fade out parameter.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>method</p></td>
<td class="parameter_description"><p>The paint method to use.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>gradient_length</p></td>
<td class="parameter_description"><p>Length of gradient to draw.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-paintbrush.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-paintbrush-default"></a><h3>gimp_paintbrush_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_paintbrush_default (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
<em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Paint in the current brush. The fade out parameter and pull colors
from a gradient parameter are set from the paintbrush options
dialog. If this dialog has not been activated then the dialog
defaults will be used.</p>
<p>This tool is similar to the standard paintbrush. It draws linearly
interpolated lines through the specified stroke coordinates. It
operates on the specified drawable in the foreground color with the
active brush. The 'fade-out' parameter is measured in pixels and
allows the brush stroke to linearly fall off (value obtained from
the option dialog). The pressure is set to the maximum at the
beginning of the stroke. As the distance of the stroke nears the
fade-out value, the pressure will approach zero. The gradient-length
(value obtained from the option dialog) is the distance to spread
the gradient over. It is measured in pixels. If the gradient-length
is 0, no gradient is used.</p>
<div class="refsect3">
<a name="gimp-paintbrush-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-paintbrush-default.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pencil"></a><h3>gimp_pencil ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_pencil (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
<em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Paint in the current brush without sub-pixel sampling.</p>
<p>This tool is the standard pencil. It draws linearly interpolated
lines through the specified stroke coordinates. It operates on the
specified drawable in the foreground color with the active brush.
The brush mask is treated as though it contains only black and white
values. Any value below half is treated as black; any above half, as
white.</p>
<div class="refsect3">
<a name="gimp-pencil.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-pencil.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-smudge"></a><h3>gimp_smudge ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_smudge (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> pressure</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
<em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Smudge image with varying pressure.</p>
<p>This tool simulates a smudge using the current brush. High pressure
results in a greater smudge of paint while low pressure results in a
lesser smudge.</p>
<div class="refsect3">
<a name="gimp-smudge.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pressure</p></td>
<td class="parameter_description"><p>The pressure of the smudge strokes.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-smudge.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-smudge-default"></a><h3>gimp_smudge_default ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_smudge_default (<em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>,
<em class="parameter"><code><span class="type">gint</span> num_strokes</code></em>,
<em class="parameter"><code>const <span class="type">gdouble</span> *strokes</code></em>);</pre>
<p>Smudge image with varying pressure.</p>
<p>This tool simulates a smudge using the current brush. It behaves
exactly the same as <a class="link" href="libgimp-gimppainttools.html#gimp-smudge" title="gimp_smudge ()"><code class="function">gimp_smudge()</code></a> except that the pressure value is
taken from the smudge tool options or the options default if the
tools option dialog has not been activated.</p>
<div class="refsect3">
<a name="gimp-smudge-default.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>drawable_ID</p></td>
<td class="parameter_description"><p>The affected drawable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>num_strokes</p></td>
<td class="parameter_description"><p>Number of stroke control points (count each coordinate as 2 points).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>strokes</p></td>
<td class="parameter_description"><p>Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-smudge-default.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>
|
