File: gimp.h

package info (click to toggle)
gimp 2.2.13-1etch4
  • links: PTS
  • area: main
  • in suites: etch
  • size: 94,832 kB
  • ctags: 47,113
  • sloc: ansic: 524,858; xml: 36,798; lisp: 9,870; sh: 9,409; makefile: 7,923; python: 2,674; perl: 2,589; yacc: 520; lex: 334
file content (337 lines) | stat: -rw-r--r-- 11,184 bytes parent folder | download | duplicates (3)
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
/* LIBGIMP - The GIMP Library
 * Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
 *
 * gimp.h
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifndef __GIMP_H__
#define __GIMP_H__

#include <glib-object.h>

#include <libgimpcolor/gimpcolor.h>
#include <libgimpmath/gimpmath.h>
#include <libgimpbase/gimpbase.h>

#include <libgimp/gimpenums.h>
#include <libgimp/gimptypes.h>

#include <libgimp/gimpbrushes.h>
#include <libgimp/gimpbrushselect.h>
#include <libgimp/gimpchannel.h>
#include <libgimp/gimpdrawable.h>
#include <libgimp/gimpfontselect.h>
#include <libgimp/gimpgradients.h>
#include <libgimp/gimpgradientselect.h>
#include <libgimp/gimpimage.h>
#include <libgimp/gimplayer.h>
#include <libgimp/gimppalette.h>
#include <libgimp/gimppalettes.h>
#include <libgimp/gimppaletteselect.h>
#include <libgimp/gimppatterns.h>
#include <libgimp/gimppatternselect.h>
#include <libgimp/gimppixelfetcher.h>
#include <libgimp/gimppixelrgn.h>
#include <libgimp/gimpplugin.h>
#include <libgimp/gimpproceduraldb.h>
#include <libgimp/gimpprogress.h>
#include <libgimp/gimpregioniterator.h>
#include <libgimp/gimpselection.h>
#include <libgimp/gimptile.h>

#include <libgimp/gimp_pdb.h>

#ifdef G_OS_WIN32
#  include <stdlib.h>		/* For __argc and __argv */
#  ifdef LIBGIMP_COMPILATION
#    define GIMPVAR __declspec(dllexport)
#  else  /* !LIBGIMP_COMPILATION */
#    define GIMPVAR extern __declspec(dllimport)
#  endif /* !LIBGIMP_COMPILATION */
#else  /* !G_OS_WIN32 */
#  define GIMPVAR extern
#endif

G_BEGIN_DECLS


#define gimp_get_data         gimp_procedural_db_get_data
#define gimp_get_data_size    gimp_procedural_db_get_data_size
#define gimp_set_data         gimp_procedural_db_set_data


GIMPVAR const guint gimp_major_version;
GIMPVAR const guint gimp_minor_version;
GIMPVAR const guint gimp_micro_version;


typedef void (* GimpInitProc)  (void);
typedef void (* GimpQuitProc)  (void);
typedef void (* GimpQueryProc) (void);
typedef void (* GimpRunProc)   (const gchar      *name,
				gint              n_params,
				const GimpParam  *param,
				gint             *n_return_vals,
				GimpParam       **return_vals);


struct _GimpPlugInInfo
{
  /* 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;
};

struct _GimpParamDef
{
  GimpPDBArgType  type;
  gchar          *name;
  gchar          *description;
};

struct _GimpParamRegion
{
  gint32 x;
  gint32 y;
  gint32 width;
  gint32 height;
};

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;
};

struct _GimpParam
{
  GimpPDBArgType type;
  GimpParamData  data;
};



/**
 * MAIN():
 *
 * A macro that expands to the appropriate main() function for the
 * platform being compiled for.
 *
 * To use this macro, simply place a line that contains just the code
 * MAIN() at the toplevel of your file.  No semicolon should be used.
 *
 */

#ifdef G_OS_WIN32

/* Define WinMain() because plug-ins are built as GUI applications. Also
 * define a main() in case some plug-in still is built as a console
 * application.
 */
#  ifdef __GNUC__
#    ifndef _stdcall
#      define _stdcall __attribute__((stdcall))
#    endif
#  endif

#  define MAIN()					\
   struct HINSTANCE__;					\
   int _stdcall						\
   WinMain (struct HINSTANCE__ *hInstance, 		\
	    struct HINSTANCE__ *hPrevInstance,		\
	    char *lpszCmdLine,				\
	    int   nCmdShow)				\
   {							\
     return gimp_main (&PLUG_IN_INFO, __argc, __argv);	\
   }							\
							\
   int							\
   main (int argc, char *argv[])			\
   {							\
     return gimp_main (&PLUG_IN_INFO, argc, argv);	\
   }
#else
#  define MAIN()					\
   int							\
   main (int argc, char *argv[])			\
   {							\
     return gimp_main (&PLUG_IN_INFO, argc, argv);	\
   }
#endif


/* The main procedure that must be called with the PLUG_IN_INFO structure
 * and the 'argc' and 'argv' that are passed to "main".
 */
gint          gimp_main                (const GimpPlugInInfo *info,
                                        gint                  argc,
                                        gchar                *argv[]);

/* Forcefully causes the gimp library to exit and
 *  close down its connection to main gimp application.
 */
void          gimp_quit                (void) G_GNUC_NORETURN;


/* Install a procedure in the procedure database.
 */
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,
                                        GimpPDBProcType     type,
                                        gint                n_params,
                                        gint                n_return_vals,
                                        const GimpParamDef *params,
                                        const GimpParamDef *return_vals);

