The Gimp::Fu register( ) Method

The register( ) method takes a list of 12 parameters:

name

The name of this script, as it is to appear in the PDB. This name can be used by other plug-ins to call this script. If the name of the script does not begin with “perl_fu_”, “plug_in”, “extension_”, or “file_”, then “perl_fu_” is prepended to the provided name. To circumvent this behavior, prepend a single plus sign (+) to the name.

blurb

A short description of the script. This blurb appears in the user input window generated by Gimp::Fu. It is best to format all of your documentation in Perl’s POD format. The blurb argument defaults to =pod(NAME).

help

A longer description of the script. This blurb appears when the help button is selected within the user input window generated by Gimp::Fu. The help argument defaults to =pod(HELP).

author

Your name and some sort of contact information. The author argument defaults to =pod(AUTHOR).

copyright

The name of the script’s copyright holder. The copyright argument defaults to =pod(AUTHOR).

date

The last modified date, e.g., “2003-8-16”. The date argument defaults to =pod(DATE).

menu_path

A string describing the location of the script in the Gimp’s menu hierarchy, e.g., “<Image>/Filters/Misc/Foo Filter”. The string should begin with “<Image>” for the image menu structure, “<Toolbox>” for the toolbox menu structure, “<Save>” or “<Load>” if the script is a file format writer/reader, or “<None>” if the script should not have a menu entry.

image_types

A string listing ...

Get Perl Graphics Programming now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.