GimpImageProcedure

GimpImageProcedure

Functions

Object Hierarchy

    GObject
    ╰── GimpProcedure
        ╰── GimpImageProcedure

Description

Functions

GimpRunImageFunc ()

GimpValueArray *
(*GimpRunImageFunc) (GimpProcedure *procedure,
                     GimpRunMode run_mode,
                     GimpImage *image,
                     gint n_drawables,
                     GimpDrawable **drawables,
                     const GimpValueArray *args,
                     gpointer run_data);

The image function is run during the lifetime of the GIMP session, each time a plug-in image procedure is called.

Parameters

procedure

the GimpProcedure that runs.

 

run_mode

the GimpRunMode.

 

image

the GimpImage.

 

n_drawables

the number of GimpDrawable-s.

 

drawables

the input GimpDrawable-s.

[array length=n_drawables]

args

the procedure 's remaining arguments.

 

run_data

the run_data given in gimp_image_procedure_new().

[closure]

Returns

the procedure 's return values.

[transfer full]

Since: 3.0


gimp_image_procedure_new ()

GimpProcedure *
gimp_image_procedure_new (GimpPlugIn *plug_in,
                          const gchar *name,
                          GimpPDBProcType proc_type,
                          GimpRunImageFunc run_func,
                          gpointer run_data,
                          GDestroyNotify run_data_destroy);

Creates a new image procedure named name which will call run_func when invoked.

See gimp_procedure_new() for information about proc_type .

GimpImageProcedure is a GimpProcedure subclass that makes it easier to write standard plug-in procedures that operate on drawables.

It automatically adds the standard

(GimpRunMode, GimpImage, GimpDrawable)

arguments of an image procedure. It is possible to add additional arguments.

When invoked via gimp_procedure_run(), it unpacks these standard arguments and calls run_func which is a GimpRunImageFunc. The "args" GimpValueArray of GimpRunImageFunc only contains additionally added arguments.

Parameters

plug_in

a GimpPlugIn.

 

name

the new procedure's name.

 

proc_type

the new procedure's GimpPDBProcType.

 

run_func

the run function for the new procedure.

 

run_data

user data passed to run_func .

 

run_data_destroy

free function for run_data , or NULL.

[nullable]

Returns

a new GimpProcedure.

Since: 3.0