summaryrefslogtreecommitdiffstats
path: root/pdb/groups/channel.pdb
blob: a920ca870d7434051cbf37a8d7360ce6697d2ea6 (plain)
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
# GIMP - The GNU Image Manipulation Program
# Copyright (C) 1995 Spencer Kimball and Peter Mattis

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.

# This program 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 General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

# "Perlized" from C source by Manish Singh <yosh@gimp.org>

sub channel_new {
    $blurb = 'Create a new channel.';

    $help = <<'HELP';
This procedure creates a new channel with the specified width, height,
name, opacity and color.

The new channel still needs to be added to the image, as this is not
automatic. Add the new channel with gimp_image_insert_channel(). Other
attributes, such as channel visibility, should be set with explicit
procedure calls.

The channel's contents are undefined initially.
HELP

    &std_pdb_misc;

    @inargs = (
	{ name => 'image', type => 'image',
	  desc => 'The image to which to add the channel' },
	{ name => 'width', type => '1 <= int32 <= GIMP_MAX_IMAGE_SIZE',
	  desc => 'The channel width' },
	{ name => 'height', type => '1 <= int32 <= GIMP_MAX_IMAGE_SIZE',
	  desc => 'The channel height' },
	{ name => 'name', type => 'string',
	  desc => 'The channel name' },
	{ name => 'opacity', type => '0 <= float <= 100',
	  desc => 'The channel opacity' },
	{ name => 'color', type => 'color',
	  desc => 'The channel compositing color'
	}
    );

    @outargs = (
	{ name => 'channel', type => 'channel', wrap => 1,
	  desc => 'The newly created channel' }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpRGB rgb_color = color;

  rgb_color.a = opacity / 100.0;
  channel = gimp_channel_new (image, width, height, name, &rgb_color);

  if (! channel)
    success = FALSE;
}
CODE
    );
}

sub channel_copy {
    $blurb = 'Copy a channel.';

    $help = <<'HELP';
This procedure copies the specified channel and returns the copy.

The new channel still needs to be added to the image, as this is not
automatic. Add the new channel with gimp_image_insert_channel().
HELP

    &std_pdb_misc;

    @inargs = (
	{ name => 'channel', type => 'channel',
	  desc => 'The channel to copy' }
    );

    @outargs = (
	{ name => 'channel_copy', type => 'channel',
	  desc => 'The newly copied channel' }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpImage *image  = gimp_item_get_image (GIMP_ITEM (channel));
  gint       width  = gimp_image_get_width  (image);
  gint       height = gimp_image_get_height (image);

  if (gimp_item_get_width  (GIMP_ITEM (channel)) == width &&
      gimp_item_get_height (GIMP_ITEM (channel)) == height)
    {
      channel_copy = GIMP_CHANNEL (gimp_item_duplicate (GIMP_ITEM (channel),
                                                        GIMP_TYPE_CHANNEL));

      if (! channel_copy)
        success = FALSE;
    }
  else
    success = FALSE;
}
CODE
    );
}

