gimpselection_pdb.c 17 KB
Newer Older
1
/* LIBGIMP - The GIMP Library
2
 * Copyright (C) 1995-2003 Peter Mattis and Spencer Kimball
3 4
 *
 * gimpselection_pdb.c
5 6
 *
 * This library is free software; you can redistribute it and/or
Marc Lehmann's avatar
Marc Lehmann committed
7
 * modify it under the terms of the GNU Lesser General Public
8 9 10
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
11
 * This library is distributed in the hope that it will be useful,
12 13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14
 * Lesser General Public License for more details.
15
 *
Marc Lehmann's avatar
Marc Lehmann committed
16
 * You should have received a copy of the GNU Lesser General Public
17 18 19 20 21
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

22
/* NOTE: This file is auto-generated by pdbgen.pl */
23

Sven Neumann's avatar
Sven Neumann committed
24 25
#include "config.h"

26
#include "gimp.h"
27

28 29 30
/**
 * gimp_selection_bounds:
 * @image_ID: The image.
31
 * @non_empty: TRUE if there is a selection.
32 33 34 35 36 37 38 39 40 41
 * @x1: x coordinate of upper left corner of selection bounds.
 * @y1: y coordinate of upper left corner of selection bounds.
 * @x2: x coordinate of lower right corner of selection bounds.
 * @y2: y coordinate of lower right corner of selection bounds.
 *
 * Find the bounding box of the current selection.
 *
 * This procedure returns whether there is a selection for the
 * specified image. If there is one, the upper left and lower right
 * corners of the bounding box are returned. These coordinates are
42 43 44 45 46
 * relative to the image. Please note that the pixel specified by the
 * lower righthand coordinate of the bounding box is not part of the
 * selection. The selection ends at the upper left corner of this
 * pixel. This means the width of the selection can be calculated as
 * (x2 - x1), its height as (y2 - y1).
47 48 49
 *
 * Returns: TRUE on success.
 */
50
gboolean
51
gimp_selection_bounds (gint32    image_ID,
52 53 54 55 56
                       gboolean *non_empty,
                       gint     *x1,
                       gint     *y1,
                       gint     *x2,
                       gint     *y2)
57
{
58
  GimpParam *return_vals;
59
  gint nreturn_vals;
60
  gboolean success = TRUE;
61

62
  return_vals = gimp_run_procedure ("gimp-selection-bounds",
63 64 65
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_END);
66

67 68 69 70 71 72
  *non_empty = FALSE;
  *x1 = 0;
  *y1 = 0;
  *x2 = 0;
  *y2 = 0;

73 74 75
  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  if (success)
76
    {
77
      *non_empty = return_vals[1].data.d_int32;
78 79 80 81 82
      *x1 = return_vals[2].data.d_int32;
      *y1 = return_vals[3].data.d_int32;
      *x2 = return_vals[4].data.d_int32;
      *y2 = return_vals[5].data.d_int32;
    }
83

84
  gimp_destroy_params (return_vals, nreturn_vals);
85 86

  return success;
87 88
}

89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
/**
 * gimp_selection_value:
 * @image_ID: The image.
 * @x: x coordinate of value.
 * @y: y coordinate of value.
 *
 * Find the value of the selection at the specified coordinates.
 *
 * This procedure returns the value of the selection at the specified
 * coordinates. If the coordinates lie out of bounds, 0 is returned.
 *
 * Returns: Value of the selection.
 */
gint
gimp_selection_value (gint32 image_ID,
104 105
                      gint   x,
                      gint   y)
106 107 108 109 110
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gint value = 0;

111
  return_vals = gimp_run_procedure ("gimp-selection-value",
112 113 114 115 116
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_INT32, x,
                                    GIMP_PDB_INT32, y,
                                    GIMP_PDB_END);
117 118 119 120 121 122 123 124 125

  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
    value = return_vals[1].data.d_int32;

  gimp_destroy_params (return_vals, nreturn_vals);

  return value;
}

126 127 128 129 130 131
/**
 * gimp_selection_is_empty:
 * @image_ID: The image.
 *
 * Determine whether the selection is empty.
 *
132
 * This procedure returns TRUE if the selection for the specified image
133
 * is empty.
134 135 136
 *
 * Returns: Is the selection empty?
 */
137 138
gboolean
gimp_selection_is_empty (gint32 image_ID)
139
{
140
  GimpParam *return_vals;
141
  gint nreturn_vals;
142
  gboolean is_empty = FALSE;
143

144
  return_vals = gimp_run_procedure ("gimp-selection-is-empty",
145 146 147
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_END);
148

149
  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
150
    is_empty = return_vals[1].data.d_int32;
151 152 153

  gimp_destroy_params (return_vals, nreturn_vals);

154
  return is_empty;
155
}
156

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
/**
 * gimp_selection_translate:
 * @image_ID: The image.
 * @offx: x offset for translation.
 * @offy: y offset for translation.
 *
 * Translate the selection by the specified offsets.
 *
 * This procedure actually translates the selection for the specified
 * image by the specified offsets. Regions that are translated from
 * beyond the bounds of the image are set to empty. Valid regions of
 * the selection which are translated beyond the bounds of the image
 * because of this call are lost.
 *
 * Returns: TRUE on success.
 */
