Batch procedures implement an interpreter able to run commands as input.

Installable object used by painting and stroking tools.

Functions for manipulating channels.

Color management settings.

Definitions and Functions relating to LCMS.

Definitions and Functions relating to LCMS.

Functions to create, delete and flush displays (views) on an image.

Functions to manipulate drawables.

Operations on drawable filters: creation, editing.

The base class for GimpDrawableFilter specific config objects.

since: 3.0

A class holding generic export options.

Export procedures implement image export.

File procedures implement file support. They cannot be created directly. Instead, you will create an instance of one of the sublasses (such as export or load procedures). This provides a common interface for file-related functions on these objects.

Installable object used by text tools.

Installable object used by the gradient rendering tool.

Operations on a group layer.

Operations on complete images: creation, resizing/rescaling, and operations involving multiple layers.

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

Functions to manipulate items.

Operations on a single layer.

A GimpProcedure subclass that makes it easier to write file load procedures.

Functions to (de)serialize a given memory size.

Basic functions for handling GimpMetadata objects.

GimpModule is a generic mechanism to dynamically load modules into GIMP. It is a GTypeModule subclass, implementing module loading using GModule. GimpModule does not know which functionality is implemented by the modules, it just provides a framework to get arbitrary GType implementations loaded from disk.

Keeps a list of GimpModule‘s found in a given searchpath.

Installable object, a small set of colors a user can choose from.

Functions for querying and manipulating path.

Installable object used by fill and clone tools.

Provides access to the Procedural DataBase (PDB).

The base class for plug-ins to derive from.

since: 3.0

Procedures are registered functions which can be run across GIMP ecosystem. They can be created by plug-ins and can then run by the core application when called from menus (or through other interaction depending on specific procedure subclasses).

The base class for GimpProcedure specific config objects and the main interface to manage aspects of GimpProcedure‘s arguments such as persistency of the last used arguments across GIMP sessions.

since: 3.0

Functions to manipulate resources.

Functions for manipulating selections.

Functions for querying and manipulating text layers.

Provides operations on units, a collection of predefined units and functions to create new units.

A GimpProcedure subclass that makes it easier to write load procedures for vector image formats.

An interface dealing with color profiles.

Functions for writing config info to a file for libgimpconfig.

This structure is used to register translatable descriptions and help texts for enum values. See gimp_enum_set_value_descriptions().

This structure is used to register translatable descriptions and help texts for flag values. See gimp_flags_set_value_descriptions().

A two by two matrix.

A three by three matrix.

A four by four matrix.

This structure contains information about a loadable module.

Arbitrary pieces of data which can be attached to various GIMP objects.

PLease somebody help documenting this.

A wrapper around GScanner with some convenience API.

The prime purpose of a GimpValueArray is for it to be used as an object property that holds an array of values. A GimpValueArray wraps an array of GValue elements in order for it to be used as a boxed type through GIMP_TYPE_VALUE_ARRAY.

since: 2.10

A two dimensional vector.

A three dimensional vector.

A four dimensional vector.

This type is simply a wrapper around Babl when used as a color format.

A boxed type which is nothing more than an alias to a NULL-terminated array of GeglColor.

A boxed type which is nothing more than an alias to a NULL-terminated array of GObject. No reference is being hold on contents because core objects are owned by libgimp.

Modes of initialising a layer mask.

Methods of syncing procedure arguments.

since: 3.0

Extracted from app/paint/paint-enums.h.

Shapes of generated brushes.

Style of line endings.

Operations to combine channels and selections.

Channels (as in color components).

Size of the checkerboard indicating transparency.

Color/Brightness of the checkerboard indicating transparency.

Clone sources.

Modes of color management.

Intents for color management.

Possible tag colors.

since: 2.10

Flags for modifying GimpColorTransform‘s behavior.

Encoding types of image components.

since: 2.10

Types of config paths.

Extracted from app/core/core-enums.h.

Types of palettes for indexed conversion.

Types of convolutions.

Types of detectable CPU accelerations.

Grayscale conversion methods.

Methods for the dodge/burn operation.

Possible return values of gimp_export_options_get_image().

A type of file to choose from when actions are expected to choose a file. This is basically a mapping to %GtkFileChooserAction except for GimpFileChooserAction which should not be used for any GUI functions since we can’t know what you are looking for.

Types of filling.

Foreground extract engines.

Color space for blending gradients.

since: 2.10

Coloring types for gradient segments.

Transition functions for gradient segments.

Gradient shapes.

Rendering types for the display grid.

Extracted from app/core/core-enums.h.

Hue ranges.

Icon types for plug-ins to register.

Image color models.

Possible drawable types.

Ink tool tips.

Interpolation types.

Line join styles.

Extracted from app/operations/operations-enums.h.

Extracted from app/operations/operations-enums.h.

Extracted from app/operations/operations-enums.h.

Layer mask apply modes.