/* Install a temporary procedure in the procedure database.
 */
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,
                                        GimpPDBProcType     type,
                                        gint                n_params,
                                        gint                n_return_vals,
                                        const GimpParamDef *params,
                                        const GimpParamDef *return_vals,
                                        GimpRunProc         run_proc);

/* Uninstall a temporary procedure
 */
void          gimp_uninstall_temp_proc (const gchar     *name);

/* Notify the main GIMP application that the extension is ready to run
 */
void          gimp_extension_ack       (void);

/* Enable asynchronous processing of temp_procs
 */
void          gimp_extension_enable    (void);

/* Process one temp_proc and return
 */
void          gimp_extension_process   (guint            timeout);

/* Run a procedure in the procedure database. The parameters are
 *  specified via the variable length argument list. The return
 *  values are returned in the 'GimpParam*' array.
 */
GimpParam   * gimp_run_procedure       (const gchar     *name,
                                        gint            *n_return_vals,
                                        ...);

/* Run a procedure in the procedure database. The parameters are
 *  specified as an array of GimpParam.  The return
 *  values are returned in the 'GimpParam*' array.
 */
GimpParam   * gimp_run_procedure2      (const gchar     *name,
                                        gint            *n_return_vals,
                                        gint             n_params,
                                        const GimpParam *params);

/* Destroy the an array of parameters. This is useful for
 *  destroying the return values returned by a call to
 *  'gimp_run_procedure'.
 */
void          gimp_destroy_params      (GimpParam       *params,
                                        gint             n_params);

/* Destroy the an array of GimpParamDef's. This is useful for
 *  destroying the return values returned by a call to
 *  'gimp_query_procedure'.
 */
void          gimp_destroy_paramdefs   (GimpParamDef    *paramdefs,
                                        gint             n_params);


/* Return various constants given by the GIMP core at plug-in config time.
 */
guint         gimp_tile_width          (void) G_GNUC_CONST;
guint         gimp_tile_height         (void) G_GNUC_CONST;
gint          gimp_shm_ID              (void) G_GNUC_CONST;
guchar      * gimp_shm_addr            (void) G_GNUC_CONST;
gdouble       gimp_gamma               (void) G_GNUC_CONST;
gboolean      gimp_install_cmap        (void) G_GNUC_CONST;
gint          gimp_min_colors          (void) G_GNUC_CONST;
gboolean      gimp_show_tool_tips      (void) G_GNUC_CONST;
gboolean      gimp_show_help_button    (void) G_GNUC_CONST;
GimpCheckSize gimp_check_size          (void) G_GNUC_CONST;
GimpCheckType gimp_check_type          (void) G_GNUC_CONST;
gint32        gimp_default_display     (void) G_GNUC_CONST;
const gchar * gimp_wm_class            (void) G_GNUC_CONST;
const gchar * gimp_display_name        (void) G_GNUC_CONST;
gint          gimp_monitor_number      (void) G_GNUC_CONST;

const gchar * gimp_get_progname        (void) G_GNUC_CONST;


void          gimp_attach_new_parasite (const gchar    *name,
                                        gint            flags,
                                        gint            size,
                                        gconstpointer   data);


G_END_DECLS

#endif /* __GIMP_H__ */