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
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimp</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="prev" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="next" href="libgimp-gimpcontext.html" title="gimpcontext">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gimpdefinitions.html" title="Part I. GIMP Constants">
<link rel="part" href="libgimp.html" title="Part II. GIMP Library">
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="part" href="libgimpui.html" title="Part III. GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
</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="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimp-general.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-general.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimpcontext.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2536430" class="shortcut">Top</a>
 | 
<a href="#id2570683" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimp"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2536430"></a><span class="refentrytitle">gimp</span>
</h2>
<p>gimp — Main functions needed for building a GIMP plug-in. This header includes
all other GIMP Library headers.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#define <a href="libgimp-gimp.html#GIMPVAR:CAPS">GIMPVAR</a>
gchar* <a href="libgimp-gimp.html#gimp-version">gimp_version</a> (void);
extern const guint <a href="libgimp-gimp.html#gimp-major-version">gimp_major_version</a>;
extern const guint <a href="libgimp-gimp.html#gimp-minor-version">gimp_minor_version</a>;
extern const guint <a href="libgimp-gimp.html#gimp-micro-version">gimp_micro_version</a>;
#define <a href="libgimp-gimp.html#gimp-get-data">gimp_get_data</a>
#define <a href="libgimp-gimp.html#gimp-get-data-size">gimp_get_data_size</a>
#define <a href="libgimp-gimp.html#gimp-set-data">gimp_set_data</a>
void (<a href="libgimp-gimp.html#GimpInitProc">*GimpInitProc</a>) (void);
void (<a href="libgimp-gimp.html#GimpQuitProc">*GimpQuitProc</a>) (void);
void (<a href="libgimp-gimp.html#GimpQueryProc">*GimpQueryProc</a>) (void);
void (<a href="libgimp-gimp.html#GimpRunProc">*GimpRunProc</a>) (const gchar *name,
gint n_params,
const <a href="libgimp-gimp.html#GimpParam">GimpParam</a> *param,
gint *n_return_vals,
<a href="libgimp-gimp.html#GimpParam">GimpParam</a> **return_vals);
<a href="libgimp-gimp.html#GimpPlugInInfo">GimpPlugInInfo</a>;
<a href="libgimp-gimp.html#GimpParamDef">GimpParamDef</a>;
<a href="libgimp-gimp.html#GimpParamRegion">GimpParamRegion</a>;
union <a href="libgimp-gimp.html#GimpParamData">GimpParamData</a>;
<a href="libgimp-gimp.html#GimpParam">GimpParam</a>;
#define <a href="libgimp-gimp.html#MAIN:CAPS">MAIN</a> ()
gint <a href="libgimp-gimp.html#gimp-main">gimp_main</a> (const <a href="libgimp-gimp.html#GimpPlugInInfo">GimpPlugInInfo</a> *info,
gint argc,
gchar *argv[]);
void <a href="libgimp-gimp.html#gimp-quit">gimp_quit</a> (void);
void <a href="libgimp-gimp.html#gimp-install-procedure">gimp_install_procedure</a> (const gchar *name,
const gchar *blurb,
const gchar *help,
const gchar *author,
const gchar *copyright,
const gchar *date,
const gchar *menu_label,
const gchar *image_types,
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBProcType"
>GimpPDBProcType</a> type,
gint n_params,
gint n_return_vals,
const <a href="libgimp-gimp.html#GimpParamDef">GimpParamDef</a> *params,
const <a href="libgimp-gimp.html#GimpParamDef">GimpParamDef</a> *return_vals);
void <a href="libgimp-gimp.html#gimp-install-temp-proc">gimp_install_temp_proc</a> (const gchar *name,
const gchar *blurb,
const gchar *help,
const gchar *author,
const gchar *copyright,
const gchar *date,
const gchar *menu_label,
const gchar *image_types,
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBProcType"
>GimpPDBProcType</a> type,
gint n_params,
gint n_return_vals,
const <a href="libgimp-gimp.html#GimpParamDef">GimpParamDef</a> *params,
const <a href="libgimp-gimp.html#GimpParamDef">GimpParamDef</a> *return_vals,
<a href="libgimp-gimp.html#GimpRunProc">GimpRunProc</a> run_proc);
void <a href="libgimp-gimp.html#gimp-uninstall-temp-proc">gimp_uninstall_temp_proc</a> (const gchar *name);
<a href="libgimp-gimp.html#GimpParam">GimpParam</a>* <a href="libgimp-gimp.html#gimp-run-procedure">gimp_run_procedure</a> (const gchar *name,
gint *n_return_vals,
...);
<a href="libgimp-gimp.html#GimpParam">GimpParam</a>* <a href="libgimp-gimp.html#gimp-run-procedure2">gimp_run_procedure2</a> (const gchar *name,
gint *n_return_vals,
gint n_params,
const <a href="libgimp-gimp.html#GimpParam">GimpParam</a> *params);
void <a href="libgimp-gimp.html#gimp-destroy-params">gimp_destroy_params</a> (<a href="libgimp-gimp.html#GimpParam">GimpParam</a> *params,
gint n_params);
void <a href="libgimp-gimp.html#gimp-destroy-paramdefs">gimp_destroy_paramdefs</a> (<a href="libgimp-gimp.html#GimpParamDef">GimpParamDef</a> *paramdefs,
gint n_params);
guint <a href="libgimp-gimp.html#gimp-tile-width">gimp_tile_width</a> (void);
guint <a href="libgimp-gimp.html#gimp-tile-height">gimp_tile_height</a> (void);
gint <a href="libgimp-gimp.html#gimp-shm-ID">gimp_shm_ID</a> (void);
guchar* <a href="libgimp-gimp.html#gimp-shm-addr">gimp_shm_addr</a> (void);
gdouble <a href="libgimp-gimp.html#gimp-gamma">gimp_gamma</a> (void);
gboolean <a href="libgimp-gimp.html#gimp-install-cmap">gimp_install_cmap</a> (void);
gint <a href="libgimp-gimp.html#gimp-min-colors">gimp_min_colors</a> (void);
gboolean <a href="libgimp-gimp.html#gimp-show-tool-tips">gimp_show_tool_tips</a> (void);
gboolean <a href="libgimp-gimp.html#gimp-show-help-button">gimp_show_help_button</a> (void);
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckSize"
>GimpCheckSize</a> <a href="libgimp-gimp.html#gimp-check-size">gimp_check_size</a> (void);
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckType"
>GimpCheckType</a> <a href="libgimp-gimp.html#gimp-check-type">gimp_check_type</a> (void);
gint32 <a href="libgimp-gimp.html#gimp-default-display">gimp_default_display</a> (void);
const gchar* <a href="libgimp-gimp.html#gimp-wm-class">gimp_wm_class</a> (void);
const gchar* <a href="libgimp-gimp.html#gimp-display-name">gimp_display_name</a> (void);
gint <a href="libgimp-gimp.html#gimp-monitor-number">gimp_monitor_number</a> (void);
const gchar* <a href="libgimp-gimp.html#gimp-get-progname">gimp_get_progname</a> (void);
void <a href="libgimp-gimp.html#gimp-extension-enable">gimp_extension_enable</a> (void);
void <a href="libgimp-gimp.html#gimp-extension-ack">gimp_extension_ack</a> (void);
void <a href="libgimp-gimp.html#gimp-extension-process">gimp_extension_process</a> (guint timeout);
<a
href="../libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"
>GimpParasite</a>* <a href="libgimp-gimp.html#gimp-parasite-find">gimp_parasite_find</a> (const gchar *name);
gboolean <a href="libgimp-gimp.html#gimp-parasite-list">gimp_parasite_list</a> (gint *num_parasites,
gchar ***parasites);
gboolean <a href="libgimp-gimp.html#gimp-parasite-attach">gimp_parasite_attach</a> (<a
href="../libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"
>GimpParasite</a> *parasite);
gboolean <a href="libgimp-gimp.html#gimp-parasite-detach">gimp_parasite_detach</a> (const gchar *name);
void <a href="libgimp-gimp.html#gimp-attach-new-parasite">gimp_attach_new_parasite</a> (const gchar *name,
gint flags,
gint size,
gconstpointer data);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2570683"></a><h2>Description</h2>
<p>
Main functions needed for building a GIMP plug-in. This header includes
all other GIMP Library headers.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2570699"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2570708"></a><h3>
<a name="GIMPVAR:CAPS"></a>GIMPVAR</h3>
<a class="indexterm" name="id2570718"></a><pre class="programlisting">#define GIMPVAR</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2570732"></a><h3>
<a name="gimp-version"></a>gimp_version ()</h3>
<a class="indexterm" name="id2570742"></a><pre class="programlisting">gchar* gimp_version (void);</pre>
<p>
Returns the host gimp version.
</p>
<p>
This procedure returns the version number of the currently running
gimp.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The gimp version.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2570785"></a><h3>
<a name="gimp-major-version"></a>gimp_major_version</h3>
<a class="indexterm" name="id2570798"></a><pre class="programlisting">extern const guint gimp_major_version;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2570813"></a><h3>
<a name="gimp-minor-version"></a>gimp_minor_version</h3>
<a class="indexterm" name="id2570825"></a><pre class="programlisting">extern const guint gimp_minor_version;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2570841"></a><h3>
<a name="gimp-micro-version"></a>gimp_micro_version</h3>
<a class="indexterm" name="id2570853"></a><pre class="programlisting">extern const guint gimp_micro_version;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2570869"></a><h3>
<a name="gimp-get-data"></a>gimp_get_data</h3>
<a class="indexterm" name="id2570881"></a><pre class="programlisting">#define gimp_get_data gimp_procedural_db_get_data
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2570898"></a><h3>
<a name="gimp-get-data-size"></a>gimp_get_data_size</h3>
<a class="indexterm" name="id2570910"></a><pre class="programlisting">#define gimp_get_data_size gimp_procedural_db_get_data_size
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2570942"></a><h3>
<a name="gimp-set-data"></a>gimp_set_data</h3>
<a class="indexterm" name="id2570954"></a><pre class="programlisting">#define gimp_set_data gimp_procedural_db_set_data
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2570971"></a><h3>
<a name="GimpInitProc"></a>GimpInitProc ()</h3>
<a class="indexterm" name="id2570983"></a><pre class="programlisting">void (*GimpInitProc) (void);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2571004"></a><h3>
<a name="GimpQuitProc"></a>GimpQuitProc ()</h3>
<a class="indexterm" name="id2571017"></a><pre class="programlisting">void (*GimpQuitProc) (void);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2571038"></a><h3>
<a name="GimpQueryProc"></a>GimpQueryProc ()</h3>
<a class="indexterm" name="id2571050"></a><pre class="programlisting">void (*GimpQueryProc) (void);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2571071"></a><h3>
<a name="GimpRunProc"></a>GimpRunProc ()</h3>
<a class="indexterm" name="id2571084"></a><pre class="programlisting">void (*GimpRunProc) (const gchar *name,
gint n_params,
const <a href="libgimp-gimp.html#GimpParam">GimpParam</a> *param,
gint *n_return_vals,
<a href="libgimp-gimp.html#GimpParam">GimpParam</a> **return_vals);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>n_params</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>param</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>n_return_vals</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>return_vals</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2571214"></a><h3>
<a name="GimpPlugInInfo"></a>GimpPlugInInfo</h3>
<a class="indexterm" name="id2571227"></a><pre class="programlisting">typedef struct {
/* called when the gimp application initially starts up */
GimpInitProc init_proc;
/* called when the gimp application exits */
GimpQuitProc quit_proc;
/* called by the gimp so that the plug-in can inform the
* gimp of what it does. (ie. installing a procedure database
* procedure).
*/
GimpQueryProc query_proc;
/* called to run a procedure the plug-in installed in the
* procedure database.
*/
GimpRunProc run_proc;
} GimpPlugInInfo;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2571250"></a><h3>
<a name="GimpParamDef"></a>GimpParamDef</h3>
<a class="indexterm" name="id2571263"></a><pre class="programlisting">typedef struct {
GimpPDBArgType type;
gchar *name;
gchar *description;
} GimpParamDef;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2571280"></a><h3>
<a name="GimpParamRegion"></a>GimpParamRegion</h3>
<a class="indexterm" name="id2571293"></a><pre class="programlisting">typedef struct {
gint32 x;
gint32 y;
gint32 width;
gint32 height;
} GimpParamRegion;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2571310"></a><h3>
<a name="GimpParamData"></a>union GimpParamData</h3>
<a class="indexterm" name="id2571322"></a><pre class="programlisting">union GimpParamData
{
gint32 d_int32;
gint16 d_int16;
gint8 d_int8;
gdouble d_float;
gchar *d_string;
gint32 *d_int32array;
gint16 *d_int16array;
gint8 *d_int8array;
gdouble *d_floatarray;
gchar **d_stringarray;
GimpRGB d_color;
GimpParamRegion d_region;
gint32 d_display;
gint32 d_image;
gint32 d_layer;
gint32 d_layer_mask;
gint32 d_channel;
gint32 d_drawable;
gint32 d_selection;
gint32 d_boundary;
gint32 d_path;
gint32 d_unit;
GimpParasite d_parasite;
gint32 d_tattoo;
GimpPDBStatusType d_status;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2536494"></a><h3>
<a name="GimpParam"></a>GimpParam</h3>
<a class="indexterm" name="id2561585"></a><pre class="programlisting">typedef struct {
GimpPDBArgType type;
GimpParamData data;
} GimpParam;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2571359"></a><h3>
<a name="MAIN:CAPS"></a>MAIN()</h3>
<a class="indexterm" name="id2571370"></a><pre class="programlisting">#define MAIN()</pre>
<p>
A macro that expands to the appropriate <code class="function">main()</code> function for the
platform being compiled for.
</p>
<p>
To use this macro, simply place a line that contains just the code
<a href="libgimp-gimp.html#MAIN:CAPS"><code class="function">MAIN()</code></a> at the toplevel of your file. No semicolon should be used.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2571410"></a><h3>
<a name="gimp-main"></a>gimp_main ()</h3>
<a class="indexterm" name="id2571420"></a><pre class="programlisting">gint gimp_main (const <a href="libgimp-gimp.html#GimpPlugInInfo">GimpPlugInInfo</a> *info,
gint argc,
gchar *argv[]);</pre>
<p>
The main procedure that must be called with the PLUG_IN_INFO structure
and the 'argc' and 'argv' that are passed to "main".</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>info</code></em> :</span></td>
<td> the PLUG_IN_INFO structure
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>argc</code></em> :</span></td>
<td> the number of arguments
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>argv</code></em> :</span></td>
<td> the arguments
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2571514"></a><h3>
<a name="gimp-quit"></a>gimp_quit ()</h3>
<a class="indexterm" name="id2571525"></a><pre class="programlisting">void gimp_quit (void);</pre>
<p>
Forcefully causes the gimp library to exit and close down its
connection to main gimp application. This function never returns.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2571549"></a><h3>
<a name="gimp-install-procedure"></a>gimp_install_procedure ()</h3>
<a class="indexterm" name="id2571559"></a><pre class="programlisting">void gimp_install_procedure (const gchar *name,
const gchar *blurb,
const gchar *help,
const gchar *author,
const gchar *copyright,
const gchar *date,
const gchar *menu_label,
const gchar *image_types,
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBProcType"
>GimpPDBProcType</a> type,
gint n_params,
gint n_return_vals,
const <a href="libgimp-gimp.html#GimpParamDef">GimpParamDef</a> *params,
const <a href="libgimp-gimp.html#GimpParamDef">GimpParamDef</a> *return_vals);</pre>
<p>
Installs a new procedure with the PDB (procedural database).
</p>
<p>
Call this function from within your Plug-In's <code class="function">query()</code> function for
each procedure your Plug-In implements.
</p>
<p>
The <em class="parameter"><code>name</code></em> parameter is mandatory and should be unique, or it will
overwrite an already existing procedure (overwrite procedures only
if you know what you're doing).
</p>
<p>
The <em class="parameter"><code>blurb</code></em>, <em class="parameter"><code>help</code></em>, <em class="parameter"><code>author</code></em>, <em class="parameter"><code>copyright</code></em> and <em class="parameter"><code>date</code></em> parameters are
optional but then you shouldn't write procedures without proper
documentation, should you.
</p>
<p>
<em class="parameter"><code>menu_label</code></em> defines the label that should be used for the
procedure's menu entry (use <span class="type">NULL</span> if the procedure shouldn't have a
menu entry). The position where to register in the menu hierarchy
is choosen using <a href="libgimp-gimpplugin.html#gimp-plugin-menu-register"><code class="function">gimp_plugin_menu_register()</code></a>. This function also
still accepts the old (pre-2.2) way of registering a menu entry and
takes a string in the form "<Domain>/Path/To/My/Menu"
(e.g. "<Image>/Filters/Render/Useless").
</p>
<p>
<em class="parameter"><code>type</code></em> must be one of <span class="type">GIMP_PLUGIN</span> or <span class="type">GIMP_EXTENSION</span>. Note that
temporary procedures must be installed using
<a href="libgimp-gimp.html#gimp-install-temp-proc"><code class="function">gimp_install_temp_proc()</code></a>.
</p>
<p>
NOTE: Unlike the GIMP 1.2 API, <span class="type">GIMP_EXTENSION</span> no longer means
that the procedure's menu prefix is <Toolbox>, but that
it will install temporary procedures. Therefore, the GIMP core
will wait until the <span class="type">GIMP_EXTENSION</span> procedure has called
<a href="libgimp-gimp.html#gimp-extension-ack"><code class="function">gimp_extension_ack()</code></a>, which means that the procedure has done
its initialization, installed its temporary procedures and is
ready to run.
</p>
<p>
<span class="emphasis"><em>Not calling <a href="libgimp-gimp.html#gimp-extension-ack"><code class="function">gimp_extension_ack()</code></a> from a <span class="type">GIMP_EXTENSION</span>
procedure will cause th GIMP core to lock up.</em></span>
</p>
<p>
Additionally, a <span class="type">GIMP_EXTENSION</span> procedure with no parameters
(<em class="parameter"><code>n_params</code></em> == 0 and <em class="parameter"><code>params</code></em> == <span class="type">NULL</span>) is an "automatic" extension
that will be automatically started on each GIMP startup.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> the procedure's name.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>blurb</code></em> :</span></td>
<td> a short text describing what the procedure does.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>help</code></em> :</span></td>
<td> the help text for the procedure (usually considerably
longer than <em class="parameter"><code>blurb</code></em>).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>author</code></em> :</span></td>
<td> the procedure's author(s).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>copyright</code></em> :</span></td>
<td> the procedure's copyright.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>date</code></em> :</span></td>
<td> the date the procedure was added.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>menu_label</code></em> :</span></td>
<td> the label to use for the procedure's menu entry,
or <span class="type">NULL</span> if the procedure has no menu entry.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_types</code></em> :</span></td>
<td> the drawable types the procedure can handle.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>type</code></em> :</span></td>
<td> the type of the procedure.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>n_params</code></em> :</span></td>
<td> the number of parameters the procedure takes.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>n_return_vals</code></em> :</span></td>
<td> the number of return values the procedure returns.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>params</code></em> :</span></td>
<td> the procedure's parameters.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>return_vals</code></em> :</span></td>
<td> the procedure's return values.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2572053"></a><h3>
<a name="gimp-install-temp-proc"></a>gimp_install_temp_proc ()</h3>
<a class="indexterm" name="id2572063"></a><pre class="programlisting">void gimp_install_temp_proc (const gchar *name,
const gchar *blurb,
const gchar *help,
const gchar *author,
const gchar *copyright,
const gchar *date,
const gchar *menu_label,
const gchar *image_types,
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpPDBProcType"
>GimpPDBProcType</a> type,
gint n_params,
gint n_return_vals,
const <a href="libgimp-gimp.html#GimpParamDef">GimpParamDef</a> *params,
const <a href="libgimp-gimp.html#GimpParamDef">GimpParamDef</a> *return_vals,
<a href="libgimp-gimp.html#GimpRunProc">GimpRunProc</a> run_proc);</pre>
<p>
Installs a new temporary procedure with the PDB (procedural database).
</p>
<p>
A temporary procedure is a procedure which is only available while
one of your Plug-In's "real" procedures is running.
</p>
<p>
See <a href="libgimp-gimp.html#gimp-install-procedure"><code class="function">gimp_install_procedure()</code></a> for most details.
</p>
<p>
<em class="parameter"><code>type</code></em> <span class="emphasis"><em>must</em></span> be <span class="type">GIMP_TEMPORARY</span> or the function
will fail.
</p>
<p>
<em class="parameter"><code>run_proc</code></em> is the function which will be called to execute the
procedure.
</p>
<p>
NOTE: Normally, Plug-In communication is triggered by the Plug-In
and the GIMP core only responds to the Plug-In's requests. You must
explicitely enable receiving of temporary procedure run requests
using either <a href="libgimp-gimp.html#gimp-extension-enable"><code class="function">gimp_extension_enable()</code></a> or
<a href="libgimp-gimp.html#gimp-extension-process"><code class="function">gimp_extension_process()</code></a>. See this functions' documentation for
details.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> the procedure's name.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>blurb</code></em> :</span></td>
<td> a short text describing what the procedure does.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>help</code></em> :</span></td>
<td> the help text for the procedure (usually considerably
longer than <em class="parameter"><code>blurb</code></em>).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>author</code></em> :</span></td>
<td> the procedure's author(s).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>copyright</code></em> :</span></td>
<td> the procedure's copyright.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>date</code></em> :</span></td>
<td> the date the procedure was added.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>menu_label</code></em> :</span></td>
<td> the procedure's menu label, or <span class="type">NULL</span> if the procedure has
no menu entry.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_types</code></em> :</span></td>
<td> the drawable types the procedure can handle.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>type</code></em> :</span></td>
<td> the type of the procedure.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>n_params</code></em> :</span></td>
<td> the number of parameters the procedure takes.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>n_return_vals</code></em> :</span></td>
<td> the number of return values the procedure returns.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>params</code></em> :</span></td>
<td> the procedure's parameters.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>return_vals</code></em> :</span></td>
<td> the procedure's return values.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>run_proc</code></em> :</span></td>
<td> the function to call for executing the procedure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2572450"></a><h3>
<a name="gimp-uninstall-temp-proc"></a>gimp_uninstall_temp_proc ()</h3>
<a class="indexterm" name="id2572460"></a><pre class="programlisting">void gimp_uninstall_temp_proc (const gchar *name);</pre>
<p>
Uninstalls a temporary procedure which has previously been
installed using <a href="libgimp-gimp.html#gimp-install-temp-proc"><code class="function">gimp_install_temp_proc()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> the procedure's name
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2572514"></a><h3>
<a name="gimp-run-procedure"></a>gimp_run_procedure ()</h3>
<a class="indexterm" name="id2572524"></a><pre class="programlisting"><a href="libgimp-gimp.html#GimpParam">GimpParam</a>* gimp_run_procedure (const gchar *name,
gint *n_return_vals,
...);</pre>
<p>
This function calls a GIMP procedure and returns its return values.
</p>
<p>
The procedure's parameters are given by a va_list in the format
(type, value, type, value) and must be terminated by <span class="type">GIMP_PDB_END</span>.
</p>
<p>
This function converts the va_list of parameters into an array
and passes them to <a href="libgimp-gimp.html#gimp-run-procedure2"><code class="function">gimp_run_procedure2()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> the name of the procedure to run
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>n_return_vals</code></em> :</span></td>
<td> return location for the number of return values
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>...</code></em> :</span></td>
<td> list of procedure parameters
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the procedure's return values.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2572640"></a><h3>
<a name="gimp-run-procedure2"></a>gimp_run_procedure2 ()</h3>
<a class="indexterm" name="id2572650"></a><pre class="programlisting"><a href="libgimp-gimp.html#GimpParam">GimpParam</a>* gimp_run_procedure2 (const gchar *name,
gint *n_return_vals,
gint n_params,
const <a href="libgimp-gimp.html#GimpParam">GimpParam</a> *params);</pre>
<p>
This function calls a GIMP procedure and returns its return values.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> the name of the procedure to run
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>n_return_vals</code></em> :</span></td>
<td> return location for the number of return values
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>n_params</code></em> :</span></td>
<td> the number of parameters the procedure takes.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>params</code></em> :</span></td>
<td> the procedure's parameters array.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the procedure's return values.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2572766"></a><h3>
<a name="gimp-destroy-params"></a>gimp_destroy_params ()</h3>
<a class="indexterm" name="id2572776"></a><pre class="programlisting">void gimp_destroy_params (<a href="libgimp-gimp.html#GimpParam">GimpParam</a> *params,
gint n_params);</pre>
<p>
Destroys a <a href="libgimp-gimp.html#GimpParam"><span class="type">GimpParam</span></a> array as returned by <a href="libgimp-gimp.html#gimp-run-procedure"><code class="function">gimp_run_procedure()</code></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>params</code></em> :</span></td>
<td> the <a href="libgimp-gimp.html#GimpParam"><span class="type">GimpParam</span></a> array to destroy
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>n_params</code></em> :</span></td>
<td> the number of elements in the array
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2572860"></a><h3>
<a name="gimp-destroy-paramdefs"></a>gimp_destroy_paramdefs ()</h3>
<a class="indexterm" name="id2572870"></a><pre class="programlisting">void gimp_destroy_paramdefs (<a href="libgimp-gimp.html#GimpParamDef">GimpParamDef</a> *paramdefs,
gint n_params);</pre>
<p>
Destroys a <a href="libgimp-gimp.html#GimpParamDef"><span class="type">GimpParamDef</span></a> array as returned by <code class="function">gimp_query_procedure()</code></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>paramdefs</code></em> :</span></td>
<td> the <a href="libgimp-gimp.html#GimpParamDef"><span class="type">GimpParamDef</span></a> array to destroy
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>n_params</code></em> :</span></td>
<td> the number of elements in the array
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2572953"></a><h3>
<a name="gimp-tile-width"></a>gimp_tile_width ()</h3>
<a class="indexterm" name="id2572964"></a><pre class="programlisting">guint gimp_tile_width (void);</pre>
<p>
Returns the tile_width the GIMP is using. This is a constant value
given at Plug-In config time.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the tile_width
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573001"></a><h3>
<a name="gimp-tile-height"></a>gimp_tile_height ()</h3>
<a class="indexterm" name="id2573011"></a><pre class="programlisting">guint gimp_tile_height (void);</pre>
<p>
Returns the tile_height the GIMP is using. This is a constant value
given at Plug-In config time.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the tile_height
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573049"></a><h3>
<a name="gimp-shm-ID"></a>gimp_shm_ID ()</h3>
<a class="indexterm" name="id2573059"></a><pre class="programlisting">gint gimp_shm_ID (void);</pre>
<p>
Returns the shared memory ID used for passing tile data between the GIMP
core and the Plug-In. This is a constant value
given at Plug-In config time.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the shared memory ID
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573097"></a><h3>
<a name="gimp-shm-addr"></a>gimp_shm_addr ()</h3>
<a class="indexterm" name="id2573108"></a><pre class="programlisting">guchar* gimp_shm_addr (void);</pre>
<p>
Returns the address of the shared memory segment used for passing
tile data between the GIMP core and the Plug-In. This is a constant
value given at Plug-In config time.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the shared memory address
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573146"></a><h3>
<a name="gimp-gamma"></a>gimp_gamma ()</h3>
<a class="indexterm" name="id2573157"></a><pre class="programlisting">gdouble gimp_gamma (void);</pre>
<p>
Returns the global gamma value the GIMP and all its Plug-Ins should
use. This is a constant value given at Plug-In config time.
</p>
<p>
NOTE: this feature is unimplemented.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the gamma value
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573199"></a><h3>
<a name="gimp-install-cmap"></a>gimp_install_cmap ()</h3>
<a class="indexterm" name="id2573209"></a><pre class="programlisting">gboolean gimp_install_cmap (void);</pre>
<p>
Returns whether or not the Plug-In should allocate an own colormap
when running on an 8 bit display. This is a constant value given at
Plug-In config time.
</p>
<p>
See also: <a href="libgimp-gimp.html#gimp-min-colors"><code class="function">gimp_min_colors()</code></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the install_cmap boolean
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573258"></a><h3>
<a name="gimp-min-colors"></a>gimp_min_colors ()</h3>
<a class="indexterm" name="id2573268"></a><pre class="programlisting">gint gimp_min_colors (void);</pre>
<p>
Returns the minimum number of colors to use when allocating an own
colormap on 8 bit displays. This is a constant value given at
Plug-In config time.
</p>
<p>
See also: <a href="libgimp-gimp.html#gimp-install-cmap"><code class="function">gimp_install_cmap()</code></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the minimum number of colors to allocate
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573318"></a><h3>
<a name="gimp-show-tool-tips"></a>gimp_show_tool_tips ()</h3>
<a class="indexterm" name="id2573328"></a><pre class="programlisting">gboolean gimp_show_tool_tips (void);</pre>
<p>
Returns whether or not the Plug-In should show tooltips. This is a
constant value given at Plug-In config time.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the show_tool_tips boolean
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573366"></a><h3>
<a name="gimp-show-help-button"></a>gimp_show_help_button ()</h3>
<a class="indexterm" name="id2573378"></a><pre class="programlisting">gboolean gimp_show_help_button (void);</pre>
<p>
Returns whether or not GimpDialog should automatically add a help
button if help_func and help_id are given.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the show_help_button boolean
</td>
</tr></tbody>
</table></div>
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573421"></a><h3>
<a name="gimp-check-size"></a>gimp_check_size ()</h3>
<a class="indexterm" name="id2573433"></a><pre class="programlisting"><a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckSize"
>GimpCheckSize</a> gimp_check_size (void);</pre>
<p>
Returns the size of the checkerboard to be used in previews.
This is a constant value given at Plug-In config time.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the check_size value
</td>
</tr></tbody>
</table></div>
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573475"></a><h3>
<a name="gimp-check-type"></a>gimp_check_type ()</h3>
<a class="indexterm" name="id2573487"></a><pre class="programlisting"><a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckType"
>GimpCheckType</a> gimp_check_type (void);</pre>
<p>
Returns the type of the checkerboard to be used in previews.
This is a constant value given at Plug-In config time.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the check_type value
</td>
</tr></tbody>
</table></div>
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573529"></a><h3>
<a name="gimp-default-display"></a>gimp_default_display ()</h3>
<a class="indexterm" name="id2573539"></a><pre class="programlisting">gint32 gimp_default_display (void);</pre>
<p>
Returns the default display ID. This corresponds to the display the
running procedure's menu entry was invoked from. This is a
constant value given at Plug-In config time.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the default display ID
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573578"></a><h3>
<a name="gimp-wm-class"></a>gimp_wm_class ()</h3>
<a class="indexterm" name="id2573588"></a><pre class="programlisting">const gchar* gimp_wm_class (void);</pre>
<p>
Returns the window manager class to be used for plug-in windows.
This is a constant value given at Plug-In config time.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the window manager class
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573627"></a><h3>
<a name="gimp-display-name"></a>gimp_display_name ()</h3>
<a class="indexterm" name="id2573638"></a><pre class="programlisting">const gchar* gimp_display_name (void);</pre>
<p>
Returns the display to be used for plug-in windows.
This is a constant value given at Plug-In config time.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the display name
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573676"></a><h3>
<a name="gimp-monitor-number"></a>gimp_monitor_number ()</h3>
<a class="indexterm" name="id2573686"></a><pre class="programlisting">gint gimp_monitor_number (void);</pre>
<p>
Returns the monitor number to be used for plug-in windows.
This is a constant value given at Plug-In config time.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the monitor number
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573724"></a><h3>
<a name="gimp-get-progname"></a>gimp_get_progname ()</h3>
<a class="indexterm" name="id2573734"></a><pre class="programlisting">const gchar* gimp_get_progname (void);</pre>
<p>
Returns the Plug-In's executable name.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the executable name
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573772"></a><h3>
<a name="gimp-extension-enable"></a>gimp_extension_enable ()</h3>
<a class="indexterm" name="id2573782"></a><pre class="programlisting">void gimp_extension_enable (void);</pre>
<p>
Enables asnychronous processing of messages from the main GIMP
application.
</p>
<p>
Normally, a plug-in is not called by the GIMP except for the call
to the procedure it implements. All subsequent communication is
triggered by the plug-in and all messages sent from the GIMP to the
plug-in are just answers to requests the plug-in made.
</p>
<p>
If the plug-in however registered temporary procedures using
<a href="libgimp-gimp.html#gimp-install-temp-proc"><code class="function">gimp_install_temp_proc()</code></a>, it needs to be able to receive requests
to execute them. Usually this will be done by running
<a href="libgimp-gimp.html#gimp-extension-process"><code class="function">gimp_extension_process()</code></a> in an endless loop.
</p>
<p>
If the plug-in cannot use <a href="libgimp-gimp.html#gimp-extension-process"><code class="function">gimp_extension_process()</code></a>, i.e. if it has
a GUI and is hanging around in a <span class="type">GMainLoop</span>, it must call
<a href="libgimp-gimp.html#gimp-extension-enable"><code class="function">gimp_extension_enable()</code></a>.
</p>
<p>
Note that the plug-in does not need to be a <span class="type">GIMP_EXTENSION</span> to
register temporary procedures.
</p>
<p>
See also: <a href="libgimp-gimp.html#gimp-install-procedure"><code class="function">gimp_install_procedure()</code></a>, <a href="libgimp-gimp.html#gimp-install-temp-proc"><code class="function">gimp_install_temp_proc()</code></a></p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573907"></a><h3>
<a name="gimp-extension-ack"></a>gimp_extension_ack ()</h3>
<a class="indexterm" name="id2573920"></a><pre class="programlisting">void gimp_extension_ack (void);</pre>
<p>
Notify the main GIMP application that the extension has been properly
initialized and is ready to run.
</p>
<p>
This function <span class="emphasis"><em>must</em></span> be called from every
procedure that was registered as <span class="type">GIMP_EXTENSION</span>.
</p>
<p>
Subsequently, extensions can process temporary procedure run
requests using either <a href="libgimp-gimp.html#gimp-extension-enable"><code class="function">gimp_extension_enable()</code></a> or
<a href="libgimp-gimp.html#gimp-extension-process"><code class="function">gimp_extension_process()</code></a>.
</p>
<p>
See also: <a href="libgimp-gimp.html#gimp-install-procedure"><code class="function">gimp_install_procedure()</code></a>, <a href="libgimp-gimp.html#gimp-install-temp-proc"><code class="function">gimp_install_temp_proc()</code></a></p>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2574009"></a><h3>
<a name="gimp-extension-process"></a>gimp_extension_process ()</h3>
<a class="indexterm" name="id2574022"></a><pre class="programlisting">void gimp_extension_process (guint timeout);</pre>
<p>
Processes one message sent by the GIMP and returns.
</p>
<p>
Call this function in an endless loop after calling
<a href="libgimp-gimp.html#gimp-extension-ack"><code class="function">gimp_extension_ack()</code></a> to process requests for running temporary
procedures.
</p>
<p>
See <a href="libgimp-gimp.html#gimp-extension-enable"><code class="function">gimp_extension_enable()</code></a> for an asynchronous way of doing the
same if running an endless loop is not an option.
</p>
<p>
See also: <a href="libgimp-gimp.html#gimp-install-procedure"><code class="function">gimp_install_procedure()</code></a>, <a href="libgimp-gimp.html#gimp-install-temp-proc"><code class="function">gimp_install_temp_proc()</code></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>timeout</code></em> :</span></td>
<td> The timeout (in ms) to use for the <code class="function">select()</code> call.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2574135"></a><h3>
<a name="gimp-parasite-find"></a>gimp_parasite_find ()</h3>
<a class="indexterm" name="id2574148"></a><pre class="programlisting"><a
href="../libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"
>GimpParasite</a>* gimp_parasite_find (const gchar *name);</pre>
<p>
Finds the named parasite.
</p>
<p>
Finds and returns the named parasite that was previously attached to
the gimp.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The name of the parasite to find.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The found parasite.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2574214"></a><h3>
<a name="gimp-parasite-list"></a>gimp_parasite_list ()</h3>
<a class="indexterm" name="id2574228"></a><pre class="programlisting">gboolean gimp_parasite_list (gint *num_parasites,
gchar ***parasites);</pre>
<p>
List all parasites.
</p>
<p>
Returns a list of all currently attached parasites.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>num_parasites</code></em> :</span></td>
<td> The number of attached parasites.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>parasites</code></em> :</span></td>
<td> The names of currently attached parasites.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2574315"></a><h3>
<a name="gimp-parasite-attach"></a>gimp_parasite_attach ()</h3>
<a class="indexterm" name="id2574329"></a><pre class="programlisting">gboolean gimp_parasite_attach (<a
href="../libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"
>GimpParasite</a> *parasite);</pre>
<p>
Add a parasite to the gimp.
</p>
<p>
This procedure attaches a parasite to the gimp. It has no return
values.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>parasite</code></em> :</span></td>
<td> The parasite to attach to the gimp.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2574395"></a><h3>
<a name="gimp-parasite-detach"></a>gimp_parasite_detach ()</h3>
<a class="indexterm" name="id2574409"></a><pre class="programlisting">gboolean gimp_parasite_detach (const gchar *name);</pre>
<p>
Removes a parasite from the gimp.
</p>
<p>
This procedure detaches a parasite from the gimp. It has no return
values.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The name of the parasite to detach from the gimp.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2574475"></a><h3>
<a name="gimp-attach-new-parasite"></a>gimp_attach_new_parasite ()</h3>
<a class="indexterm" name="id2574488"></a><pre class="programlisting">void gimp_attach_new_parasite (const gchar *name,
gint flags,
gint size,
gconstpointer data);</pre>
<p>
Convenience function that creates a parasite and attaches it
to the GIMP.
</p>
<p>
See Also: <a href="libgimp-gimp.html#gimp-parasite-attach"><code class="function">gimp_parasite_attach()</code></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> the name of the <a
href="../libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"
><span class="type">GimpParasite</span></a> to create and attach.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>flags</code></em> :</span></td>
<td> the flags set on the <a
href="../libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"
><span class="type">GimpParasite</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size</code></em> :</span></td>
<td> the size of the parasite data in bytes.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em> :</span></td>
<td> a pointer to the data attached with the <a
href="../libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"
><span class="type">GimpParasite</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|