Types of merging layers.

How to present messages.

Well-defined colorspace information available from metadata.

Types of errors returned by modules.

The possible states a GimpModule can be in.

Background fill types for the offset operation.

Orientations for various purposes.

Paint application modes.

Possible type of strokes in path objects.

PDB error handlers.

Types of PDB procedures.

Return status of PDB calls.

How to deal with transparency when creating thubnail pixbufs from images and drawables.

Precisions for pixel encoding.

since: 2.10

Commands for the progress API.

Repeat modes for example for gradients.

Types of simple rotations.

Run modes for plug-ins.

Criterions for color similarity.

Size types for the old-style text API.

When to generate stack traces in case of an error.

Methods of stroking selections and paths.

Text directions.

Text hint strengths.

Text justifications.

For choosing which brightness ranges to transform.

Transform directions.

Ways of clipping the result when transforming drawables.

Extracted from app/core/core-enums.h.

Integer IDs of built-in units used for dimensions in images. These IDs are meant to stay stable but user-created units IDs may change from one session to another.

The types of images and layers an export procedure can handle.

What metadata to load when importing images.

What kinds of metadata to save when exporting images.

The cases when a GimpProcedure should be shown as sensitive.

The possible values of a GError thrown by libgimpconfig.

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

since: 3.0

This function returns the capabilities requested by your export procedure, depending on config or options.

since: 3.0

Loading a vector image happens in 2 steps:

since: 3.0

The signature of the query function a loadable GIMP module must implement. In the module, the function must be called gimp_module_query().

The signature of the register function a loadable GIMP module must implement. In the module, the function must be called gimp_module_register().

Ends the progress.

Makes the progress pulse.

Sets a new text on the progress.

Sets a new percentage on the progress.

Starts the progress.

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

since: 3.0

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

since: 3.0

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

since: 3.0

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

since: 3.0

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

since: 3.0

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

since: 3.0

Paint in the current brush with varying pressure. Paint application is time-dependent.

Paint in the current brush with varying pressure. Paint application is time-dependent.

This function takes any string (UTF-8 or not) and always returns a valid UTF-8 string.

Add a global parasite.

since: 2.8

This function wraps bindtextdomain on UNIX and wbintextdomain on Windows. dir_name is expected to be in the encoding used by the C library on UNIX and UTF-8 on Windows.

since: 3.0

Close the brush selection dialog.

Retrieve a complete listing of the available brushes.

Invokes the GIMP brush selection dialog.

Refresh current brushes. This function always succeeds.

Sets the selected brush in a brush selection dialog.

Deletes a named buffer.

since: 2.4

Retrieves the specified buffer’s bytes.

since: 2.4

Retrieves the specified buffer’s height.

since: 2.4

Retrieves the specified buffer’s image type.

since: 2.4

Retrieves the specified buffer’s width.

since: 2.4

Renames a named buffer.

since: 2.4

Retrieve a complete listing of the available buffers.

since: 2.4

Returns the default top directory for GIMP cached files. If the environment variable GIMP3_CACHEDIR exists, that is used. It should be an absolute pathname. Otherwise, a subdirectory of the directory returned by g_get_user_cache_dir() is used.

since: 2.10.10

Create a repeating checkerboard pattern.

since: 2.6

This function returns a GeglBuffer which wraps surface‘s pixels. It must only be called on image surfaces, calling it on other surface types is an error.

since: 2.10

This function returns a Babl format that corresponds to surface‘s pixel format.

since: 2.10

Turns any input string into a canonicalized string.

since: 2.4

Returns the first checkerboard custom color that can be used in previews.

since: 3.0

Returns the second checkerboard custom color that can be used in previews.

since: 3.0

Returns the size of the checkerboard to be used in previews.

since: 2.2

Returns the type of the checkerboard to be used in previews.

since: 2.2

Retrieves the colors to use when drawing a checkerboard for a certain GimpCheckType and custom colors. If type is GIMP_CHECK_TYPE_CUSTOM_CHECKS, then color1 and color2 will remain untouched, which means you must initialize them to the values expected for custom checks.

since: 3.0

Clone from the source to the dest drawable using the current brush.

Clone from the source to the dest drawable using the current brush.

Creates a new GimpColorArray containing a deep copy of a NULL-terminated array of GeglColor.

Frees a NULL-terminated array of GeglColor.

Determine whether color is out of its space gamut. A small error of margin is accepted, so that for instance a component at -0.0000001 is not making the whole color to be considered as out-of-gamut while it may just be computation imprecision.

since: 3.0

Determine whether color is out of its own space gamut. This can only happen if the color space is unbounded and any of the color component is out of the [0; 1] range. A small error of margin is accepted, so that for instance a component at -0.0000001 is not making the whole color to be considered as out-of-gamut while it may just be computation imprecision.

since: 3.0

Determine whether color1 and color2 can be considered identical to the human eyes, by computing the distance in a color space as perceptually uniform as possible.

