summaryrefslogtreecommitdiffstats
path: root/pdb/groups/image_transform.pdb
blob: 81845a36aa3678e6c0d599b89f69756e8097c1c9 (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
# 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 image_resize {
    $blurb = 'Resize the image to the specified extents.';

    $help = <<'HELP';
This procedure resizes the image so that it's new width and height are
equal to the supplied parameters. Offsets are also provided which
describe the position of the previous image's content. All channels
within the image are resized according to the specified parameters;
this includes the image selection mask. All layers within the image
are repositioned according to the specified offsets.
HELP

    &std_pdb_misc;

    @inargs = (
        { name => 'image', type => 'image',
          desc => 'The image' },
        { name => 'new_width', type => '1 <= int32 <= GIMP_MAX_IMAGE_SIZE',
          desc => 'New image width' },
        { name => 'new_height', type => '1 <= int32 <= GIMP_MAX_IMAGE_SIZE',
          desc => 'New image height' },
        { name => 'offx', type => 'int32',
          desc => 'x offset between upper left corner of old and
                   new images: (new - old)' },
        { name => 'offy', type => 'int32',
          desc => 'y offset between upper left corner of old and
                   new images: (new - old)' }
    );

    %invoke = (
        headers => [ qw("core/gimpimage-resize.h") ],
        code => <<'CODE'
{
  gimp_image_resize (image, context,
                     new_width, new_height, offx, offy, NULL);
}
CODE
    );
}

sub image_resize_to_layers {
    $blurb = 'Resize the image to fit all layers.';

    $help = <<'HELP';
This procedure resizes the image to the bounding box of all layers of
the image. All channels within the image are resized to the new size;
this includes the image selection mask. All layers within the image
are repositioned to the new image area.
HELP

    &simon_pdb_misc('2004', '2.2');

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

    %invoke = (
        headers => [ qw("core/gimpimage-resize.h") ],
        code => <<'CODE'
{
  gimp_image_resize_to_layers (image, context, NULL, NULL, NULL, NULL, NULL);
}
CODE
    );
}

sub image_scale {
    $blurb = 'Scale the image using the default interpolation method.';

    $help = <<'HELP';

This procedure scales the image so that its new width and height are
equal to the supplied parameters. All layers and channels within the
image are scaled according to the specified parameters; this includes
the image selection mask. The interpolation method used can be set
with gimp_context_set_interpolation().
HELP

    &std_pdb_misc;

    @inargs = (
        { name => 'image', type => 'image',
          desc => 'The image' },
        { name => 'new_width', type => '1 <= int32 <= GIMP_MAX_IMAGE_SIZE',
          desc => 'New image width' },
        { name => 'new_height', type => '1 <= int32 <= GIMP_MAX_IMAGE_SIZE',
          desc => 'New image height' }
    );

    %invoke = (
        headers => [ qw("core/gimpimage-scale.h") ],
        code => <<'CODE'
{
  GimpPDBContext *pdb_context = GIMP_PDB_CONTEXT (context);

  if (progress)
    gimp_progress_start (progress, FALSE, _("Scaling"));

  gimp_image_scale (image, new_width, new_height,
                    pdb_context->interpolation,
                    progress);

  if (progress)
    gimp_progress_end (progress);
}
CODE
    );
}

sub image_scale_full {
    &std_pdb_deprecated('gimp-image-scale');
    &neo_pdb_misc('2008', '2.6');

    @inargs = (
        { name => 'image', type => 'image',
          desc => 'The image' },
        { name => 'new_width', type => '1 <= int32 <= GIMP_MAX_IMAGE_SIZE',
          desc => 'New image width' },
        { name => 'new_height', type => '1 <= int32 <= GIMP_MAX_IMAGE_SIZE',
          desc => 'New image height' },
        { name => 'interpolation', type => 'enum GimpInterpolationType',
          desc => 'Type of interpolation' }
    );

    %invoke = (
        headers => [ qw("core/gimpimage-scale.h") ],
        code => <<'CODE'
{
  if (progress)
    gimp_progress_start (progress, FALSE, _("Scaling"));

  gimp_image_scale (image, new_width, new_height, interpolation, progress);

  if (progress)
    gimp_progress_end (progress);
}
CODE
    );
}

sub image_crop {
    $blurb = 'Crop the image to the specified extents.';

    $help = <<'HELP';
This procedure crops the image so that it's new width and height are
equal to the supplied parameters. Offsets are also provided which
describe the position of the previous image's content. All channels
and layers within the image are cropped to the new image extents; this
includes the image selection mask. If any parameters are out of range,
an error is returned.
HELP

    &std_pdb_misc;

    @inargs = (
        { name => 'image', type => 'image',
          desc => 'The image' },
        { name => 'new_width', type => '1 <= int32 <= GIMP_MAX_IMAGE_SIZE',
          desc => 'New image width: (0 < new_width <= width)' },
        { name => 'new_height', type => '1 <= int32 <= GIMP_MAX_IMAGE_SIZE',
          desc => 'New image height: (0 < new_height <= height)' },
        { name => 'offx', type => '0 <= int32',
          desc => 'X offset: (0 <= offx <= (width - new_width))' },
        { name => 'offy', type => '0 <= int32',
          desc => 'Y offset: (0 <= offy <= (height - new_height))' }
    );

    %invoke = (
        headers => [ qw("core/gimpimage-crop.h") ],
        code => <<'CODE'
{
  if (new_width  >  gimp_image_get_width  (image)              ||
      new_height >  gimp_image_get_height (image)              ||
      offx       > (gimp_image_get_width  (image) - new_width) ||
      offy       > (gimp_image_get_height (image) - new_height))
    success = FALSE;
  else
    gimp_image_crop (image, context, GIMP_FILL_TRANSPARENT,
                     offx, offy, new_width, new_height,
                     TRUE);
}
CODE
    );
}

sub image_flip {
    $blurb = 'Flips the image horizontally or vertically.';

    $help = <<'HELP';
This procedure flips (mirrors) the image.
HELP

    &std_pdb_misc;

    @inargs = (
        { name => 'image', type => 'image',
          desc => 'The image' },
        { name => 'flip_type',
          type => 'enum GimpOrientationType (no GIMP_ORIENTATION_UNKNOWN)',
          desc => 'Type of flip' }
    );

    %invoke = (
        headers => [ qw("core/gimpimage-flip.h") ],
        code => <<'CODE'
{
  gimp_image_flip (image, context, flip_type, NULL);
}
CODE
    );
}

sub image_rotate {
    $blurb = 'Rotates the image by the specified degrees.';
    $help = 'This procedure rotates the image.';

    &mitch_pdb_misc('2003');

    @inargs = (
        { name => 'image', type => 'image',
          desc => 'The image' },
        { name => 'rotate_type', type => 'enum GimpRotationType',
          desc => 'Angle of rotation' }
    );

    %invoke = (
        headers => [ qw("core/gimpimage-rotate.h") ],
        code => <<'CODE'
{
  if (progress)
    gimp_progress_start (progress, FALSE, _("Rotating"));

  gimp_image_rotate (image, context, rotate_type, progress);

  if (progress)
    gimp_progress_end (progress);
}
CODE
    );
}

@headers = qw("core/gimpprogress.h"
              "gimppdbcontext.h"
              "gimp-intl.h");

@procs = qw(image_resize image_resize_to_layers
            image_scale image_scale_full
            image_crop image_flip image_rotate);

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

$desc = 'Image Transform';
$doc_title = 'gimpimagetransform';
$doc_short_desc = 'Transformations on images.';
$doc_long_desc = 'Operations to scale, resize, crop, flip and rotate images.';

1;