gboolean
gimp_selection_translate (gint32 image_ID,
175 176
                          gint   offx,
                          gint   offy)
177 178 179 180 181
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

182
  return_vals = gimp_run_procedure ("gimp-selection-translate",
183 184 185 186 187
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_INT32, offx,
                                    GIMP_PDB_INT32, offy,
                                    GIMP_PDB_END);
188 189 190 191 192 193 194 195

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
/**
 * _gimp_selection_float:
 * @drawable_ID: The drawable from which to float selection.
 * @offx: x offset for translation.
 * @offy: y offset for translation.
 *
 * Float the selection from the specified drawable with initial offsets
 * as specified.
 *
 * This procedure determines the region of the specified drawable that
 * lies beneath the current selection. The region is then cut from the
 * drawable and the resulting data is made into a new layer which is
 * instantiated as a floating selection. The offsets allow initial
 * positioning of the new floating selection.
 *
 * Returns: The floated layer.
 */
213 214
gint32
_gimp_selection_float (gint32 drawable_ID,
215 216
                       gint   offx,
                       gint   offy)
217
{
218
  GimpParam *return_vals;
219
  gint nreturn_vals;
220 221
  gint32 layer_ID = -1;

222
  return_vals = gimp_run_procedure ("gimp-selection-float",
223 224 225 226 227
                                    &nreturn_vals,
                                    GIMP_PDB_DRAWABLE, drawable_ID,
                                    GIMP_PDB_INT32, offx,
                                    GIMP_PDB_INT32, offy,
                                    GIMP_PDB_END);
228

229
  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
230
    layer_ID = return_vals[1].data.d_layer;
231 232 233

  gimp_destroy_params (return_vals, nreturn_vals);

234
  return layer_ID;
235 236
}

237 238 239 240 241 242 243
/**
 * gimp_selection_invert:
 * @image_ID: The image.
 *
 * Invert the selection mask.
 *
 * This procedure inverts the selection mask. For every pixel in the
244
 * selection channel, its new value is calculated as (255 - old-value).
245 246 247 248 249 250 251 252 253 254
 *
 * Returns: TRUE on success.
 */
gboolean
gimp_selection_invert (gint32 image_ID)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

255
  return_vals = gimp_run_procedure ("gimp-selection-invert",
256 257 258
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_END);
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

/**
 * gimp_selection_sharpen:
 * @image_ID: The image.
 *
 * Sharpen the selection mask.
 *
 * This procedure sharpens the selection mask. For every pixel in the
274 275 276
 * selection channel, if the value is > 127, the new pixel is
 * assigned a value of 255. This removes any \"anti-aliasing\" that
 * might exist in the selection mask's boundary.
277 278 279 280 281 282 283 284 285 286
 *
 * Returns: TRUE on success.
 */
gboolean
gimp_selection_sharpen (gint32 image_ID)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

287
  return_vals = gimp_run_procedure ("gimp-selection-sharpen",
288 289 290
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_END);
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

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

/**
 * gimp_selection_all:
 * @image_ID: The image.
 *
 * Select all of the image.
 *
 * This procedure sets the selection mask to completely encompass the
 * image. Every pixel in the selection channel is set to 255.
 *
 * Returns: TRUE on success.
 */
gboolean
gimp_selection_all (gint32 image_ID)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

317
  return_vals = gimp_run_procedure ("gimp-selection-all",
318 319 320
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_END);
321 322 323 324 325 326 327 328

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

329 330 331 332 333 334 335 336 337 338 339
/**
 * gimp_selection_none:
 * @image_ID: The image.
 *
 * Deselect the entire image.
 *
 * This procedure deselects the entire image. Every pixel in the
 * selection channel is set to 0.
 *
 * Returns: TRUE on success.
 */
340
gboolean
341 342
gimp_selection_none (gint32 image_ID)
{
343
  GimpParam *return_vals;
344
  gint nreturn_vals;
345
  gboolean success = TRUE;
346

347
  return_vals = gimp_run_procedure ("gimp-selection-none",
348 349 350
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_END);
351

352 353
  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

354
  gimp_destroy_params (return_vals, nreturn_vals);
355 356

  return success;
357
}
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372

/**
 * gimp_selection_feather:
 * @image_ID: The image.
 * @radius: Radius of feather (in pixels).
 *
 * Feather the image's selection
 *
 * This procedure feathers the selection. Feathering is implemented
 * using a gaussian blur.
 *
 * Returns: TRUE on success.
 */
gboolean
gimp_selection_feather (gint32  image_ID,
373
                        gdouble radius)
374 375 376 377 378
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

