summaryrefslogtreecommitdiffstats
path: root/pdb/groups/buffer.pdb
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--pdb/groups/buffer.pdb260
1 files changed, 260 insertions, 0 deletions
diff --git a/pdb/groups/buffer.pdb b/pdb/groups/buffer.pdb
new file mode 100644
index 0000000..faf78c4
--- /dev/null
+++ b/pdb/groups/buffer.pdb
@@ -0,0 +1,260 @@
+# 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 buffers_get_list {
+ $blurb = 'Retrieve a complete listing of the available buffers.';
+
+ $help = <<'HELP';
+This procedure returns a complete listing of available named buffers.
+HELP
+
+ &mitch_pdb_misc('2005', '2.4');
+
+ @inargs = (
+ { name => 'filter', type => 'string', null_ok => 1,
+ desc => 'An optional regular expression used to filter the list' }
+ );
+
+ @outargs = (
+ { name => 'buffer_list', type => 'stringarray',
+ desc => 'The list of buffer names',
+ array => { name => 'num_buffers',
+ desc => 'The number of buffers' } }
+ );
+
+ %invoke = (
+ code => <<'CODE'
+{
+ buffer_list = gimp_container_get_filtered_name_array (gimp->named_buffers,
+ filter, &num_buffers);
+}
+CODE
+ );
+}
+
+sub buffer_rename {
+ $blurb = 'Renames a named buffer.';
+ $help = 'This procedure renames a named buffer.';
+
+ &mitch_pdb_misc('2005', '2.4');
+
+ @inargs = (
+ { name => 'buffer_name', type => 'string', non_empty => 1,
+ desc => 'The buffer name' },
+ { name => 'new_name', type => 'string', non_empty => 1,
+ desc => 'The buffer\'s new name' }
+ );
+
+ @outargs = (
+ { name => 'real_name', type => 'string',
+ desc => 'The real name given to the buffer' }
+ );
+
+ %invoke = (
+ code => <<'CODE'
+{
+ GimpBuffer *buffer = gimp_pdb_get_buffer (gimp, buffer_name, error);
+
+ if (buffer)
+ {
+ gimp_object_set_name (GIMP_OBJECT (buffer), new_name);
+ real_name = g_strdup (gimp_object_get_name (buffer));
+ }
+ else
+ success = FALSE;
+}
+CODE
+ );
+}
+
+sub buffer_delete {
+ $blurb = 'Deletes a named buffer.';
+ $help = 'This procedure deletes a named buffer.';
+
+ $author = $copyright = 'David Gowers <neota@softhome.net>';
+ $date = '2005';
+ $since = '2.4';
+
+ @inargs = (
+ { name => 'buffer_name', type => 'string', non_empty => 1,
+ desc => 'The buffer name' }
+ );
+
+ %invoke = (
+ code => <<'CODE'
+{
+ GimpBuffer *buffer = gimp_pdb_get_buffer (gimp, buffer_name, error);
+
+ if (buffer)
+ success = gimp_container_remove (gimp->named_buffers, GIMP_OBJECT (buffer));
+ else
+ success = FALSE;
+}
+CODE
+ );
+}
+
+sub buffer_get_width {
+ $blurb = "Retrieves the specified buffer's width.";
+ $help = "This procedure retrieves the specified named buffer's width.";
+
+ &mitch_pdb_misc('2005', '2.4');
+
+ @inargs = (
+ { name => 'buffer_name', type => 'string', non_empty => 1,
+ desc => 'The buffer name' }
+ );
+
+ @outargs = (
+ { name => 'width', type => 'int32',
+ desc => "The buffer width" }
+ );
+
+ %invoke = (
+ code => <<'CODE'
+{
+ GimpBuffer *buffer = gimp_pdb_get_buffer (gimp, buffer_name, error);
+
+ if (buffer)
+ width = gimp_buffer_get_width (buffer);
+ else
+ success = FALSE;
+}
+CODE
+ );
+}
+
+sub buffer_get_height {
+ $blurb = "Retrieves the specified buffer's height.";
+ $help = "This procedure retrieves the specified named buffer's height.";
+
+ &mitch_pdb_misc('2005', '2.4');
+
+ @inargs = (
+ { name => 'buffer_name', type => 'string', non_empty => 1,
+ desc => 'The buffer name' }
+ );
+
+ @outargs = (
+ { name => 'height', type => 'int32',
+ desc => "The buffer height" }
+ );
+
+ %invoke = (
+ code => <<'CODE'
+{
+ GimpBuffer *buffer = gimp_pdb_get_buffer (gimp, buffer_name, error);
+
+ if (buffer)
+ height = gimp_buffer_get_height (buffer);
+ else
+ success = FALSE;
+}
+CODE
+ );
+}
+
+sub buffer_get_bytes {
+ $blurb = "Retrieves the specified buffer's bytes.";
+ $help = "This procedure retrieves the specified named buffer's bytes.";
+
+ &mitch_pdb_misc('2005', '2.4');
+
+ @inargs = (
+ { name => 'buffer_name', type => 'string', non_empty => 1,
+ desc => 'The buffer name' }
+ );
+
+ @outargs = (
+ { name => 'bytes', type => 'int32',
+ desc => "The buffer bpp" }
+ );
+
+ %invoke = (
+ code => <<'CODE'
+{
+ GimpBuffer *buffer = gimp_pdb_get_buffer (gimp, buffer_name, error);
+
+ if (buffer)
+ {
+ const Babl *format = gimp_buffer_get_format (buffer);
+
+ bytes = babl_format_get_bytes_per_pixel (format);
+ }
+ else
+ success = FALSE;
+}
+CODE
+ );
+}
+
+sub buffer_get_image_type {
+ $blurb = "Retrieves the specified buffer's image type.";
+ $help = "This procedure retrieves the specified named buffer's image type.";
+
+ &mitch_pdb_misc('2005', '2.4');
+
+ @inargs = (
+ { name => 'buffer_name', type => 'string', non_empty => 1,
+ desc => 'The buffer name' }
+ );
+
+ @outargs = (
+ { name => 'image_type', type => 'enum GimpImageBaseType',
+ desc => "The buffer image type" }
+ );
+
+ %invoke = (
+ code => <<'CODE'
+{
+ GimpBuffer *buffer = gimp_pdb_get_buffer (gimp, buffer_name, error);
+
+ if (buffer)
+ image_type = gimp_babl_format_get_image_type (gimp_buffer_get_format (buffer));
+ else
+ success = FALSE;
+}
+CODE
+ );
+}
+
+
+@headers = qw(<string.h>
+ "gegl/gimp-babl-compat.h"
+ "core/gimp.h"
+ "core/gimpbuffer.h"
+ "core/gimpcontainer.h"
+ "core/gimpcontainer-filter.h"
+ "gimppdb-utils.h");
+
+@procs = qw(buffers_get_list
+ buffer_rename
+ buffer_delete
+ buffer_get_width
+ buffer_get_height
+ buffer_get_bytes
+ buffer_get_image_type);
+
+%exports = (app => [@procs], lib => [@procs]);
+
+$desc = 'Buffer procedures';
+$doc_title = 'gimpbuffer';
+$doc_short_desc = 'Functions for manipulating cut buffers.';
+$doc_long_desc = 'Functions related to named cut buffers.';
+
+1;