since: 3.0

Returns the list of SVG 1.0 color keywords that is recognized by gimp_color_parse_name().

since: 2.2

Attempts to parse a string describing an sRGB color in CSS notation. This can be either a numerical representation (rgb(255,0,0) or rgb(100%,0%,0%)) or a hexadecimal notation as parsed by gimp_color_parse_hex() (##ff0000) or a color name as parsed by gimp_color_parse_css() (red).

Attempts to parse a string describing an sRGB color in CSS notation. This can be either a numerical representation (rgb(255,0,0) or rgb(100%,0%,0%)) or a hexadecimal notation as parsed by gimp_color_parse_hex() (##ff0000) or a color name as parsed by gimp_color_parse_name() (red).

since: 2.2

Attempts to parse a string describing a sRGB color in hexadecimal notation (optionally prefixed with a ‘#’).

Attempts to parse a string describing an RGB color in hexadecimal notation (optionally prefixed with a ‘#’).

since: 2.2

Attempts to parse a color name. This function accepts SVG 1.1 color keywords.

Attempts to parse a color name. This function accepts SVG 1.1 color keywords.

since: 2.2

Update the alpha channel, and any other component if necessary (e.g. in case of premultiplied channels), without changing the format of color.

since: 3.0

Whether the currently active paint dynamics will be applied to painting.

since: 3.0

Enables paint dynamics using the active paint dynamics.

since: 3.0

Get the antialias setting.

since: 2.8

Get the current GIMP background color.

since: 2.2

Get the currently active brush.

since: 2.2

Get brush angle in degrees.

since: 2.8

Get brush aspect ratio.

since: 2.8

Get brush force in paint options.

since: 2.10

Get brush hardness in paint options.

since: 2.10

Get brush size in pixels.

since: 2.8

Get brush spacing as percent of size.

since: 2.10

Get the diagonal neighbors setting.

since: 2.10

Get the distance metric used in some computations.

since: 2.10

Get the currently active paint dynamics.

since: 2.8

Retrieve the currently active stroke option’s emulate brush dynamics setting.

since: 3.0

Get the feather setting.

since: 2.8

Get the feather radius setting.

since: 2.8

Get the currently active font.

since: 2.2

Get the current GIMP foreground color.

since: 2.2

Get the currently active gradient.

since: 2.2

Get the gradient blend color space.

since: 2.10

Get the gradient repeat mode.

since: 2.10

Get the gradient reverse setting.

since: 2.10

Get ink angle in degrees.

since: 2.8

Get ink blob angle in degrees.

since: 2.8

Get ink blob aspect ratio.

since: 2.8

Get ink blob type.

since: 2.8

Get ink blob size in pixels.

since: 2.8

Get ink size sensitivity.

since: 2.8

Get ink speed sensitivity.

since: 2.8

Get ink tilt sensitivity.

since: 2.8

Get the interpolation type.

since: 2.8

Get the line cap style setting.

since: 2.10

Get the line dash offset setting.

since: 2.10

Get the line dash pattern setting.

since: 2.10

Get the line join style setting.

since: 2.10

Get the line miter limit setting.

since: 2.10

Get the line width setting.

since: 2.10

Get the line width unit setting.

since: 2.10

Get the currently active MyPaint brush.

since: 2.10

Get the opacity.

since: 2.2

Get the currently active paint method.

since: 2.4

Get the paint mode.

since: 2.2

Get the currently active palette.

since: 2.2

Get the currently active pattern.

since: 2.2

Get the sample criterion setting.

since: 2.8

Get the sample merged setting.

since: 2.8

Get the sample threshold setting.

since: 2.8

Get the sample threshold setting as an integer value.

since: 2.8

Get the sample transparent setting.

since: 2.8

Get the currently active stroke method.

since: 2.10

Get the transform direction.

since: 2.8

Get the transform resize type.

since: 2.8

Lists the available paint methods.

since: 2.4

Pops the topmost context from the plug-in’s context stack.

since: 2.2

Pushes a context onto the top of the plug-in’s context stack.

since: 2.2

Set the antialias setting.

since: 2.8

Set the current GIMP background color.

since: 2.2

Set the active brush.

since: 2.2

Set brush angle in degrees.

since: 2.8

Set brush aspect ratio.

since: 2.8

Set brush spacing to its default.

since: 2.10

Set brush size to its default.

since: 2.8

Set brush spacing to its default.

since: 2.10

Set brush application force.

since: 2.10

Set brush hardness.

since: 2.10

Set brush size in pixels.

since: 2.8

Set brush spacing as percent of size.

since: 2.10

Set the current GIMP foreground and background colors to black and white.

since: 2.2

Reset context settings to their default values.

since: 2.8

Set the diagonal neighbors setting.

since: 2.10

Set the distance metric used in some computations.

since: 2.10

Set the active paint dynamics.

since: 2.8

Set the stroke option’s emulate brush dynamics setting.

since: 3.0

Set the feather setting.

since: 2.8

Set the feather radius setting.

since: 2.8

Set the active font.

since: 2.2

Set the current GIMP foreground color.

since: 2.2

Sets the active gradient.

since: 2.2

Set the gradient blend color space.

since: 2.10

Sets the built-in FG-BG HSV (ccw) gradient as the active gradient.

since: 2.10

Sets the built-in FG-BG HSV (cw) gradient as the active gradient.

since: 2.10

Sets the built-in FG-BG RGB gradient as the active gradient.

since: 2.10

Sets the built-in FG-Transparent gradient as the active gradient.

since: 2.10

Set the gradient repeat mode.

since: 2.10

Set the gradient reverse setting.

since: 2.10

Set ink angle in degrees.

since: 2.8

Set ink blob angle in degrees.

since: 2.8

Set ink blob aspect ratio.

since: 2.8

Set ink blob type.

since: 2.8

Set ink blob size in pixels.

since: 2.8

Set ink size sensitivity.

since: 2.8

Set ink speed sensitivity.

since: 2.8

Set ink tilt sensitivity.

since: 2.8

Set the interpolation type.

since: 2.8

Set the line cap style setting.

since: 2.10

Set the line dash offset setting.

since: 2.10

Set the line dash pattern setting.

since: 2.10

Set the line join style setting.

since: 2.10

Set the line miter limit setting.

since: 2.10

Set the line width setting.

since: 2.10

Set the line width unit setting.

since: 2.10

Set a MyPaint brush as the active MyPaint brush.

since: 2.10

Set the opacity.

since: 2.2

Set the active paint method.

since: 2.4

Set the paint mode.

since: 2.2

Set the active palette.

since: 2.2

Set the active pattern.

since: 2.2

Set the sample criterion setting.

since: 2.8

Set the sample merged setting.

since: 2.8

Set the sample threshold setting.

since: 2.8

Set the sample threshold setting as an integer value.

since: 2.8

Set the sample transparent setting.

since: 2.8

Set the active stroke method.

since: 2.10

Set the transform direction.

since: 2.8

Set the transform resize type.

since: 2.8

Swap the current GIMP foreground and background colors.

since: 2.2

Convolve (Blur, Sharpen) using the current brush.

Convolve (Blur, Sharpen) using the current brush.

Query for CPU acceleration support.

since: 2.4

Returns the default top directory for GIMP data. If the environment variable GIMP3_DATADIR exists, that is used. It should be an absolute pathname. Otherwise, on Unix the compile-time defined directory is used. On Windows, the installation directory as deduced from the executable’s full filename is used.

Returns a GFile in the data directory, or the data directory itself if first_element is NULL.

since: 2.10

Finishes measuring elapsed time.

Starts measuring elapsed time.

Returns the default display ID. This corresponds to the display the running procedure’s menu entry was invoked from.

Removes a global parasite.

since: 2.8

Returns the user-specific GIMP settings directory. If the environment variable GIMP3_DIRECTORY exists, it is used. If it is an absolute path, it is used as is. If it is a relative path, it is taken to be a subdirectory of the home directory. If it is a relative path, and no home directory can be determined, it is taken to be a subdirectory of gimp_data_directory().

Returns a GFile in the user’s GIMP directory, or the GIMP directory itself if first_element is NULL.

since: 2.10

Flush all internal changes to the user interface.

Reconnect displays from one image to another image.

Dodgeburn image with varying exposure.

Dodgeburn image with varying exposure. This is the same as the gimp_dodgeburn() function except that the exposure, type and mode are taken from the tools option dialog. If the dialog has not been activated then the defaults as used by the dialog will be used.

Close the drawable selection dialog.

Invokes the drawable selection dialog.

Sets the selected drawable in a drawable selection dialog.

Retrieve the list of loaded paint dynamics.

since: 2.8

Refresh current paint dynamics. This function always succeeds.

since: 2.8

Copy from the specified drawables.

Copy from the projection.

since: 2.2

Cut from the specified drawables.

Copy into a named buffer.

since: 2.4

Copy from the projection into a named buffer.

since: 2.4

Cut into a named buffer.

since: 2.4

Paste named buffer to the specified drawable.

since: 2.4

Paste named buffer to a new image.

since: 2.10

Paste buffer to the specified drawable.

Paste buffer to a new image.

since: 2.10

Retrieves GimpEnumDesc associated with the given value, or NULL.

since: 2.2

Checks if value is valid for the enum registered as enum_type. If the value exists in that enum, its name, nick and its translated description and help are returned (if value_name, value_nick, value_desc and value_help are not NULL).

since: 2.2

Retrieves the array of human readable and translatable descriptions and help texts for enum values.

since: 2.2

Sets the array of human readable and translatable descriptions and help texts for enum values.

since: 2.2

Retrieves the translated abbreviation for a given enum_value.

since: 2.10

Retrieves the translated description for a given enum_value.

since: 2.2

Retrieves the translated help for a given enum_value.

since: 2.2

This function gives access to the list of enums registered by libgimp. The returned array is static and must not be modified.

since: 2.2

This function makes sure all the enum types are registered with the GType system. This is intended for use by language bindings that need the symbols early, before gimp_main is run. It’s not necessary for plug-ins to call this directly, because the normal plug-in initialization code will handle it implicitly.

since: 2.4

Erase using the current brush.

Erase using the current brush.

This function returns a copy of str with all underline converted to two adjacent underlines. This comes in handy when needing to display strings with underlines (like filenames) in a place that would convert them to mnemonics.

since: 2.2

Returns whether file plug-ins should default to exporting the image’s color profile.

since: 2.10.4

Returns whether file plug-ins should default to exporting the image’s comment.

since: 3.0

Returns whether file plug-ins should default to exporting Exif metadata, according preferences (original settings is FALSE since metadata can contain sensitive information).

since: 2.10

Returns whether file plug-ins should default to exporting IPTC metadata, according preferences (original settings is FALSE since metadata can contain sensitive information).

since: 2.10

Returns whether file plug-ins should default to exporting the image’s comment.

since: 3.0

Returns whether file plug-ins should default to exporting XMP metadata, according preferences (original settings is FALSE since metadata can contain sensitive information).

since: 2.10

Creates a thumbnail of image for the given file.

Unexpands file‘s path using gimp_config_path_unexpand() and returns the unexpanded path.

since: 2.10

This function works like gimp_filename_to_utf8() and returns a UTF-8 encoded string that does not need to be freed.

since: 2.10

This function checks if file‘s URI ends with extension. It behaves like g_str_has_suffix() on g_file_get_uri(), except that the string comparison is done case-insensitively using g_ascii_strcasecmp().

since: 2.10

Loads an image file by invoking the right load handler.

Loads an image file as a layer for an existing image.

since: 2.4

Loads an image file as layers for an existing image.

since: 2.4

Expands path using gimp_config_path_expand() and returns a GFile for the expanded path.

since: 2.10

Saves to XCF or export image to any supported format by extension.

Shows file in the system file manager.

since: 2.10

Convert a filename in the filesystem’s encoding to UTF-8 temporarily. The return value is a pointer to a string that is guaranteed to be valid only during the current iteration of the main loop or until the next call to gimp_filename_to_utf8().

Retrieves the first GimpFlagsDesc that matches the given value, or NULL.

since: 2.2

Checks if value is valid for the flags registered as flags_type. If the value exists in that flags, its name, nick and its translated description and help are returned (if value_name, value_nick, value_desc and value_help are not NULL).

since: 2.2

Retrieves the array of human readable and translatable descriptions and help texts for flags values.

since: 2.2

Sets the array of human readable and translatable descriptions and help texts for flags values.

since: 2.2

Retrieves the translated abbreviation for a given flags_value.

since: 2.10

Retrieves the translated description for a given flags_value.

since: 2.2

Retrieves the translated help for a given flags_value.

since: 2.2

Anchor the specified floating selection to its associated drawable.

Attach the specified layer as floating to the specified drawable.

Remove the specified floating selection from its associated drawable.

Transforms the specified floating selection into a layer.

Close the font selection dialog.

Retrieve the list of loaded fonts.

Invokes the Gimp font selection dialog.

Refresh current fonts. This function always succeeds.

Sets the current font in a font selection dialog.

Retrieve a copy of the current color management configuration.

since: 2.4

Get the default image comment as specified in the Preferences.

Get the default unit (taken from the user’s locale).

since: 2.4

Returns the list of images currently open.

Get the list of modules which should not be loaded.

Get the monitor resolution as specified in the Preferences.

Returns the number of threads set explicitly by the user in the preferences. This information can be used by plug-ins wishing to follow user settings for multi-threaded implementations.

since: 3.0

Look up a global parasite.

since: 2.8

List all parasites.

since: 2.8

This function returns the plug-in’s GimpPDB instance, which is a singleton that can exist exactly once per running plug-in.

since: 3.0

This function returns the plug-in’s GimpPlugIn instance, which is a a singleton that can exist exactly once per running plug-in.

since: 3.0

Returns the plug-in’s executable name.

Returns the PID of the host GIMP process.

since: 2.4

Queries the gimprc file parser for information on a specified token.

Sets a gimprc token to a value and saves it in the gimprc.

Close the gradient selection dialog.

Retrieve the list of loaded gradients.

Invokes the Gimp gradients selection dialog.

Refresh current gradients. This function always succeeds.

Sets the current gradient in a gradient selection dialog.

Heal from the source to the dest drawable using the current brush.

since: 2.4

Heal from the source to the dest drawable using the current brush.

since: 2.4

Load a help page.

Returns the directory of the current icon theme.

since: 2.10.4

Returns the top installation directory of GIMP. On Unix the compile-time defined installation prefix is used. On Windows, the installation directory as deduced from the executable’s full filename is used. On OSX we ask [NSBundle mainBundle] for the resource path to check if GIMP is part of a relocatable bundle.

since: 2.8

Returns a GFile in the installation directory, or the installation directory itself if first_element is NULL.

since: 2.10.10

Checks if identifier is canonical and non-NULL.

since: 3.0

Returns the list of images currently open.

since: 3.0

Returns the top directory for GIMP locale files. If the environment variable GIMP3_LOCALEDIR exists, that is used. It should be an absolute pathname. Otherwise, on Unix the compile-time defined directory is used. On Windows, the installation directory as deduced from the executable’s full filename is used.

Returns a GFile in the locale directory, or the locale directory itself if first_element is NULL.

since: 2.10

The main plug-in function that must be called with the plug-in’s GimpPlugIn subclass GType and the ‘argc’ and ‘argv’ that are passed to the platform’s main().

since: 3.0

Displays a dialog box with a message.

Returns the current state of where warning messages are displayed.

Controls where warning messages are displayed.

Returns the monitor number to be used for plug-in windows.

Paint in the current brush with optional fade out parameter and pull colors from a gradient.

Paint in the current brush. The fade out parameter and pull colors from a gradient parameter are set from the paintbrush options dialog. If this dialog has not been activated then the dialog defaults will be used.

Close the palette selection dialog.

Retrieves a list of all of the available palettes.

Invokes the Gimp palette selection dialog.

Refreshes current palettes. This function always succeeds.

Sets the current palette in a palette selection dialog.

Creates a new GimpParamSpecArray specifying a GimpArray property.

since: 3.0

Creates a new GimpParamSpecBrush specifying a GimpBrush property. See also gimp_param_spec_resource().

since: 3.0

Creates a new GimpParamSpecChannel specifying a GimpChannel property.

since: 3.0

Creates a new GimpParamSpecChoice specifying a

G_TYPE_STRING property.

This %GimpParamSpecChoice takes ownership of the reference on choice.

since: 3.0

since: 3.0

since: 3.0

Creates a new GParamSpec instance specifying a GeglColor property. Note that the default_color is duplicated, so reusing object will not change the default color of the returned %GimpParamSpecColor.

Creates a new GParamSpec instance specifying a GeglColor property.

since: 2.4

Creates a param spec to hold a filename, dir name, or list of file or dir names. See g_param_spec_internal() for more information.

since: 2.4

Tells whether the path param encodes a filename, dir name, or list of file or dir names.

since: 2.4

Creates a new GimpParamSpecCoreObjectArray specifying a GimpCoreObjectArray property.

since: 3.0

since: 3.0

Creates a new GimpParamSpecDisplay specifying a GimpDisplay property.

since: 3.0

since: 3.0

Creates a new GimpParamSpecDoubleArray specifying a GIMP_TYPE_DOUBLE_ARRAY property.

since: 3.0

Creates a new GimpParamSpecDrawable specifying a GimpDrawable property.

since: 3.0

Creates a new GimpParamSpecDrawableFilter specifying a GimpDrawableFilter property.

since: 3.0

since: 3.0

Creates a new GimpParamSpecExportOptions specifying a

G_TYPE_INT property.

since: 3.0

Creates a param spec to hold a file param. See g_param_spec_internal() for more information.

since: 3.0

since: 3.0

since: 3.0

Change the file action tied to pspec.

since: 3.0

Creates a new GimpParamSpecFont specifying a GimpFont property. See also gimp_param_spec_resource().

since: 3.0

Creates a new GimpParamSpecGradient specifying a GimpGradient property. See also gimp_param_spec_resource().

since: 3.0

Creates a new GimpParamSpecGroupLayer specifying a GimpGroupLayer property.

since: 3.0

Creates a new GimpParamSpecImage specifying a GimpImage property.

since: 3.0

since: 3.0

Creates a new GimpParamSpecInt32Array specifying a GIMP_TYPE_INT32_ARRAY property.

since: 3.0

Creates a new GimpParamSpecItem specifying a GimpItem property.

since: 3.0

since: 3.0

Creates a new GimpParamSpecLayer specifying a GimpLayer property.

since: 3.0

Creates a new GimpParamSpecLayerMask specifying a GimpLayerMask property.

since: 3.0

Creates a param spec to hold a GimpMatrix2 value. See g_param_spec_internal() for more information.

since: 2.4

Creates a param spec to hold a GimpMatrix3 value. See g_param_spec_internal() for more information.

since: 2.8

Creates a param spec to hold a memory size value. See g_param_spec_internal() for more information.

since: 2.4

Creates a new GimpParamSpecPalette specifying a GimpPalette property. See also gimp_param_spec_resource().

since: 3.0

Creates a new GimpParamSpecParasite specifying a GimpParasite property.

since: 2.4

Creates a new GimpParamSpecPath specifying a GimpPath property.

since: 3.0

Creates a new GimpParamSpecPattern specifying a GimpPattern property. See also gimp_param_spec_resource().

since: 3.0

Creates a new GimpParamSpecResource specifying a GimpResource property. See g_param_spec_internal() for details on property names.

since: 3.0

Creates a new GimpParamSpecSelection specifying a GimpSelection property.

since: 3.0

Creates a new GimpParamSpecTextLayer specifying a GimpTextLayer property.

since: 3.0

Creates a param spec to hold a units param. See g_param_spec_internal() for more information.

since: 2.4

since: 3.0

since: 3.0

Creates a new GimpParamSpecValueArray specifying a GValueArray property.

since: 3.0

since: 3.0

Close the pattern selection dialog.

Retrieve a complete listing of the available patterns.

Invokes the Gimp pattern selection.

Refresh current patterns. This function always succeeds.

Sets the current pattern in a pattern selection dialog.

Paint in the current brush without sub-pixel sampling.

Returns a GeglBuffer that’s either backed by the pixbuf‘s pixels, or a copy of them. This function tries to not copy the pixbuf‘s pixels. If the pixbuf’s rowstride is a multiple of its bpp, a simple reference to the pixbuf‘s pixels is made and pixbuf will be kept around for as long as the buffer exists; otherwise the pixels are copied.

since: 2.10

Returns the Babl format that corresponds to the pixbuf‘s pixel format.

since: 2.10

Returns the ICC profile attached to the pixbuf, or NULL if there is none.

since: 2.10

Converts a value specified in pixels to unit.

since: 2.8

Cancels a running progress.

since: 2.2

Ends the progress bar for the current plug-in.

since: 2.4

Returns the native handle of the toplevel window this plug-in’s progress is or would be displayed in.

since: 2.2

Initializes the progress bar for the current plug-in.

Initializes the progress bar for the current plug-in.

since: 2.4

since: 2.4

Pulses the progress bar for the current plug-in.

since: 2.4

Changes the text in the progress bar for the current plug-in.

since: 2.4

Changes the text in the progress bar for the current plug-in.

since: 2.4

Uninstalls a temporary progress procedure that was installed using gimp_progress_install().

since: 2.2

Updates the progress bar for the current plug-in.

Forcefully causes the GIMP library to exit and close down its connection to main gimp application. This function never returns.

This function proposes reasonable settings for increments and display digits. These can be used for instance on GtkRange or other widgets using a GtkAdjustment typically. Note that it will never return digits with value 0. If you know that your input needs to display integer values, there is no need to set digits.

Calculates the intersection of two rectangles.

since: 2.4

Calculates the union of two rectangles.

since: 2.8

Returns whether or not GimpDialog should automatically add a help button if help_func and help_id are given.

since: 2.2

Smudge image with varying pressure.

Smudge image with varying pressure.

Returns TRUE if we have dependencies to generate backtraces. If optimal is TRUE, the function will return TRUE only when we are able to generate optimal traces (i.e. with GDB or LLDB); otherwise we return TRUE even if only backtrace() API is available.

since: 2.10

Attempts to generate a stack trace at current code position in prog_name. prog_name is mostly a helper and can be set to NULL. Nevertheless if set, it has to be the current program name (argv[0]). This function is not meant to generate stack trace for third-party programs, and will attach the current process id only. Internally, this function uses gdb or lldb if they are available, or the stacktrace() API on platforms where it is available. It always fails on Win32.

since: 2.10

This is mostly the same as g_on_error_query() except that we use our own backtrace function, much more complete. prog_name must be the current program name (argv[0]). It does nothing on Win32.

since: 2.10

This function returns a copy of str stripped of underline characters. This comes in handy when needing to strip mnemonics from menu paths etc.

Returns the top directory for GIMP config files. If the environment variable GIMP3_SYSCONFDIR exists, that is used. It should be an absolute pathname. Otherwise, on Unix the compile-time defined directory is used. On Windows, the installation directory as deduced from the executable’s full filename is used.

Returns a GFile in the sysconf directory, or the sysconf directory itself if first_element is NULL.

since: 2.10

Returns the default top directory for GIMP temporary files. If the environment variable GIMP3_TEMPDIR exists, that is used. It should be an absolute pathname. Otherwise, a subdirectory of the directory returned by g_get_tmp_dir() is used.

since: 2.10.10

Generates a unique temporary file.

Add text at the specified location as a floating selection or a new layer.

Get extents of the bounding box for the specified text.

Returns the tile height GIMP is using.

Returns the tile width GIMP is using.

Retrieves the translation context that has been previously set using gimp_type_set_translation_context(). You should not need to use this function directly, use gimp_enum_get_value() or gimp_enum_value_get_desc() instead.

since: 2.8

Retrieves the gettext translation domain identifier that has been previously set using gimp_type_set_translation_domain(). You should not need to use this function directly, use gimp_enum_get_value() or gimp_enum_value_get_desc() instead.

since: 2.2

This function attaches a constant string as a translation context to a GType. The only purpose of this function is to use it when registering a #G_TYPE_ENUM with translatable value names.

since: 2.8

This function attaches a constant string as a gettext translation domain identifier to a GType. The only purpose of this function is to use it when registering a #G_TYPE_ENUM with translatable value names.

since: 2.2

Converts a value specified in unit to pixels.

since: 2.8

Converts a value specified in unit to points.

since: 2.8

Returns the timestamp of the user interaction that should be set on the plug-in window. This is handled transparently, plug-in authors do not have to care about it.

since: 2.6

Creates a (possibly trimmed) copy of str. The string is cut if it exceeds max_chars characters or on the first newline. The fact that the string was trimmed is indicated by appending an ellipsis.

Gets the contents of a GIMP_TYPE_DOUBLE_ARRAY GValue.

Gets the contents of a GIMP_TYPE_INT32_ARRAY GValue.

Gets the contents of a GIMP_TYPE_DOUBLE_ARRAY GValue.

Gets the contents of a GIMP_TYPE_INT32_ARRAY GValue.

Sets the contents of value to data.

Sets the contents of value to data.

Sets the contents of value to data, without copying the data.

Sets the contents of value to data, without copying the data.

Sets the contents of value to data, and takes ownership of data.

Sets the contents of value to data, and takes ownership of data.

"Compute screen (sx, sy) - (sx + w, sy + h) to 3D unit square mapping. The plane to map to is given in the z field of p. The observer is located at position vp (vp->z != 0.0)."

This function is identical to gimp_vector_2d_to_3d() but the position of the observer and the resulting point p are passed by value rather than by reference.

Convert the given 3D point to 2D (project it onto the viewing plane, (sx, sy, 0) - (sx + w, sy + h, 0). The input is assumed to be in the unit square (0, 0, z) - (1, 1, z). The viewpoint of the observer is passed in vp.

Returns the host GIMP version.

Returns the window manager class to be used for plug-in windows.

Sets a single pixel in an Cairo image surface in CAIRO_FORMAT_ARGB32.

since: 2.6

Sets a single pixel in an Cairo image surface in CAIRO_FORMAT_RGB24.

since: 2.6

A macro that expands to the appropriate main() function for the platform being compiled for.

since: 3.0

The dark gray value for the default checkerboard pattern.

The dark light value for the default checkerboard pattern.

The default checkerboard size in pixels. This is configurable in the core but GIMP plug-ins can’t access the user preference and should use this constant instead.

The default small checkerboard size in pixels.

The object property is to be treated as part of the parent object.

Changes to this property should be confirmed by the user before being applied.

Don’t serialize this property if it has the default value.

Ignore this property when comparing objects.

Minimum shift count to be used for core application defined GParamFlags.

The default flags that should be used for serializable GimpConfig properties.

This property exists for obscure reasons or is needed for backward compatibility. Ignore the value read and don’t serialize it.

Changes to this property take effect only after a restart.

A property that can and should be serialized and deserialized.

The major GIMP version number.

The maximum width and height of a GIMP image in pixels. This is a somewhat arbitrary value that can be used when an upper value for pixel sizes is needed; for example to give a spin button an upper limit.

A large but arbitrary value that can be used when an upper limit for a memory size (in bytes) is needed. It is smaller than G_MAXDOUBLE since the GimpMemsizeEntry doesn’t handle larger values.

The maximum resolution of a GIMP image in pixels per inch. This is a somewhat arbitrary value that can be used to when an upper value for a resolution is needed. GIMP will not accept resolutions larger than this value.

The micro GIMP version number.

The minimum width and height of a GIMP image in pixels.

The minimum resolution of a GIMP image in pixels per inch. This is a somewhat arbitrary value that can be used when a lower value for a resolution is needed. GIMP will not accept resolutions smaller than this value.

The minor GIMP version number.

The version of the module system’s ABI. Modules put this value into GimpModuleInfo‘s abi_version field so the code loading the modules can check if it was compiled against the same module ABI the modules are compiled against.

This property will be ignored when serializing and deserializing. This is useful for GimpProcedure arguments for which you never want the last run values to be restored.

Minimum shift count to be used for libgimpconfig defined GParamFlags (see libgimpconfig/gimpconfig-params.h).

Since 3.0

A persistent parasite will be saved to XCF and can be used again after reloading. A non persistent parasite will only be available during the current session. See GimpParasite.

An undoable parasite that was added, can be removed using the Undo action. If this flag is not set, undoing will not change the parasite. See GimpParasite.

The GIMP version as a string.