See also: Main Index; Alphabetic; Misc; By Author; By Module; By Menu External Links: The Gimp; Gimp User Manual
The Gimp misc functions
extension_gimp_help
Input:
| INT32 | num_domain_names | _None_ |
| STRINGARRAY | domain_names | _None_ |
| INT32 | num_domain_uris | _None_ |
| STRINGARRAY | domain_uris | _None_ |
Returns: nothing
blurb repeated:
Sven Neumann, Michael Natterer & Henrik Brix Andersen; 1999-2004
extension_gimp_help_browser
Input:
Returns: nothing
A small and simple HTML browser optimized for browsing the GIMP help pages.
Sven Neumann, Michael Natterer & Henrik Brix Andersen; 1999-2004
extension_wire_debug
Input:
| INT32 | run_mode | Interactive, non-interactive |
| IMAGE | image | Input image |
| DRAWABLE | drawable | Drawable to save |
Returns: nothing
Just some debug spew.
Hans Breuer; 2002
gimp_blend
Input:
| DRAWABLE | drawable | The affected drawable |
| INT32 | blend_mode | The type of blend: { GIMP_FG_BG_RGB_MODE (0), GIMP_FG_BG_HSV_MODE (1), GIMP_FG_TRANSPARENT_MODE (2), GIMP_CUSTOM_MODE (3) } |
| INT32 | paint_mode | The paint application mode: { GIMP_NORMAL_MODE (0), GIMP_DISSOLVE_MODE (1), GIMP_BEHIND_MODE (2), GIMP_MULTIPLY_MODE (3), GIMP_SCREEN_MODE (4), GIMP_OVERLAY_MODE (5), GIMP_DIFFERENCE_MODE (6), GIMP_ADDITION_MODE (7), GIMP_SUBTRACT_MODE (8), GIMP_DARKEN_ONLY_MODE (9), GIMP_LIGHTEN_ONLY_MODE (10), GIMP_HUE_MODE (11), GIMP_SATURATION_MODE (12), GIMP_COLOR_MODE (13), GIMP_VALUE_MODE (14), GIMP_DIVIDE_MODE (15), GIMP_DODGE_MODE (16), GIMP_BURN_MODE (17), GIMP_HARDLIGHT_MODE (18), GIMP_SOFTLIGHT_MODE (19), GIMP_GRAIN_EXTRACT_MODE (20), GIMP_GRAIN_MERGE_MODE (21), GIMP_COLOR_ERASE_MODE (22) } |
| INT32 | gradient_type | The type of gradient: { GIMP_GRADIENT_LINEAR (0), GIMP_GRADIENT_BILINEAR (1), GIMP_GRADIENT_RADIAL (2), GIMP_GRADIENT_SQUARE (3), GIMP_GRADIENT_CONICAL_SYMMETRIC (4), GIMP_GRADIENT_CONICAL_ASYMMETRIC (5), GIMP_GRADIENT_SHAPEBURST_ANGULAR (6), GIMP_GRADIENT_SHAPEBURST_SPHERICAL (7), GIMP_GRADIENT_SHAPEBURST_DIMPLED (8), GIMP_GRADIENT_SPIRAL_CLOCKWISE (9), GIMP_GRADIENT_SPIRAL_ANTICLOCKWISE (10) } |
| SUCCESS | opacity | The opacity of the final blend (0 <= opacity <= 100) |
| SUCCESS | offset | Offset relates to the starting and ending coordinates specified for the blend. This parameter is mode dependent (0 <= offset) |
| INT32 | repeat | Repeat mode: { GIMP_REPEAT_NONE (0), GIMP_REPEAT_SAWTOOTH (1), GIMP_REPEAT_TRIANGULAR (2) } |
| INT32 | reverse | Use the reverse gradient (TRUE or FALSE) |
| INT32 | supersample | Do adaptive supersampling (TRUE or FALSE) |
| INT32 | max_depth | Maximum recursion levels for supersampling |
| SUCCESS | threshold | Supersampling threshold |
| INT32 | dither | Use dithering to reduce banding (TRUE or FALSE) |
| SUCCESS | x1 | The x coordinate of this blend's starting point |
| SUCCESS | y1 | The y coordinate of this blend's starting point |
| SUCCESS | x2 | The x coordinate of this blend's ending point |
| SUCCESS | y2 | The y coordinate of this blend's ending point |
Returns: nothing
This procedure is deprecated! Use 'gimp_edit_blend' instead.
;
gimp_brightness_contrast
Input:
| DRAWABLE | drawable | The drawable |
| INT32 | brightness | Brightness adjustment: (-127 <= brightness <= 127) |
| INT32 | contrast | Contrast adjustment: (-127 <= contrast <= 127) |
Returns: nothing
This procedures allows the brightness and contrast of the specified drawable to be modified. Both 'brightness' and 'contrast' parameters are defined between -127 and 127.
Spencer Kimball & Peter Mattis; 1997
gimp_bucket_fill
Input:
| DRAWABLE | drawable | The affected drawable |
| INT32 | fill_mode | The type of fill: { GIMP_FG_BUCKET_FILL (0), GIMP_BG_BUCKET_FILL (1), GIMP_PATTERN_BUCKET_FILL (2) } |
| INT32 | paint_mode | The paint application mode: { GIMP_NORMAL_MODE (0), GIMP_DISSOLVE_MODE (1), GIMP_BEHIND_MODE (2), GIMP_MULTIPLY_MODE (3), GIMP_SCREEN_MODE (4), GIMP_OVERLAY_MODE (5), GIMP_DIFFERENCE_MODE (6), GIMP_ADDITION_MODE (7), GIMP_SUBTRACT_MODE (8), GIMP_DARKEN_ONLY_MODE (9), GIMP_LIGHTEN_ONLY_MODE (10), GIMP_HUE_MODE (11), GIMP_SATURATION_MODE (12), GIMP_COLOR_MODE (13), GIMP_VALUE_MODE (14), GIMP_DIVIDE_MODE (15), GIMP_DODGE_MODE (16), GIMP_BURN_MODE (17), GIMP_HARDLIGHT_MODE (18), GIMP_SOFTLIGHT_MODE (19), GIMP_GRAIN_EXTRACT_MODE (20), GIMP_GRAIN_MERGE_MODE (21), GIMP_COLOR_ERASE_MODE (22) } |
| SUCCESS | opacity | The opacity of the final bucket fill (0 <= opacity <= 100) |
| SUCCESS | threshold | The threshold determines how extensive the seed fill will be. It's value is specified in terms of intensity levels (0 <= threshold <= 255). This parameter is only valid when there is no selection in the specified image. |
| INT32 | sample_merged | Use the composite image, not the drawable |
| SUCCESS | x | The x coordinate of this bucket fill's application. This parameter is only valid when there is no selection in the specified image. |
| SUCCESS | y | The y coordinate of this bucket fill's application. This parameter is only valid when there is no selection in the specified image. |
Returns: nothing
This procedure is deprecated! Use 'gimp_edit_bucket_fill' instead.
;
gimp_clone
Input:
| DRAWABLE | drawable | The affected drawable |
| DRAWABLE | src_drawable | The source drawable |
| INT32 | clone_type | The type of clone: { GIMP_IMAGE_CLONE (0), GIMP_PATTERN_CLONE (1) } |
| SUCCESS | src_x | The x coordinate in the source image |
| SUCCESS | src_y | The y coordinate in the source image |
| INT32 | num_strokes | Number of stroke control points (count each coordinate as 2 points) |
| FLOATARRAY | strokes | Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y } |
Returns: nothing
This tool clones (copies) from the source drawable starting at the specified source coordinates to the dest drawable. If the "clone_type" argument is set to PATTERN-CLONE, then the current pattern is used as the source and the "src_drawable" argument is ignored. Pattern cloning assumes a tileable pattern and mods the sum of the src coordinates and subsequent stroke offsets with the width and height of the pattern. For image cloning, if the sum of the src coordinates and subsequent stroke offsets exceeds the extents of the src drawable, then no paint is transferred. The clone tool is capable of transforming between any image types including RGB->Indexed--although converting from any type to indexed is significantly slower.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_clone_default
Input:
| DRAWABLE | drawable | The affected drawable |
| INT32 | num_strokes | Number of stroke control points (count each coordinate as 2 points) |
| FLOATARRAY | strokes | Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y } |
Returns: nothing
This tool clones (copies) from the source drawable starting at the specified source coordinates to the dest drawable. This function performs exactly the same as the gimp_clone function except that the tools arguments are obtained from the clones option dialog. It this dialog has not been activated then the dialogs default values will be used.
Andy Thomas; 1999
gimp_color_balance
Input:
| DRAWABLE | drawable | The drawable |
| INT32 | transfer_mode | Transfer mode: { GIMP_SHADOWS (0), GIMP_MIDTONES (1), GIMP_HIGHLIGHTS (2) } |
| INT32 | preserve_lum | Preserve luminosity values at each pixel |
| SUCCESS | cyan_red | Cyan-Red color balance: (-100 <= cyan_red <= 100) |
| SUCCESS | magenta_green | Magenta-Green color balance: (-100 <= magenta_green <= 100) |
| SUCCESS | yellow_blue | Yellow-Blue color balance: (-100 <= yellow_blue <= 100) |
Returns: nothing
Modify the color balance of the specified drawable. There are three axis which can be modified: cyan-red, magenta-green, and yellow-blue. Negative values increase the amount of the former, positive values increase the amount of the latter. Color balance can be controlled with the 'transfer_mode' setting, which allows shadows, midtones, and highlights in an image to be affected differently. The 'preserve_lum' parameter, if non-zero, ensures that the luminosity of each pixel remains fixed.
Spencer Kimball & Peter Mattis; 1997
gimp_color_picker
Input:
| IMAGE | image | The image |
| DRAWABLE | drawable | The drawable to pick from |
| SUCCESS | x | x coordinate of upper-left corner of rectangle |
| SUCCESS | y | y coordinate of upper-left corner of rectangle |
| INT32 | sample_merged | Use the composite image, not the drawable |
| INT32 | sample_average | Average the color of all the pixels in a specified radius |
| SUCCESS | average_radius | The radius of pixels to average |
Returns:
| COLOR | color | The return color |
This procedure is deprecated! Use 'gimp_image_pick_color' instead.
;
gimp_colorize
Input:
| DRAWABLE | drawable | The drawable |
| SUCCESS | hue | Hue in degrees: (0 <= hue <= 360) |
| SUCCESS | saturation | Saturation in percent: (0 <= saturation <= 100) |
| SUCCESS | lightness | Lightness in percent: (-100 <= lightness <= 100) |
Returns: nothing
Desatures the drawable, then tints it with the specified color. This tool is only valid on RGB color images. It will not operate on grayscale or indexed drawables.
Spencer Kimball & Peter Mattis; 2004
gimp_convert_grayscale
Input:
Returns: nothing
This procedure is deprecated! Use 'gimp_image_convert_grayscale' instead.
;
gimp_convert_indexed
Input:
| IMAGE | image | The image |
| INT32 | dither_type | The dither type to use: { GIMP_NO_DITHER (0), GIMP_FS_DITHER (1), GIMP_FSLOWBLEED_DITHER (2), GIMP_FIXED_DITHER (3) } |
| INT32 | palette_type | The type of palette to use: { GIMP_MAKE_PALETTE (0), GIMP_REUSE_PALETTE (1), GIMP_WEB_PALETTE (2), GIMP_MONO_PALETTE (3), GIMP_CUSTOM_PALETTE (4) } |
| INT32 | num_cols | The number of colors to quantize to, ignored unless (palette_type == GIMP_MAKE_PALETTE) |
| INT32 | alpha_dither | Dither transparency to fake partial opacity |
| INT32 | remove_unused | Remove unused or duplicate colour entries from final palette, ignored if (palette_type == GIMP_MAKE_PALETTE) |
| STRING | palette | The name of the custom palette to use, ignored unless (palette_type == GIMP_CUSTOM_PALETTE) |
Returns: nothing
This procedure is deprecated! Use 'gimp_image_convert_indexed' instead.
;
gimp_convert_rgb
Input:
Returns: nothing
This procedure is deprecated! Use 'gimp_image_convert_rgb' instead.
;
gimp_convolve
Input:
| DRAWABLE | drawable | The affected drawable |
| SUCCESS | pressure | The pressure: 0 <= pressure <= 100 |
| INT32 | convolve_type | Convolve type: { GIMP_BLUR_CONVOLVE (0), GIMP_SHARPEN_CONVOLVE (1) } |
| INT32 | num_strokes | Number of stroke control points (count each coordinate as 2 points) |
| FLOATARRAY | strokes | Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y } |
Returns: nothing
This tool convolves the specified drawable with either a sharpening or blurring kernel. The pressure parameter controls the magnitude of the operation. Like the paintbrush, this tool linearly interpolates between the specified stroke coordinates.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_convolve_default
Input:
| DRAWABLE | drawable | The affected drawable |
| INT32 | num_strokes | Number of stroke control points (count each coordinate as 2 points) |
| FLOATARRAY | strokes | Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y } |
Returns: nothing
This tool convolves the specified drawable with either a sharpening or blurring kernel. This function performs exactly the same as the gimp_convolve function except that the tools arguments are obtained from the convolve option dialog. It this dialog has not been activated then the dialogs default values will be used.
Andy Thomas; 1999
gimp_crop
Input:
| IMAGE | image | The image |
| INT32 | new_width | New image width: (0 < new_width <= width) |
| INT32 | new_height | New image height: (0 < new_height <= height) |
| INT32 | offx | x offset: (0 <= offx <= (width - new_width)) |
| INT32 | offy | y offset: (0 <= offy <= (height - new_height)) |
Returns: nothing
This procedure is deprecated! Use 'gimp_image_crop' instead.
;
gimp_curves_explicit
Input:
| DRAWABLE | drawable | The drawable |
| INT32 | channel | The channel to modify: { GIMP_HISTOGRAM_VALUE (0), GIMP_HISTOGRAM_RED (1), GIMP_HISTOGRAM_GREEN (2), GIMP_HISTOGRAM_BLUE (3), GIMP_HISTOGRAM_ALPHA (4) } |
| INT32 | num_bytes | The number of bytes in the new curve (always 256) |
| INT8ARRAY | curve | The explicit curve |
Returns: nothing
Modifies the intensity mapping for one channel in the specified drawable. The drawable must be either grayscale or RGB, and the channel can be either an intensity component, or the value. The 'curve' parameter is an array of bytes which explicitly defines how each pixel value in the drawable will be modified. Use the 'gimp_curves_spline' function to modify intensity levels with Catmull Rom splines.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_curves_spline
Input:
| DRAWABLE | drawable | The drawable |
| INT32 | channel | The channel to modify: { GIMP_HISTOGRAM_VALUE (0), GIMP_HISTOGRAM_RED (1), GIMP_HISTOGRAM_GREEN (2), GIMP_HISTOGRAM_BLUE (3), GIMP_HISTOGRAM_ALPHA (4) } |
| INT32 | num_points | The number of values in the control point array (3 < num_points <= 34) |
| INT8ARRAY | control_pts | The spline control points: { cp1.x, cp1.y, cp2.x, cp2.y, ... } |
Returns: nothing
Modifies the intensity mapping for one channel in the specified drawable. The drawable must be either grayscale or RGB, and the channel can be either an intensity component, or the value. The 'control_pts' parameter is an array of integers which define a set of control points which describe a Catmull Rom spline which yields the final intensity curve. Use the 'gimp_curves_explicit' function to explicitly modify intensity levels.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_desaturate
Input:
| DRAWABLE | drawable | The drawable |
Returns: nothing
This procedure desaturates the contents of the specified drawable. This procedure only works on drawables of type RGB color.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_desaturate_full
Input:
| DRAWABLE | drawable | The drawable |
| INT32 | desaturate_mode | The formula to use to desaturate |
Returns: nothing
This procedure desaturates the contents of the specified drawable, with the specified formula. This procedure only works on drawables of type RGB color.
Karine Delvare; 2005
gimp_display_delete
Input:
| DISPLAY | display | The display to delete |
Returns: nothing
This procedure removes the specified display. If this is the last remaining display for the underlying image, then the image is deleted also.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_display_new
Input:
Returns:
| DISPLAY | display | The new display |
Creates a new display for the specified image. If the image already has a display, another is added. Multiple displays are handled transparently by the GIMP. The newly created display is returned and can be subsequently destroyed with a call to 'gimp-display-delete'. This procedure only makes sense for use with the GIMP UI.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_displays_flush
Input: none
Returns: nothing
This procedure takes no arguments and returns nothing except a success status. Its purpose is to flush all pending updates of image manipulations to the user interface. It should be called whenever appropriate.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_displays_reconnect
Input:
| IMAGE | old_image | The old image (must have at least one display) |
| IMAGE | new_image | The new image (must not have a display) |
Returns: nothing
This procedure connects all displays of the old_image to the new_image. If the old_image has no display or new_image already has a display the reconnect is not performed and the procedure returns without success. You should rarely need to use this function.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_dodgeburn
Input:
| DRAWABLE | drawable | The affected drawable |
| SUCCESS | exposure | The exposer of the strokes (0 <= exposure <= 100) |
| INT32 | dodgeburn_type | The type either dodge or burn: { GIMP_DODGE (0), GIMP_BURN (1) } |
| INT32 | dodgeburn_mode | The mode: { GIMP_SHADOWS (0), GIMP_MIDTONES (1), GIMP_HIGHLIGHTS (2) } |
| INT32 | num_strokes | Number of stroke control points (count each coordinate as 2 points) |
| FLOATARRAY | strokes | Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y } |
Returns: nothing
Dodgeburn. More details here later.
Andy Thomas; 1999
gimp_dodgeburn_default
Input:
| DRAWABLE | drawable | The affected drawable |
| INT32 | num_strokes | Number of stroke control points (count each coordinate as 2 points) |
| FLOATARRAY | strokes | Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y } |
Returns: nothing
Dodgeburn. More details here later.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_edit_blend
Input:
| DRAWABLE | drawable | The affected drawable |
| INT32 | blend_mode | The type of blend: { GIMP_FG_BG_RGB_MODE (0), GIMP_FG_BG_HSV_MODE (1), GIMP_FG_TRANSPARENT_MODE (2), GIMP_CUSTOM_MODE (3) } |
| INT32 | paint_mode | The paint application mode: { GIMP_NORMAL_MODE (0), GIMP_DISSOLVE_MODE (1), GIMP_BEHIND_MODE (2), GIMP_MULTIPLY_MODE (3), GIMP_SCREEN_MODE (4), GIMP_OVERLAY_MODE (5), GIMP_DIFFERENCE_MODE (6), GIMP_ADDITION_MODE (7), GIMP_SUBTRACT_MODE (8), GIMP_DARKEN_ONLY_MODE (9), GIMP_LIGHTEN_ONLY_MODE (10), GIMP_HUE_MODE (11), GIMP_SATURATION_MODE (12), GIMP_COLOR_MODE (13), GIMP_VALUE_MODE (14), GIMP_DIVIDE_MODE (15), GIMP_DODGE_MODE (16), GIMP_BURN_MODE (17), GIMP_HARDLIGHT_MODE (18), GIMP_SOFTLIGHT_MODE (19), GIMP_GRAIN_EXTRACT_MODE (20), GIMP_GRAIN_MERGE_MODE (21), GIMP_COLOR_ERASE_MODE (22) } |
| INT32 | gradient_type | The type of gradient: { GIMP_GRADIENT_LINEAR (0), GIMP_GRADIENT_BILINEAR (1), GIMP_GRADIENT_RADIAL (2), GIMP_GRADIENT_SQUARE (3), GIMP_GRADIENT_CONICAL_SYMMETRIC (4), GIMP_GRADIENT_CONICAL_ASYMMETRIC (5), GIMP_GRADIENT_SHAPEBURST_ANGULAR (6), GIMP_GRADIENT_SHAPEBURST_SPHERICAL (7), GIMP_GRADIENT_SHAPEBURST_DIMPLED (8), GIMP_GRADIENT_SPIRAL_CLOCKWISE (9), GIMP_GRADIENT_SPIRAL_ANTICLOCKWISE (10) } |
| SUCCESS | opacity | The opacity of the final blend (0 <= opacity <= 100) |
| SUCCESS | offset | Offset relates to the starting and ending coordinates specified for the blend. This parameter is mode dependent (0 <= offset) |
| INT32 | repeat | Repeat mode: { GIMP_REPEAT_NONE (0), GIMP_REPEAT_SAWTOOTH (1), GIMP_REPEAT_TRIANGULAR (2) } |
| INT32 | reverse | Use the reverse gradient (TRUE or FALSE) |
| INT32 | supersample | Do adaptive supersampling (TRUE or FALSE) |
| INT32 | max_depth | Maximum recursion levels for supersampling |
| SUCCESS | threshold | Supersampling threshold |
| INT32 | dither | Use dithering to reduce banding (TRUE or FALSE) |
| SUCCESS | x1 | The x coordinate of this blend's starting point |
| SUCCESS | y1 | The y coordinate of this blend's starting point |
| SUCCESS | x2 | The x coordinate of this blend's ending point |
| SUCCESS | y2 | The y coordinate of this blend's ending point |
Returns: nothing
This tool requires information on the paint application mode, the blend mode, and the gradient type. It creates the specified variety of blend using the starting and ending coordinates as defined for each gradient type.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_edit_bucket_fill
Input:
| DRAWABLE | drawable | The affected drawable |
| INT32 | fill_mode | The type of fill: { GIMP_FG_BUCKET_FILL (0), GIMP_BG_BUCKET_FILL (1), GIMP_PATTERN_BUCKET_FILL (2) } |
| INT32 | paint_mode | The paint application mode: { GIMP_NORMAL_MODE (0), GIMP_DISSOLVE_MODE (1), GIMP_BEHIND_MODE (2), GIMP_MULTIPLY_MODE (3), GIMP_SCREEN_MODE (4), GIMP_OVERLAY_MODE (5), GIMP_DIFFERENCE_MODE (6), GIMP_ADDITION_MODE (7), GIMP_SUBTRACT_MODE (8), GIMP_DARKEN_ONLY_MODE (9), GIMP_LIGHTEN_ONLY_MODE (10), GIMP_HUE_MODE (11), GIMP_SATURATION_MODE (12), GIMP_COLOR_MODE (13), GIMP_VALUE_MODE (14), GIMP_DIVIDE_MODE (15), GIMP_DODGE_MODE (16), GIMP_BURN_MODE (17), GIMP_HARDLIGHT_MODE (18), GIMP_SOFTLIGHT_MODE (19), GIMP_GRAIN_EXTRACT_MODE (20), GIMP_GRAIN_MERGE_MODE (21), GIMP_COLOR_ERASE_MODE (22) } |
| SUCCESS | opacity | The opacity of the final bucket fill (0 <= opacity <= 100) |
| SUCCESS | threshold | The threshold determines how extensive the seed fill will be. It's value is specified in terms of intensity levels (0 <= threshold <= 255). This parameter is only valid when there is no selection in the specified image. |
| INT32 | sample_merged | Use the composite image, not the drawable |
| SUCCESS | x | The x coordinate of this bucket fill's application. This parameter is only valid when there is no selection in the specified image. |
| SUCCESS | y | The y coordinate of this bucket fill's application. This parameter is only valid when there is no selection in the specified image. |
Returns: nothing
This tool requires information on the paint application mode, and the fill mode, which can either be in the foreground color, or in the currently active pattern. If there is no selection, a seed fill is executed at the specified coordinates and extends outward in keeping with the threshold parameter. If there is a selection in the target image, the threshold, sample merged, x, and y arguments are unused. If the sample_merged parameter is non-zero, the data of the composite image will be used instead of that for the specified drawable. This is equivalent to sampling for colors after merging all visible layers. In the case of merged sampling, the x and y coordinates are relative to the image's origin; otherwise, they are relative to the drawable's origin.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_edit_clear
Input:
| DRAWABLE | drawable | The drawable to clear from |
Returns: nothing
This procedure clears the specified drawable. If the drawable has an alpha channel, the cleared pixels will become transparent. If the drawable does not have an alpha channel, cleared pixels will be set to the background color. This procedure only affects regions within a selection if there is a selection active.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_edit_copy
Input:
| DRAWABLE | drawable | The drawable to copy from |
Returns:
| INT32 | non_empty | TRUE if the copy was successful, FALSE if the selection contained only transparent pixels |
If there is a selection in the image, then the area specified by the selection is copied from the specified drawable and placed in an internal GIMP edit buffer. It can subsequently be retrieved using the 'gimp-edit-paste' command. If there is no selection, then the specified drawable's contents will be stored in the internal GIMP edit buffer.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_edit_copy_visible
Input:
| IMAGE | image | The image to copy from |
Returns:
| INT32 | non_empty | TRUE if the copy was successful, FALSE if the selection contained only transparent pixels |
If there is a selection in the image, then the area specified by the selection is copied from the projection and placed in an internal GIMP edit buffer. It can subsequently be retrieved using the 'gimp-edit-paste' command. If there is no selection, then the projection's contents will be stored in the internal GIMP edit buffer.
Michael Natterer <mitch@gimp.org>; 2004
gimp_edit_cut
Input:
| DRAWABLE | drawable | The drawable to cut from |
Returns:
| INT32 | non_empty | TRUE if the cut was successful, FALSE if the selection contained only transparent pixels |
If there is a selection in the image, then the area specified by the selection is cut from the specified drawable and placed in an internal GIMP edit buffer. It can subsequently be retrieved using the 'gimp-edit-paste' command. If there is no selection, then the specified drawable will be removed and its contents stored in the internal GIMP edit buffer.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_edit_fill
Input:
| DRAWABLE | drawable | The drawable to fill to |
| INT32 | fill_type | The type of fill: GIMP_FOREGROUND_FILL (0), GIMP_BACKGROUND_FILL (1), GIMP_WHITE_FILL (2), GIMP_TRANSPARENT_FILL (3), GIMP_PATTERN_FILL (4) |
Returns: nothing
This procedure fills the specified drawable with the fill mode. If the fill mode is foreground, the current foreground color is used. If the fill mode is background, the current background color is used. Other fill modes should not be used. This procedure only affects regions within a selection if there is a selection active. If you want to fill the whole drawable, regardless of the selection, use gimp_drawable_fill().
Spencer Kimball & Peter Mattis; 1995-2000
gimp_edit_paste
Input:
| DRAWABLE | drawable | The drawable to paste to |
| INT32 | paste_into | Clear selection, or paste behind it? |
Returns:
| LAYER | floating_sel | The new floating selection |
This procedure pastes a copy of the internal GIMP edit buffer to the specified drawable. The GIMP edit buffer will be empty unless a call was previously made to either 'gimp-edit-cut' or 'gimp-edit-copy'. The "paste_into" option specifies whether to clear the current image selection, or to paste the buffer "behind" the selection. This allows the selection to act as a mask for the pasted buffer. Anywhere that the selection mask is non-zero, the pasted buffer will show through. The pasted buffer will be a new layer in the image which is designated as the image floating selection. If the image has a floating selection at the time of pasting, the old floating selection will be anchored to it's drawable before the new floating selection is added. This procedure returns the new floating layer. The resulting floating selection will already be attached to the specified drawable, and a subsequent call to floating_sel_attach is not needed.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_edit_stroke
Input:
| DRAWABLE | drawable | The drawable to stroke to |
Returns: nothing
This procedure strokes the current selection, painting along the selection boundary with the active brush and foreground color. The paint is applied to the specified drawable regardless of the active selection.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_equalize
Input:
| DRAWABLE | drawable | The drawable |
| INT32 | mask_only | Equalization option |
Returns: nothing
This procedure equalizes the contents of the specified drawable. Each intensity channel is equalizeed independently. The equalized intensity is given as inten' = (255 - inten). Indexed color drawables are not valid for this operation. The 'mask_only' option specifies whether to adjust only the area of the image within the selection bounds, or the entire image based on the histogram of the selected area. If there is no selection, the entire image is adjusted based on the histogram for the entire image.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_eraser
Input:
| DRAWABLE | drawable | The affected drawable |
| INT32 | num_strokes | Number of stroke control points (count each coordinate as 2 points) |
| FLOATARRAY | strokes | Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y } |
| INT32 | hardness | GIMP_BRUSH_HARD (0) or GIMP_BRUSH_SOFT (1) |
| INT32 | method | GIMP_PAINT_CONSTANT (0) or GIMP_PAINT_INCREMENTAL (1) |
Returns: nothing
This tool erases using the current brush mask. If the specified drawable contains an alpha channel, then the erased pixels will become transparent. Otherwise, the eraser tool replaces the contents of the drawable with the background color. Like paintbrush, this tool linearly interpolates between the specified stroke coordinates.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_eraser_default
Input:
| DRAWABLE | drawable | The affected drawable |
| INT32 | num_strokes | Number of stroke control points (count each coordinate as 2 points) |
| FLOATARRAY | strokes | Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y } |
Returns: nothing
This tool erases using the current brush mask. This function performs exactly the same as the gimp_eraser function except that the tools arguments are obtained from the eraser option dialog. It this dialog has not been activated then the dialogs default values will be used.
Andy Thomas; 1999
gimp_flip
Input:
| DRAWABLE | drawable | The affected drawable |
| INT32 | flip_type | Type of flip: GIMP_ORIENTATION_HORIZONTAL (0) or GIMP_ORIENTATION_VERTICAL (1) |
Returns:
| DRAWABLE | drawable | The flipped drawable |
This procedure is deprecated! Use 'gimp_drawable_transform_flip_simple' instead.
;
gimp_fonts_close_popup
Input:
| STRING | font_callback | The name of the callback registered for this popup |
Returns: nothing
This procedure closes an opened font selection dialog.
Sven Neumann; 2003
gimp_fonts_get_list
Input:
| STRING | filter | An optional regular expression used to filter the list |
Returns:
| INT32 | num_fonts | The number of available fonts |
| STRINGARRAY | font_list | The list of font names |
This procedure returns a list of the fonts that are currently available.
Sven Neumann; 2003
gimp_fonts_popup
Input:
| STRING | font_callback | The callback PDB proc to call when font selection is made |
| STRING | popup_title | Title to give the font popup window |
| STRING | initial_font | The name of the font to set as the first selected |
Returns: nothing
This procedure popups the font selection dialog.
Sven Neumann; 2003
gimp_fonts_refresh
Input: none
Returns: nothing
This procedure retrieves all fonts currently in the user's font path and updates the font dialogs accordingly.
Sven Neumann; 2003
gimp_fonts_set_popup
Input:
| STRING | font_callback | The name of the callback registered for this popup |
| STRING | font_name | The name of the font to set as selected |
Returns: nothing
Sets the current font selection in a popup.
Sven Neumann; 2003
gimp_get_color_configuration
Input: none
Returns:
| STRING | config | Serialized color management configuration |
Returns a string that can be deserialized into a GimpColorConfig object representing the current color management configuration.
Sven Neumann; 2005
gimp_get_default_comment
Input: none
Returns:
| STRING | comment | Default Image Comment |
Returns a copy of the default image comment.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_get_module_load_inhibit
Input: none
Returns:
| STRING | load_inhibit | The list of modules |
Returns a copy of the list of modules which should not be loaded.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_get_monitor_resolution
Input: none
Returns:
| SUCCESS | xres | X resolution |
| SUCCESS | yres | Y resolution |
Returns the resolution of the monitor in pixels/inch. This value is taken from the Preferences (or the windowing system if this is set in the Preferences) and there's no guarantee for the value to be reasonable.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_get_theme_dir
Input: none
Returns:
| STRING | theme_dir | The GUI theme dir |
Returns a copy of the current GUI theme dir.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_gimprc_query
Input:
| STRING | token | The token to query for |
Returns:
| STRING | value | The value associated with the queried token |
This procedure is used to locate additional information contained in the gimprc file considered extraneous to the operation of the GIMP. Plug-ins that need configuration information can expect it will be stored in the user gimprc file and can use this procedure to retrieve it. This query procedure will return the value associated with the specified token. This corresponds _only_ to entries with the format: (<token> <value>). The value must be a string. Entries not corresponding to this format will cause warnings to be issued on gimprc parsing and will not be queryable.
Spencer Kimball & Peter Mattis; 1997
gimp_gimprc_set
Input:
| STRING | token | The token to add or modify |
| STRING | value | The value to set the token to |
Returns: nothing
This procedure is used to add or change additional information in the gimprc file that is considered extraneous to the operation of the GIMP. Plug-ins that need configuration information can use this function to store it, and gimp_gimprc_query to retrieve it. This will accept _only_ string values in UTF-8 encoding.
Seth Burgess; 1999
gimp_help
Input:
| STRING | help_domain | The help domain in which help_id is registered |
| STRING | help_id | The help page's ID |
Returns: nothing
This procedure loads the specified help page into the helpbrowser or what ever is configured as help viewer. The help page is identified by its domain and ID: if help_domain is NULL, we use the help_domain which was registered using the gimp-plugin-help-register procedure. If help_domain is NULL and no help domain was registered, the help domain of the main GIMP installation is used.
Michael Natterer <mitch@gimp.org>; 2000
gimp_histogram
Input:
| DRAWABLE | drawable | The drawable |
| INT32 | channel | The channel to modify: { GIMP_HISTOGRAM_VALUE (0), GIMP_HISTOGRAM_RED (1), GIMP_HISTOGRAM_GREEN (2), GIMP_HISTOGRAM_BLUE (3), GIMP_HISTOGRAM_ALPHA (4) } |
| INT32 | start_range | Start of the intensity measurement range |
| INT32 | end_range | End of the intensity measurement range |
Returns:
| SUCCESS | mean | Mean intensity value |
| SUCCESS | std_dev | Standard deviation of intensity values |
| SUCCESS | median | Median intensity value |
| SUCCESS | pixels | Alpha-weighted pixel count for entire image |
| SUCCESS | count | Alpha-weighted pixel count for range |
| SUCCESS | percentile | Percentile that range falls under |
This tool makes it possible to gather information about the intensity histogram of a drawable. A channel to examine is first specified. This can be either value, red, green, or blue, depending on whether the drawable is of type color or grayscale. The drawable may not be indexed. Second, a range of intensities are specified. The gimp_histogram function returns statistics based on the pixels in the drawable that fall under this range of values. Mean, standard deviation, median, number of pixels, and percentile are all returned. Additionally, the total count of pixels in the image is returned. Counts of pixels are weighted by any associated alpha values and by the current selection mask. That is, pixels that lie outside an active selection mask will not be counted. Similarly, pixels with transparent alpha values will not be counted.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_hue_saturation
Input:
| DRAWABLE | drawable | The drawable |
| INT32 | hue_range | Range of affected hues: { GIMP_ALL_HUES (0), GIMP_RED_HUES (1), GIMP_YELLOW_HUES (2), GIMP_GREEN_HUES (3), GIMP_CYAN_HUES (4), GIMP_BLUE_HUES (5), GIMP_MAGENTA_HUES (6) } |
| SUCCESS | hue_offset | Hue offset in degrees: (-180 <= hue_offset <= 180) |
| SUCCESS | lightness | lightness modification: (-100 <= lightness <= 100) |
| SUCCESS | saturation | saturation modification: (-100 <= saturation <= 100) |
Returns: nothing
This procedures allows the hue, lightness, and saturation in the specified drawable to be modified. The 'hue_range' parameter provides the capability to limit range of affected hues.
Spencer Kimball & Peter Mattis; 1997
gimp_invert
Input:
| DRAWABLE | drawable | The drawable |
Returns: nothing
This procedure inverts the contents of the specified drawable. Each intensity channel is inverted independently. The inverted intensity is given as inten' = (255 - inten). Indexed color drawables are not valid for this operation.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_levels
Input:
| DRAWABLE | drawable | The drawable |
| INT32 | channel | The channel to modify: { GIMP_HISTOGRAM_VALUE (0), GIMP_HISTOGRAM_RED (1), GIMP_HISTOGRAM_GREEN (2), GIMP_HISTOGRAM_BLUE (3), GIMP_HISTOGRAM_ALPHA (4) } |
| INT32 | low_input | Intensity of lowest input: (0 <= low_input <= 255) |
| INT32 | high_input | Intensity of highest input: (0 <= high_input <= 255) |
| SUCCESS | gamma | Gamma correction factor: (0.1 <= gamma <= 10) |
| INT32 | low_output | Intensity of lowest output: (0 <= low_output <= 255) |
| INT32 | high_output | Intensity of highest output: (0 <= high_output <= 255) |
Returns: nothing
This tool allows intensity levels in the specified drawable to be remapped according to a set of parameters. The low/high input levels specify an initial mapping from the source intensities. The gamma value determines how intensities between the low and high input intensities are interpolated. A gamma value of 1.0 results in a linear interpolation. Higher gamma values result in more high-level intensities. Lower gamma values result in more low-level intensities. The low/high output levels constrain the final intensity mapping--that is, no final intensity will be lower than the low output level and no final intensity will be higher than the high output level. This tool is only valid on RGB color and grayscale images. It will not operate on indexed drawables.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_levels_auto
Input:
| DRAWABLE | drawable | The drawable |
Returns: nothing
This procedure is deprecated! Use 'gimp_levels_stretch' instead.
;
gimp_levels_stretch
Input:
| DRAWABLE | drawable | The drawable |
Returns: nothing
This procedure allows intensity levels in the specified drawable to be remapped according to a set of guessed parameters. It is equivalent to clicking the "Auto" button in the Levels tool. This procedure is only valid on RGB color and grayscale images. It will not operate on indexed drawables.
Joao S.O. Bueno, Shawn Willden; 2003
gimp_message
Input:
| STRING | message | Message to display in the dialog |
Returns: nothing
Displays a dialog box with a message. Useful for status or error reporting. The message must be in UTF-8 encoding.
Manish Singh; 1998
gimp_message_get_handler
Input: none
Returns:
| INT32 | handler | The current handler type: { GIMP_MESSAGE_BOX (0), GIMP_CONSOLE (1), GIMP_ERROR_CONSOLE (2) } |
This procedure returns the way g_message warnings are displayed. They can be shown in a dialog box or printed on the console where gimp was started.
Manish Singh; 1998
gimp_message_set_handler
Input:
| INT32 | handler | The new handler type: { GIMP_MESSAGE_BOX (0), GIMP_CONSOLE (1), GIMP_ERROR_CONSOLE (2) } |
Returns: nothing
This procedure controls how g_message warnings are displayed. They can be shown in a dialog box or printed on the console where gimp was started.
Manish Singh; 1998
gimp_pencil
Input:
| DRAWABLE | drawable | The affected drawable |
| INT32 | num_strokes | Number of stroke control points (count each coordinate as 2 points) |
| FLOATARRAY | strokes | Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y } |
Returns: nothing
This tool is the standard pencil. It draws linearly interpolated lines through the specified stroke coordinates. It operates on the specified drawable in the foreground color with the active brush. The brush mask is treated as though it contains only black and white values. Any value below half is treated as black; any above half, as white.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_perspective
Input:
| DRAWABLE | drawable | The affected drawable |
| INT32 | interpolation | Whether to use interpolation |
| SUCCESS | x0 | The new x coordinate of upper-left corner of original bounding box |
| SUCCESS | y0 | The new y coordinate of upper-left corner of original bounding box |
| SUCCESS | x1 | The new x coordinate of upper-right corner of original bounding box |
| SUCCESS | y1 | The new y coordinate of upper-right corner of original bounding box |
| SUCCESS | x2 | The new x coordinate of lower-left corner of original bounding box |
| SUCCESS | y2 | The new y coordinate of lower-left corner of original bounding box |
| SUCCESS | x3 | The new x coordinate of lower-right corner of original bounding box |
| SUCCESS | y3 | The new y coordinate of lower-right corner of original bounding box |
Returns:
| DRAWABLE | drawable | The newly mapped drawable |
This procedure is deprecated! Use 'gimp_drawable_transform_perspective_default' instead.
;
gimp_plugin_domain_register
Input:
| STRING | domain_name | The name of the textdomain (must be unique) |
| STRING | domain_path | The absolute path to the compiled message catalog (may be NULL) |
Returns: nothing
This procedure adds a textdomain to the list of domains Gimp searches for strings when translating its menu entries. There is no need to call this function for plug-ins that have their strings included in the gimp-std-plugins domain as that is used by default. If the compiled message catalog is not in the standard location, you may specify an absolute path to another location. This procedure can only be called in the query function of a plug-in and it has to be called before any procedure is installed.
Sven Neumann; 2000
gimp_plugin_help_register
Input:
| STRING | domain_name | The XML namespace of the plug-in's help pages |
| STRING | domain_uri | The root URI of the plug-in's help pages |
Returns: nothing
This procedure changes the help rootdir for the plug-in which calls it. All subsequent calls of gimp_help from this plug-in will be interpreted relative to this rootdir.
Michael Natterer <mitch@gimp.org>; 2000
gimp_plugin_icon_register
Input:
| STRING | procedure_name | The procedure for which to install the icon |
| INT32 | icon_type | The type of the icon |
| INT32 | icon_data_length | The length of 'icon_data': 0 < icon_data_length |
| INT8ARRAY | icon_data | The procedure's icon. The format depends on the 'icon_type' parameter |
Returns: nothing
This procedure installs an icon for the given procedure.
Michael Natterer <mitch@gimp.org>; 2004
gimp_plugin_menu_branch_register
Input:
| STRING | menu_path | The sub-menu's menu path |
| STRING | menu_name | The name of the sub-menu |
Returns: nothing
This procedure installs an sub-menu which does not belong to any procedure.
Michael Natterer <mitch@gimp.org>; 2005
gimp_plugin_menu_register
Input:
| STRING | procedure_name | The procedure for which to install the menu path |
| STRING | menu_path | The procedure's additional menu path |
Returns: nothing
This procedure installs an additional menu entry for the given procedure.
Michael Natterer <mitch@gimp.org>; 2004
gimp_plugins_query
Input:
| STRING | search_string | If not an empty string then use this as a search pattern |
Returns:
| INT32 | num_plugins | The number of plugins |
| STRINGARRAY | menu_path | The menu path of the plugin |
| INT32 | num_plugins | The number of plugins |
| STRINGARRAY | plugin_accelerator | String representing keyboard accelerator (could be empty string) |
| INT32 | num_plugins | The number of plugins |
| STRINGARRAY | plugin_location | Location of the plugin program |
| INT32 | num_plugins | The number of plugins |
| STRINGARRAY | plugin_image_type | Type of image that this plugin will work on |
| INT32 | num_plugins | The number of plugins |
| INT32ARRAY | plugin_install_time | Time that the plugin was installed |
| INT32 | num_plugins | The number of plugins |
| STRINGARRAY | plugin_real_name | The internal name of the plugin |
This procedure queries the contents of the plugin database.
Andy Thomas; 1998
gimp_posterize
Input:
| DRAWABLE | drawable | The drawable |
| INT32 | levels | Levels of posterization: (2 <= levels <= 255) |
Returns: nothing
This procedures reduces the number of shades allows in each intensity channel to the specified 'levels' parameter.
Spencer Kimball & Peter Mattis; 1997
gimp_progress_cancel
Input:
| STRING | progress_callback | The name of the callback registered for this progress |
Returns: nothing
This function cancels the currently running progress.
Michael Natterer; 2004
gimp_progress_init
Input:
| STRING | message | Message to use in the progress dialog |
| INT32 | gdisplay | GimpDisplay to update progressbar in, or -1 for a seperate window |
Returns: nothing
Initializes the progress bar for the current plug-in. It is only valid to call this procedure from a plug-in.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_progress_install
Input:
| STRING | progress_callback | The callback PDB proc to call |
Returns: nothing
This function installs a temporary PDB procedure which will handle all progress calls made by this plug-in and any procedure it calls. Calling this function multiple times simply replaces the old progress callbacks.
Michael Natterer; 2004
gimp_progress_pulse
Input: none
Returns: nothing
Updates the progress bar for the current plug-in. It is only valid to call this procedure from a plug-in. Use this function instead of gimp_progress_update() if you cannot tell how much progress has been made. This usually causes the the progress bar to enter "activity mode", where a block bounces back and forth.
Sven Neumann; 2005
gimp_progress_uninstall
Input:
| STRING | progress_callback | The name of the callback registered for this progress |
Returns: nothing
This function uninstalls any progress callback installed with gimp_progress_install() before.
Michael Natterer; 2004
gimp_progress_update
Input:
| SUCCESS | percentage | Percentage of progress completed which must be between 0.0 and 1.0 |
Returns: nothing
Updates the progress bar for the current plug-in. It is only valid to call this procedure from a plug-in.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_quit
Input:
| INT32 | force | Flag specifying whether to force the gimp to or exit normally |
Returns: nothing
The internal procedure which can either be used to make the gimp quit. If there are unsaved images in an interactive GIMP session, the user will be asked for confirmation. If force is TRUE, the application is quit without querying the user to save any dirty images.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_register_load_handler
Input:
| STRING | procedure_name | The name of the procedure to be used for loading |
| STRING | extensions | comma separated list of extensions this handler can load (i.e. "jpg,jpeg") |
| STRING | prefixes | comma separated list of prefixes this handler can load (i.e. "http:,ftp:") |
Returns: nothing
Registers a procedural database procedure to be called to load files of a particular file format.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_register_magic_load_handler
Input:
| STRING | procedure_name | The name of the procedure to be used for loading |
| STRING | extensions | comma separated list of extensions this handler can load (i.e. "jpg,jpeg") |
| STRING | prefixes | comma separated list of prefixes this handler can load (i.e. "http:,ftp:") |
| STRING | magics | comma separated list of magic file information this handler can load (i.e. "0,string,GIF") |
Returns: nothing
Registers a procedural database procedure to be called to load files of a particular file format using magic file information.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_register_save_handler
Input:
| STRING | procedure_name | The name of the procedure to be used for saving |
| STRING | extensions | comma separated list of extensions this handler can save (i.e. "jpg,jpeg") |
| STRING | prefixes | comma separated list of prefixes this handler can save (i.e. "http:,ftp:") |
Returns: nothing
Registers a procedural database procedure to be called to save files in a particular file format.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_register_thumbnail_loader
Input:
| STRING | load_proc | The name of the procedure the thumbnail loader with. |
| STRING | thumb_proc | The name of the thumbnail load procedure. |
Returns: nothing
Some file formats allow for embedded thumbnails, other file formats contain a scalable image or provide the image data in different resolutions. A file plug-in for such a format may register a special procedure that allows GIMP to load a thumbnail preview of the image. This procedure is then associated with the standard load procedure using this function.
Sven Neumann; 2004
gimp_rotate
Input:
| DRAWABLE | drawable | The affected drawable |
| INT32 | interpolation | Whether to use interpolation |
| SUCCESS | angle | The angle of rotation (radians) |
Returns:
| DRAWABLE | drawable | The rotated drawable |
This procedure is deprecated! Use 'gimp_drawable_transform_rotate_default' instead.
;
gimp_scale
Input:
| DRAWABLE | drawable | The affected drawable |
| INT32 | interpolation | Whether to use interpolation |
| SUCCESS | x0 | The new x coordinate of upper-left corner of newly scaled region |
| SUCCESS | y0 | The new y coordinate of upper-left corner of newly scaled region |
| SUCCESS | x1 | The new x coordinate of lower-right corner of newly scaled region |
| SUCCESS | y1 | The new y coordinate of lower-right corner of newly scaled region |
Returns:
| DRAWABLE | drawable | The scaled drawable |
This procedure is deprecated! Use 'gimp_drawable_transform_scale_default' instead.
;
gimp_shear
Input:
| DRAWABLE | drawable | The affected drawable |
| INT32 | interpolation | Whether to use interpolation |
| INT32 | shear_type | Type of shear: GIMP_ORIENTATION_HORIZONTAL (0) or GIMP_ORIENTATION_VERTICAL (1) |
| SUCCESS | magnitude | The magnitude of the shear |
Returns:
| DRAWABLE | drawable | The sheared drawable |
This procedure is deprecated! Use 'gimp_drawable_transform_shear_default' instead.
;
gimp_smudge
Input:
| DRAWABLE | drawable | The affected drawable |
| SUCCESS | pressure | The pressure of the smudge strokes (0 <= pressure <= 100) |
| INT32 | num_strokes | Number of stroke control points (count each coordinate as 2 points) |
| FLOATARRAY | strokes | Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y } |
Returns: nothing
This tool simulates a smudge using the current brush. High pressure results in a greater smudge of paint while low pressure results in a lesser smudge.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_smudge_default
Input:
| DRAWABLE | drawable | The affected drawable |
| INT32 | num_strokes | Number of stroke control points (count each coordinate as 2 points) |
| FLOATARRAY | strokes | Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y } |
Returns: nothing
This tool simulates a smudge using the current brush. It behaves exactly the same as gimp_smudge except that the pressure value is taken from the smudge tool options or the options default if the tools option dialog has not been activated.
Andy Thomas; 1999
gimp_temp_PDB_name
Input: none
Returns:
| STRING | temp_name | A unique temporary name for a temporary PDB entry |
This procedure is deprecated! Use 'gimp_procedural_db_temp_name' instead.
;
gimp_temp_name
Input:
| STRING | extension | The extension the file will have |
Returns:
| STRING | name | The new temp filename |
Generates a unique filename using the temp path supplied in the user's gimprc.
Josh MacDonald; 1997
gimp_threshold
Input:
| DRAWABLE | drawable | The drawable |
| INT32 | low_threshold | The low threshold value: 0 <= low_threshold <= 255 |
| INT32 | high_threshold | The high threshold value: 0 <= high_threshold <= 255 |
Returns: nothing
This procedures generates a threshold map of the specified drawable. All pixels between the values of 'low_threshold' and 'high_threshold' are replaced with white, and all other pixels with black.
Spencer Kimball & Peter Mattis; 1997
gimp_transform_2d
Input:
| DRAWABLE | drawable | The affected drawable |
| INT32 | interpolation | Whether to use interpolation |
| SUCCESS | source_x | X coordinate of the transformation center |
| SUCCESS | source_y | Y coordinate of the transformation center |
| SUCCESS | scale_x | Amount to scale in x direction |
| SUCCESS | scale_y | Amount to scale in y direction |
| SUCCESS | angle | The angle of rotation (radians) |
| SUCCESS | dest_x | X coordinate of where the centre goes |
| SUCCESS | dest_y | Y coordinate of where the centre goes |
Returns:
| DRAWABLE | drawable | The transformed drawable |
This procedure is deprecated! Use 'gimp_drawable_transform_2d_default' instead.
;
gimp_undo_push_group_end
Input:
| IMAGE | image | The ID of the image in which to close an undo group |
Returns: nothing
This procedure is deprecated! Use 'gimp_image_undo_group_end' instead.
;
gimp_undo_push_group_start
Input:
| IMAGE | image | The ID of the image in which to open an undo group |
Returns: nothing
This procedure is deprecated! Use 'gimp_image_undo_group_start' instead.
;
gimp_vectors_get_strokes
Input:
| PATH | vectors | The vectors object |
Returns:
| INT32 | num_strokes | The number of strokes returned. |
| INT32ARRAY | stroke_ids | List of the strokes belonging to the path. |
Returns an Array with the stroke-IDs associated with the passed path.
Simon Budig; 2005
gimp_vectors_stroke_interpolate
Input:
| PATH | vectors | The vectors object |
| INT32 | stroke_id | The stroke ID |
| SUCCESS | prescision | The prescision used for the approximation |
Returns:
| INT32 | closed | List of the strokes belonging to the path. |
| INT32 | num_coords | The number of floats returned. |
| FLOATARRAY | coords | List of the coords along the path (x0, y0, x1, y1, ...). |
returns polygonal approximation of the stroke.
Simon Budig; 2005
gimp_vectors_stroke_remove
Input:
| PATH | vectors | The vectors object |
| INT32 | stroke_id | The stroke ID |
Returns: nothing
Returns a lot of coordinates along the passed stroke.
Simon Budig; 2005
gimp_vectors_stroke_translate
Input:
| PATH | vectors | The vectors object |
| INT32 | stroke_id | The stroke ID |
| INT32 | offx | Offset in x direction |
| INT32 | offy | Offset in y direction |
Returns: nothing
Translate the given stroke.
Simon Budig; 2005
gimp_version
Input: none
Returns:
| STRING | version | The gimp version |
This procedure returns the version number of the currently running gimp.
Manish Singh; 1999
gimp_xcf_load
Input:
| INT32 | dummy_param | dummy parameter |
| STRING | filename | The name of the file to load, in the on-disk character set and encoding |
| STRING | raw_filename | The basename of the file, in UTF-8 |
Returns:
The xcf file format has been designed specifically for loading and saving tiled and layered images in the GIMP. This procedure will load the specified file.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_xcf_save
Input:
| INT32 | dummy_param | dummy parameter |
| IMAGE | image | Input image |
| DRAWABLE | drawable | Active drawable of input image |
| STRING | filename | The name of the file to save the image in, in the on-disk character set and encoding |
| STRING | raw_filename | The basename of the file, in UTF-8 |
Returns: nothing
The xcf file format has been designed specifically for loading and saving tiled and layered images in the GIMP. This procedure will save the specified image in the xcf file format.
Spencer Kimball & Peter Mattis; 1995-1996
magiceye
Input:
| INT32 | run_mode | Interactive, non-interactive |
| IMAGE | image | Input image (unused) |
| DRAWABLE | drawable | Input drawable |
| INT32 | mapimage | Map Image |
Returns:
| IMAGE | new_image | Output image |
| IMAGE | new_layer | Output layer |
Create a stereogram
Alexander Schulz; 1997
plug-in-closing
Input:
| INT32 | run_mode | Interactive or non-Interactive |
| IMAGE | image_id | (unused) |
| DRAWABLE | drawable_id | This is somplace to draw |
Returns: nothing
To use this function what you really need to do is have lots and lots of processor time to waste
GPL; Today
plug-in-dilate
Input:
| INT32 | run_mode | Interactive or non-Interactive |
| IMAGE | image_id | (unused) |
| DRAWABLE | drawable_id | This is somplace to draw |
Returns: nothing
To use this function what you really need to do is have lots of processor time to waste
GPL; Today
plug-in-erode
Input:
| INT32 | run_mode | Interactive or non-Interactive |
| IMAGE | image_id | (unused) |
| DRAWABLE | drawable_id | This is somplace to draw |
Returns: nothing
To use this function what you really need to do is have lots of processor time to waste
GPL; Today
plug-in-homogenizer
Input:
| INT32 | run_mode | Interactive, non-interactive |
| IMAGE | image | Input image |
| DRAWABLE | drawable | Input drawable |
| INT32 | xorder | X Order |
| INT32 | yorder | Y Order |
Returns: nothing
blurb repeated: Remove very low frequencies (eg gradients) in image
Paul Francis Harrison; 2000
plug-in-opening
Input:
| INT32 | run_mode | Interactive or non-Interactive |
| IMAGE | image_id | (unused) |
| DRAWABLE | drawable_id | This is somplace to draw |
Returns: nothing
To use this function what you really need to do is have lots and lots of processor time to waste
GPL; Today
temp_procedure_number_1
Input:
| INT32 | command | |
| STRING | text | |
| SUCCESS | value | |
Returns: nothing
blurb repeated: Temporary progress callback procedure
Michael Natterer; 2004
twain-acquire
Input:
| INT32 | run_mode | Interactive, non-interactive |
Returns:
| INT32 | image_count | Number of acquired images |
| INT32ARRAY | image_ids | Array of acquired image identifiers |
This plug-in will capture an image from a TWAIN datasource
Craig Setera; v0.6 (07/22/2004)
| The Gimp 2.3.2 (win32) | Documentation fresh from PDB | 22:53:16 Fr 22.07.2005 |
| Generated by pdb2doc.py written by Hans Breuer <Hans@Breuer.org> |