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
|
/* LIBGIMP - The GIMP Library
* Copyright (C) 1995-2003 Peter Mattis and Spencer Kimball
*
* gimppalette_pdb.c
*
* 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 3 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, see
* <https://www.gnu.org/licenses/>.
*/
/* NOTE: This file is auto-generated by pdbgen.pl */
#include "config.h"
#include "stamp-pdbgen.h"
#include "gimp.h"
/**
* SECTION: gimppalette
* @title: gimppalette
* @short_description: Installable object, a small set of colors a user can choose from.
*
* Installable object, a small set of colors a user can choose from.
**/
/**
* gimp_palette_new:
* @name: The requested name of the new palette.
*
* Creates a new palette
*
* Creates a new palette. The new palette has no color entries. You
* must add color entries for a user to choose. The actual name might
* be different than the requested name, when the requested name is
* already in use.
*
* Returns: (transfer none): The palette.
*
* Since: 2.2
**/
GimpPalette *
gimp_palette_new (const gchar *name)
{
GimpValueArray *args;
GimpValueArray *return_vals;
GimpPalette *palette = NULL;
args = gimp_value_array_new_from_types (NULL,
G_TYPE_STRING, name,
G_TYPE_NONE);
return_vals = _gimp_pdb_run_procedure_array (gimp_get_pdb (),
"gimp-palette-new",
args);
gimp_value_array_unref (args);
if (GIMP_VALUES_GET_ENUM (return_vals, 0) == GIMP_PDB_SUCCESS)
palette = GIMP_VALUES_GET_PALETTE (return_vals, 1);
gimp_value_array_unref (return_vals);
return palette;
}
/**
* gimp_palette_get_by_name:
* @name: The name of the palette.
*
* Returns the palette with the given name.
*
* Returns an existing palette having the given name. Returns %NULL
* when no palette exists of that name.
*
* Returns: (nullable) (transfer none): The palette.
*
* Since: 3.0
**/
GimpPalette *
gimp_palette_get_by_name (const gchar *name)
{
GimpValueArray *args;
GimpValueArray *return_vals;
GimpPalette *palette = NULL;
args = gimp_value_array_new_from_types (NULL,
G_TYPE_STRING, name,
G_TYPE_NONE);
return_vals = _gimp_pdb_run_procedure_array (gimp_get_pdb (),
"gimp-palette-get-by-name",
args);
gimp_value_array_unref (args);
if (GIMP_VALUES_GET_ENUM (return_vals, 0) == GIMP_PDB_SUCCESS)
palette = GIMP_VALUES_GET_PALETTE (return_vals, 1);
gimp_value_array_unref (return_vals);
return palette;
}
/**
* gimp_palette_get_color_count:
* @palette: The palette.
*
* Get the count of colors in the palette.
*
* Returns the number of colors in the palette.
*
* Returns: The number of colors in the palette.
*
* Since: 2.2
**/
gint
gimp_palette_get_color_count (GimpPalette *palette)
{
GimpValueArray *args;
GimpValueArray *return_vals;
gint num_colors = 0;
args = gimp_value_array_new_from_types (NULL,
GIMP_TYPE_PALETTE, palette,
G_TYPE_NONE);
return_vals = _gimp_pdb_run_procedure_array (gimp_get_pdb (),
"gimp-palette-get-color-count",
args);
gimp_value_array_unref (args);
if (GIMP_VALUES_GET_ENUM (return_vals, 0) == GIMP_PDB_SUCCESS)
num_colors = GIMP_VALUES_GET_INT (return_vals, 1);
gimp_value_array_unref (return_vals);
return num_colors;
}
/**
* gimp_palette_get_colors:
* @palette: The palette.
*
* Gets colors in the palette.
*
* Returns an array of colors in the palette. Free the returned array
* with gimp_color_array_free().
*
* Returns: (array zero-terminated=1) (transfer full):
* The colors in the palette.
* The returned value must be freed with gimp_color_array_free().
*
* Since: 2.6
**/
GeglColor **
gimp_palette_get_colors (GimpPalette *palette)
{
GimpValueArray *args;
GimpValueArray *return_vals;
GeglColor **colors = NULL;
args = gimp_value_array_new_from_types (NULL,
GIMP_TYPE_PALETTE, palette,
G_TYPE_NONE);
return_vals = _gimp_pdb_run_procedure_array (gimp_get_pdb (),
"gimp-palette-get-colors",
args);
gimp_value_array_unref (args);
if (GIMP_VALUES_GET_ENUM (return_vals, 0) == GIMP_PDB_SUCCESS)
colors = gimp_color_array_copy (g_value_get_boxed (gimp_value_array_index (return_vals, 1)));
gimp_value_array_unref (return_vals);
return colors;
}
/**
* gimp_palette_get_columns:
* @palette: The palette.
*
* Gets the number of columns used to display the palette
*
* Gets the preferred number of columns to display the palette.
*
* Returns: The number of columns used to display this palette.
*
* Since: 2.4
**/
gint
gimp_palette_get_columns (GimpPalette *palette)
{
GimpValueArray *args;
GimpValueArray *return_vals;
gint num_columns = 0;
args = gimp_value_array_new_from_types (NULL,
GIMP_TYPE_PALETTE, palette,
G_TYPE_NONE);
return_vals = _gimp_pdb_run_procedure_array (gimp_get_pdb (),
"gimp-palette-get-columns",
args);
gimp_value_array_unref (args);
if (GIMP_VALUES_GET_ENUM (return_vals, 0) == GIMP_PDB_SUCCESS)
num_columns = GIMP_VALUES_GET_INT (return_vals, 1);
gimp_value_array_unref (return_vals);
return num_columns;
}
/**
* gimp_palette_set_columns:
* @palette: The palette.
* @columns: The new number of columns.
*
* Sets the number of columns used to display the palette
*
* Set the number of colors shown per row when the palette is
* displayed. Returns an error when the palette is not editable. The
* maximum allowed value is 64.
*
* Returns: TRUE on success.
*
* Since: 2.4
**/
gboolean
gimp_palette_set_columns (GimpPalette *palette,
gint columns)
{
GimpValueArray *args;
GimpValueArray *return_vals;
gboolean success = TRUE;
args = gimp_value_array_new_from_types (NULL,
GIMP_TYPE_PALETTE, palette,
G_TYPE_INT, columns,
G_TYPE_NONE);
return_vals = _gimp_pdb_run_procedure_array (gimp_get_pdb (),
"gimp-palette-set-columns",
args);
gimp_value_array_unref (args);
success = GIMP_VALUES_GET_ENUM (return_vals, 0) == GIMP_PDB_SUCCESS;
gimp_value_array_unref (return_vals);
return success;
}
/**
* gimp_palette_add_entry:
* @palette: The palette.
* @entry_name: (nullable): A name for the entry.
* @color: The color for the added entry.
* @entry_num: (out): The index of the added entry.
*
* Appends an entry to the palette.
*
* Appends an entry to the palette. Neither color nor name must be
* unique within the palette. When name is the empty string, this sets
* the entry name to \"Untitled\". Returns the index of the entry.
* Returns an error when palette is not editable.
*
* Returns: TRUE on success.
*
* Since: 2.2
**/
gboolean
gimp_palette_add_entry (GimpPalette *palette,
const gchar *entry_name,
GeglColor *color,
gint *entry_num)
{
GimpValueArray *args;
GimpValueArray *return_vals;
gboolean success = TRUE;
args = gimp_value_array_new_from_types (NULL,
GIMP_TYPE_PALETTE, palette,
G_TYPE_STRING, entry_name,
GEGL_TYPE_COLOR, color,
G_TYPE_NONE);
return_vals = _gimp_pdb_run_procedure_array (gimp_get_pdb (),
"gimp-palette-add-entry",
args);
gimp_value_array_unref (args);
*entry_num = 0;
success = GIMP_VALUES_GET_ENUM (return_vals, 0) == GIMP_PDB_SUCCESS;
if (success)
*entry_num = GIMP_VALUES_GET_INT (return_vals, 1);
gimp_value_array_unref (return_vals);
return success;
}
/**
* gimp_palette_delete_entry:
* @palette: The palette.
* @entry_num: The index of the entry to delete.
*
* Deletes an entry from the palette.
*
* This function will fail and return %FALSE if the index is out or
* range or if the palette is not editable.
* Additionally if the palette belongs to an indexed image, it will
* only be possible to delete palette colors not in use in the image.
*
* Returns: TRUE on success.
*
* Since: 2.2
**/
gboolean
gimp_palette_delete_entry (GimpPalette *palette,
gint entry_num)
{
GimpValueArray *args;
GimpValueArray *return_vals;
gboolean success = TRUE;
args = gimp_value_array_new_from_types (NULL,
GIMP_TYPE_PALETTE, palette,
G_TYPE_INT, entry_num,
G_TYPE_NONE);
return_vals = _gimp_pdb_run_procedure_array (gimp_get_pdb (),
"gimp-palette-delete-entry",
args);
gimp_value_array_unref (args);
success = GIMP_VALUES_GET_ENUM (return_vals, 0) == GIMP_PDB_SUCCESS;
gimp_value_array_unref (return_vals);
return success;
}
/**
* gimp_palette_get_entry_color:
* @palette: The palette.
* @entry_num: The index of the entry to get the color of.
*
* Gets the color of an entry in the palette.
*
* Returns the color of the entry at the given zero-based index into
* the palette. Returns %NULL when the index is out of range.
*
* Returns: (transfer full): The color at the index.
*
* Since: 2.2
**/
GeglColor *
gimp_palette_get_entry_color (GimpPalette *palette,
gint entry_num)
{
GimpValueArray *args;
GimpValueArray *return_vals;
GeglColor *color = NULL;
args = gimp_value_array_new_from_types (NULL,
GIMP_TYPE_PALETTE, palette,
G_TYPE_INT, entry_num,
G_TYPE_NONE);
return_vals = _gimp_pdb_run_procedure_array (gimp_get_pdb (),
"gimp-palette-get-entry-color",
args);
gimp_value_array_unref (args);
if (GIMP_VALUES_GET_ENUM (return_vals, 0) == GIMP_PDB_SUCCESS)
color = g_value_dup_object (gimp_value_array_index (return_vals, 1));
gimp_value_array_unref (return_vals);
return color;
}
/**
* gimp_palette_set_entry_color:
* @palette: The palette.
* @entry_num: The entry to get.
* @color: The new color.
*
* Sets the color of an entry in the palette.
*
* Sets the color of the entry at the zero-based index into the
* palette. Returns an error when the index is out of range. Returns an
* error when the palette is not editable.
*
* Returns: TRUE on success.
*
* Since: 2.2
**/
gboolean
gimp_palette_set_entry_color (GimpPalette *palette,
gint entry_num,
GeglColor *color)
{
GimpValueArray *args;
GimpValueArray *return_vals;
gboolean success = TRUE;
args = gimp_value_array_new_from_types (NULL,
GIMP_TYPE_PALETTE, palette,
G_TYPE_INT, entry_num,
GEGL_TYPE_COLOR, color,
G_TYPE_NONE);
return_vals = _gimp_pdb_run_procedure_array (gimp_get_pdb (),
"gimp-palette-set-entry-color",
args);
gimp_value_array_unref (args);
success = GIMP_VALUES_GET_ENUM (return_vals, 0) == GIMP_PDB_SUCCESS;
gimp_value_array_unref (return_vals);
return success;
}
/**
* gimp_palette_get_entry_name:
* @palette: The palette.
* @entry_num: The entry to get.
* @entry_name: (out) (transfer full): The name of the entry.
*
* Gets the name of an entry in the palette.
*
* Gets the name of the entry at the zero-based index into the palette.
* Returns an error when the index is out of range.
*
* Returns: TRUE on success.
*
* Since: 2.2
**/
gboolean
gimp_palette_get_entry_name (GimpPalette *palette,
gint entry_num,
gchar **entry_name)
{
GimpValueArray *args;
GimpValueArray *return_vals;
gboolean success = TRUE;
args = gimp_value_array_new_from_types (NULL,
GIMP_TYPE_PALETTE, palette,
G_TYPE_INT, entry_num,
G_TYPE_NONE);
return_vals = _gimp_pdb_run_procedure_array (gimp_get_pdb (),
"gimp-palette-get-entry-name",
args);
gimp_value_array_unref (args);
*entry_name = NULL;
success = GIMP_VALUES_GET_ENUM (return_vals, 0) == GIMP_PDB_SUCCESS;
if (success)
*entry_name = GIMP_VALUES_DUP_STRING (return_vals, 1);
gimp_value_array_unref (return_vals);
return success;
}
/**
* gimp_palette_set_entry_name:
* @palette: The palette.
* @entry_num: The entry to get.
* @entry_name: (nullable): The new name.
*
* Sets the name of an entry in the palette.
*
* Sets the name of the entry at the zero-based index into the palette.
* Returns an error if the index is out or range. Returns an error if
* the palette is not editable.
*
* Returns: TRUE on success.
*
* Since: 2.2
**/
gboolean
gimp_palette_set_entry_name (GimpPalette *palette,
gint entry_num,
const gchar *entry_name)
{
GimpValueArray *args;
GimpValueArray *return_vals;
gboolean success = TRUE;
args = gimp_value_array_new_from_types (NULL,
GIMP_TYPE_PALETTE, palette,
G_TYPE_INT, entry_num,
G_TYPE_STRING, entry_name,
G_TYPE_NONE);
return_vals = _gimp_pdb_run_procedure_array (gimp_get_pdb (),
"gimp-palette-set-entry-name",
args);
gimp_value_array_unref (args);
success = GIMP_VALUES_GET_ENUM (return_vals, 0) == GIMP_PDB_SUCCESS;
gimp_value_array_unref (return_vals);
return success;
}
/**
* _gimp_palette_get_bytes:
* @palette: The palette.
* @format: The desired color format.
* @num_colors: (out): The number of colors in the palette.
*
* Returns the palette's colormap
*
* This procedure returns a palette's colormap as a bytes array with
* all colors converted to a given Babl @format.
* The byte-size of the returned colormap depends on the number of
* colors and on the bytes-per-pixel size of @format. E.g. that the
* following equality is ensured:
*
* ```C
* g_bytes_get_size (colormap) == num_colors *
* babl_format_get_bytes_per_pixel (format)
* ```
*
* Returns: (transfer full): The image's colormap.
*
* Since: 3.0
**/
GBytes *
_gimp_palette_get_bytes (GimpPalette *palette,
const Babl *format,
gint *num_colors)
{
GimpValueArray *args;
GimpValueArray *return_vals;
GBytes *colormap = NULL;
args = gimp_value_array_new_from_types (NULL,
GIMP_TYPE_PALETTE, palette,
GIMP_TYPE_BABL_FORMAT, format,
G_TYPE_NONE);
return_vals = _gimp_pdb_run_procedure_array (gimp_get_pdb (),
"gimp-palette-get-bytes",
args);
gimp_value_array_unref (args);
if (GIMP_VALUES_GET_ENUM (return_vals, 0) == GIMP_PDB_SUCCESS)
{
colormap = GIMP_VALUES_DUP_BYTES (return_vals, 1);
*num_colors = GIMP_VALUES_GET_INT (return_vals, 2);
}
gimp_value_array_unref (return_vals);
return colormap;
}
/**
* _gimp_palette_set_bytes:
* @palette: The palette.
* @format: The desired color format.
* @colormap: The new colormap values.
*
* Sets the entries in the image's colormap.
*
* This procedure sets the entries in the specified palette in one go.
* The number of entries depens on the size of @colormap and the
* bytes-per-pixel size of @format.
* The procedure will fail if the size of @colormap is not an exact
* multiple of the number of bytes per pixel of @format.
*
* Returns: TRUE on success.
*
* Since: 3.0
**/
gboolean
_gimp_palette_set_bytes (GimpPalette *palette,
const Babl *format,
GBytes *colormap)
{
GimpValueArray *args;
GimpValueArray *return_vals;
gboolean success = TRUE;
args = gimp_value_array_new_from_types (NULL,
GIMP_TYPE_PALETTE, palette,
GIMP_TYPE_BABL_FORMAT, format,
G_TYPE_BYTES, colormap,
G_TYPE_NONE);
return_vals = _gimp_pdb_run_procedure_array (gimp_get_pdb (),
"gimp-palette-set-bytes",
args);
gimp_value_array_unref (args);
success = GIMP_VALUES_GET_ENUM (return_vals, 0) == GIMP_PDB_SUCCESS;
gimp_value_array_unref (return_vals);
return success;
}
|