379
  return_vals = gimp_run_procedure ("gimp-selection-feather",
380 381 382 383
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_FLOAT, radius,
                                    GIMP_PDB_END);
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

/**
 * gimp_selection_border:
 * @image_ID: The image.
 * @radius: Radius of border (in pixels).
 *
 * Border the image's selection
 *
 * This procedure borders the selection. Bordering creates a new
 * selection which is defined along the boundary of the previous
 * selection at every point within the specified radius.
 *
 * Returns: TRUE on success.
 */
gboolean
gimp_selection_border (gint32 image_ID,
407
                       gint   radius)
408 409 410 411 412
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

413
  return_vals = gimp_run_procedure ("gimp-selection-border",
414 415 416 417
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_INT32, radius,
                                    GIMP_PDB_END);
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

/**
 * gimp_selection_grow:
 * @image_ID: The image.
 * @steps: Steps of grow (in pixels).
 *
 * Grow the image's selection
 *
 * This procedure grows the selection. Growing involves expanding the
 * boundary in all directions by the specified pixel amount.
 *
 * Returns: TRUE on success.
 */
gboolean
gimp_selection_grow (gint32 image_ID,
440
                     gint   steps)
441 442 443 444 445
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

446
  return_vals = gimp_run_procedure ("gimp-selection-grow",
447 448 449 450
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_INT32, steps,
                                    GIMP_PDB_END);
451 452 453 454 455 456 457 458 459 460 461

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

/**
 * gimp_selection_shrink:
 * @image_ID: The image.
462
 * @steps: Steps of shrink (in pixels).
463 464 465 466 467 468 469 470 471 472 473
 *
 * Shrink the image's selection
 *
 * This procedure shrinks the selection. Shrinking invovles trimming
 * the existing selection boundary on all sides by the specified number
 * of pixels.
 *
 * Returns: TRUE on success.
 */
gboolean
gimp_selection_shrink (gint32 image_ID,
474
                       gint   steps)
475 476 477 478 479
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

480
  return_vals = gimp_run_procedure ("gimp-selection-shrink",
481 482 483 484
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_INT32, steps,
                                    GIMP_PDB_END);
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

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

/**
 * gimp_selection_layer_alpha:
 * @layer_ID: Layer with alpha.
 *
 * Transfer the specified layer's alpha channel to the selection mask.
 *
 * This procedure requires a layer with an alpha channel. The alpha
 * channel information is used to create a selection mask such that for
 * any pixel in the image defined in the specified layer, that layer
 * pixel's alpha value is transferred to the selection mask. If the
 * layer is undefined at a particular image pixel, the associated
 * selection mask value is set to 0.
 *
 * Returns: TRUE on success.
 */
gboolean
gimp_selection_layer_alpha (gint32 layer_ID)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

515
  return_vals = gimp_run_procedure ("gimp-selection-layer-alpha",
516 517 518
                                    &nreturn_vals,
                                    GIMP_PDB_LAYER, layer_ID,
                                    GIMP_PDB_END);
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

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

/**
 * gimp_selection_load:
 * @channel_ID: The channel.
 *
 * Transfer the specified channel to the selection mask.
 *
 * This procedure loads the specified channel into the selection mask.
 *
 * Returns: TRUE on success.
 */
gboolean
gimp_selection_load (gint32 channel_ID)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

544
  return_vals = gimp_run_procedure ("gimp-selection-load",
545 546 547
                                    &nreturn_vals,
                                    GIMP_PDB_CHANNEL, channel_ID,
                                    GIMP_PDB_END);
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

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

/**
 * gimp_selection_save:
 * @image_ID: The image.
 *
 * Copy the selection mask to a new channel.
 *
 * This procedure copies the selection mask and stores the content in a
 * new channel. The new channel is automatically inserted into the
 * image's list of channels.
 *
 * Returns: The new channel.
 */
gint32
gimp_selection_save (gint32 image_ID)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gint32 channel_ID = -1;

575
  return_vals = gimp_run_procedure ("gimp-selection-save",
576 577 578
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_END);
579 580 581 582 583 584 585 586

  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
    channel_ID = return_vals[1].data.d_channel;

  gimp_destroy_params (return_vals, nreturn_vals);

  return channel_ID;
}
587 588 589 590 591 592 593 594 595

/**
 * gimp_selection_combine:
 * @channel_ID: The channel.
 * @operation: The selection operation.
 *
 * Combines the specified channel with the selection mask.
 *
 * This procedure combines the specified channel into the selection
596
 * mask.
597 598 599 600 601
 *
 * Returns: TRUE on success.
 */
gboolean
gimp_selection_combine (gint32         channel_ID,
602
                        GimpChannelOps operation)
603 604 605 606 607
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

608
  return_vals = gimp_run_procedure ("gimp-selection-combine",
609 610 611 612
                                    &nreturn_vals,
                                    GIMP_PDB_CHANNEL, channel_ID,
                                    GIMP_PDB_INT32, operation,
                                    GIMP_PDB_END);
613 614 615 616 617 618 619

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}