sub channel_combine_masks {
    $blurb = 'Combine two channel masks.';

    $help = <<'HELP';
This procedure combines two channel masks.  The result is stored
in the first channel.
HELP

    &std_pdb_misc;

    @inargs = (
	{ name => 'channel1', type => 'channel',
	  desc => 'The channel1' },
	{ name => 'channel2', type => 'channel',
	  desc => 'The channel2' },
	{ name => 'operation', type => 'enum GimpChannelOps',
	  desc => 'The selection operation' },
	{ name => 'offx', type => 'int32',
	  desc => 'x offset between upper left corner of
                   channels: (second - first)' },
	{ name => 'offy', type => 'int32',
	  desc => 'y offset between upper left corner of
                   channels: (second - first)' }
    );

    %invoke = (
        headers => [ qw("core/gimpchannel-combine.h" "gimp-intl.h") ],
        code => <<'CODE'
{
  if (gimp_item_is_attached (GIMP_ITEM (channel1)))
    gimp_channel_push_undo (channel1, _("Combine Masks"));

  gimp_channel_combine_mask (channel1, channel2, operation, offx, offy);
}
CODE
    );
}

sub channel_new_from_component {
    $blurb = 'Create a new channel from a color component';

    $help = <<'HELP';
This procedure creates a new channel from a color component.

The new channel still needs to be added to the image, as this is not
automatic. Add the new channel with gimp_image_insert_channel(). Other
attributes, such as channel visibility, should be set with explicit
procedure calls.
HELP

    &shlomi_pdb_misc('2005', '2.4');

    @inargs = (
	{ name => 'image', type => 'image',
	  desc => 'The image to which to add the channel' },
	{ name => 'component', type => 'enum GimpChannelType',
	  desc => 'The image component' },
	{ name => 'name', type => 'string',
	  desc => 'The channel name' },
    );

    @outargs = (
	{ name => 'channel', type => 'channel',
	  desc => 'The newly created channel' }
    );

    %invoke = (
	code => <<'CODE'
{
  if (gimp_image_get_component_format (image, component) != NULL)
    channel = gimp_channel_new_from_component (image,
                                               component, name, NULL);

  if (channel)
    gimp_item_set_visible (GIMP_ITEM (channel), FALSE, FALSE);
  else
    success = FALSE;
}
CODE
    );
}

sub channel_get_show_masked {
    $blurb = "Get the composite method of the specified channel.";

    $help = <<'HELP';
This procedure returns the specified channel's composite method. If
it is TRUE, then the channel is composited with the image so that
masked regions are shown. Otherwise, selected regions are shown.
HELP

    &std_pdb_misc;

    @inargs = (
	{ name => 'channel', type => 'channel',
	  desc => 'The channel' }
    );

    @outargs = (
	{ name => 'show_masked', type => 'boolean',
	  desc => 'The channel composite method' }
    );

    %invoke = (
	code => <<'CODE'
{
  show_masked = gimp_channel_get_show_masked (channel);
}
CODE
    );
}

sub channel_set_show_masked {
    $blurb = "Set the composite method of the specified channel.";

    $help = <<'HELP';
This procedure sets the specified channel's composite method. If
it is TRUE, then the channel is composited with the image so that
masked regions are shown. Otherwise, selected regions are shown.
HELP

    &std_pdb_misc;

    @inargs = (
	{ name => 'channel', type => 'channel',
	  desc => 'The channel' },
	{ name => 'show_masked', type => 'boolean',
	  desc => 'The new channel composite method' }
    );

    %invoke = (
	code => <<'CODE'
{
  gimp_channel_set_show_masked (channel, show_masked);
}
CODE
    );
}

sub channel_get_opacity {
    $blurb = "Get the opacity of the specified channel.";

    $help = <<'HELP';
This procedure returns the specified channel's opacity.
HELP

    &std_pdb_misc;

    @inargs = (
	{ name => 'channel', type => 'channel',
	  desc => 'The channel' }
    );

    @outargs = (
	{ name => 'opacity', type => '0 <= float <= 100',
	  desc => 'The channel opacity' }
    );

    %invoke = (
	code => <<'CODE'
{
  opacity = gimp_channel_get_opacity (channel) * 100;
}
CODE
    );
}

sub channel_set_opacity {
    $blurb = "Set the opacity of the specified channel.";

    $help = <<'HELP';
This procedure sets the specified channel's opacity.
HELP

    &std_pdb_misc;

    @inargs = (
	{ name => 'channel', type => 'channel',
	  desc => 'The channel' },
	{ name => 'opacity', type => '0 <= float <= 100',
	  desc => 'The new channel opacity' }
    );

    %invoke = (
	code => <<'CODE'
{
  gimp_channel_set_opacity (channel, opacity / 100.0, TRUE);
}
CODE
    );
}

sub channel_get_color {
    $blurb = "Get the compositing color of the specified channel.";

    $help = <<'HELP';
This procedure returns the specified channel's compositing color.
HELP

    &std_pdb_misc;

    @inargs = (
	{ name => 'channel', type => 'channel',
	  desc => 'The channel' }
    );

    @outargs = (
	{ name => 'color', type => 'color', void_ret => 1,
	  desc => 'The channel compositing color' }
    );

    %invoke = (
	code => <<'CODE'
{
  gimp_channel_get_color (channel, &color);
  gimp_rgb_set_alpha (&color, 1.0);
}
CODE
    );
}

sub channel_set_color {
    $blurb = "Set the compositing color of the specified channel.";

    $help = <<'HELP';
This procedure sets the specified channel's compositing color.
HELP

    &std_pdb_misc;

    @inargs = (
	{ name => 'channel', type => 'channel',
	  desc => 'The channel' },
	{ name => 'color', type => 'color',
	  desc => 'The new channel compositing color' }
    );

    %invoke = (
	code => <<'CODE'
{
  GimpRGB rgb_color = color;

  rgb_color.a = channel->color.a;
  gimp_channel_set_color (channel, &rgb_color, TRUE);
}
CODE
    );
}


@headers = qw("libgimpbase/gimpbase.h");

@procs = qw(channel_new
            channel_new_from_component
            channel_copy
            channel_combine_masks
            channel_get_show_masked channel_set_show_masked
            channel_get_opacity channel_set_opacity
            channel_get_color channel_set_color);

%exports = (app => [@procs], lib => [@procs]);

$desc = 'Channel';
$doc_title = 'gimpchannel';
$doc_short_desc = 'Functions for manipulating channels.';
$doc_long_desc = 'Functions for manipulating channels.';

1;