gimp/pdb/groups/pattern.pdb

# 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>

# The invoke code is compiled on the app side.
# The invoke code must assign to each result var


$pattern_arg_spec = { name => 'pattern', type => 'pattern', non_empty => 1,
  desc => 'The pattern' };


sub pattern_get_info {
    $blurb = 'Gets information about the pattern.';

    $help = <<'HELP';
Gets information about the pattern:
the pattern extents (width and height) and bytes per pixel.
HELP

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

    @inargs = (
      ${pattern_arg_spec}
    );

    @outargs = (
      { name => 'width', type => 'int32', void_ret => 1,
        desc => "The pattern width" },
      { name => 'height', type => 'int32',
        desc => "The pattern height" },
      { name => 'bpp', type => 'int32',
        desc => "The pattern bpp" }
    );

    %invoke = (
	code => <<'CODE'
{
  const Babl *format;

  format = gimp_babl_compat_u8_format (
    gimp_temp_buf_get_format (pattern->mask));

  width  = gimp_temp_buf_get_width  (pattern->mask);
  height = gimp_temp_buf_get_height (pattern->mask);
  bpp    = babl_format_get_bytes_per_pixel (format);
}
CODE
    );
}

sub pattern_get_pixels {
    $blurb = <<'BLURB';
Gets information about the pattern (including pixels).
BLURB

    $help = <<'HELP';
Gets information about the pattern:
the pattern extents (width and height), its bpp, and its pixel data.
The pixel data is an array in C or a list in some languages.
HELP

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

    @inargs = (
      ${pattern_arg_spec}
    );

    @outargs = (
      { name => 'width', type => 'int32', void_ret => 1,
        desc => "The pattern width" },
      { name => 'height', type => 'int32',
        desc => "The pattern height" },
      { name => 'bpp', type => 'int32',
        desc => "The pattern bpp" },
      { name => 'color_bytes', type => 'int8array',
        desc => 'The pattern data.',
        array => { desc => 'Number of pattern bytes' } }
    );

    %invoke = (
	code => <<'CODE'
{

  const Babl *format;
  gpointer    data;

  format = gimp_babl_compat_u8_format (
    gimp_temp_buf_get_format (pattern->mask));
  data   = gimp_temp_buf_lock (pattern->mask, format, GEGL_ACCESS_READ);

  width           = gimp_temp_buf_get_width  (pattern->mask);
  height          = gimp_temp_buf_get_height (pattern->mask);
  bpp             = babl_format_get_bytes_per_pixel (format);
  num_color_bytes = gimp_temp_buf_get_data_size (pattern->mask);
  color_bytes     = g_memdup2 (data, num_color_bytes);

  gimp_temp_buf_unlock (pattern->mask, data);
}
CODE
    );
}

sub pattern_id_is_valid {
    $blurb = "Whether the ID is a valid reference to installed data.";
    $help  = "Returns TRUE if this ID is valid.";

    &bootchk_pdb_misc('2022', '3.0');

    @inargs = (
      { name => 'id',
        type => 'string',
        non_empty => 1,
        no_validate => 1,
        desc => 'The pattern ID' }
    );

    @outargs = (
      { name => 'valid', type => 'boolean',
        desc => 'TRUE if the pattern ID is valid' }
    );

    %invoke = (
        code => <<'CODE'
{
  /* !!! pattern has one fewer args than other resources. */
  valid = (gimp_pdb_get_pattern (gimp, id, error) != NULL);

  /* When ID is not valid, NULL is returned and error is set.
   * Clear error so GIMP not display error dialog.
   */
  g_clear_error (error);
}
CODE
    );
}


@headers = qw(<string.h>
              "gegl/gimp-babl-compat.h"
              "core/gimpcontext.h"
              "core/gimpdatafactory.h"
              "core/gimppattern.h"
              "core/gimptempbuf.h"
              "gimppdb-utils.h");

@procs = qw(pattern_get_info
            pattern_get_pixels
            pattern_id_is_valid);

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

$desc = 'Pattern';
$doc_title = 'gimppattern';
$doc_short_desc = 'Installable object used by fill and clone tools.';
$doc_long_desc =  'Installable object used by fill and clone tools.';

1;