See also: Main Index; Alphabetic; Misc; By Author; By Module; By Menu External Links: The Gimp; Gimp User Manual

The Gimp image functions

gimp_drawable_get_image	Returns the drawable's image.
gimp_drawable_image	This procedure is deprecated! Use 'gimp_drawable_get_image' instead.
gimp_drawable_set_image	This procedure is deprecated!
gimp_image_active_drawable	This procedure is deprecated! Use 'gimp_image_get_active_drawable' instead.
gimp_image_add_channel	Add the specified channel to the image.
gimp_image_add_hguide	Add a horizontal guide to an image.
gimp_image_add_layer	Add the specified layer to the image.
gimp_image_add_layer_mask	This procedure is deprecated! Use 'gimp_layer_add_mask' instead.
gimp_image_add_vguide	Add a vertical guide to an image.
gimp_image_base_type	Get the base type of the image.
gimp_image_clean_all	Set the image dirty count to 0.
gimp_image_convert_grayscale	Convert specified image to grayscale (256 intensity levels)
gimp_image_convert_indexed	Convert specified image to and Indexed image
gimp_image_convert_rgb	Convert specified image to RGB color
gimp_image_crop	Crop the image to the specified extents.
gimp_image_delete	Delete the specified image.
gimp_image_delete_guide	Deletes a guide from an image.
gimp_image_duplicate	Duplicate the specified image
gimp_image_find_next_guide	Find next guide on an image.
gimp_image_flatten	Flatten all visible layers into a single layer. Discard all invisible layers.
gimp_image_flip	Flips the image horizontally or vertically.
gimp_image_floating_sel_attached_to	Return the drawable the floating selection is attached to.
gimp_image_floating_selection	This procedure is deprecated! Use 'gimp_image_get_floating_sel' instead.
gimp_image_free_shadow	Free the specified image's shadow data (if it exists).
gimp_image_get_active_channel	Returns the specified image's active channel.
gimp_image_get_active_drawable	Get the image's active drawable
gimp_image_get_active_layer	Returns the specified image's active layer.
gimp_image_get_channel_by_tattoo	Find a channel with a given tattoo in an image.
gimp_image_get_channels	Returns the list of channels contained in the specified image.
gimp_image_get_cmap	This procedure is deprecated! Use 'gimp_image_get_colormap' instead.
gimp_image_get_colormap	Returns the image's colormap
gimp_image_get_component_active	Returns if the specified image's image component is active.
gimp_image_get_component_visible	Returns if the specified image's image component is visible.
gimp_image_get_filename	Returns the specified image's filename.
gimp_image_get_floating_sel	Return the floating selection of the image.
gimp_image_get_guide_orientation	Get orientation of a guide on an image.
gimp_image_get_guide_position	Get position of a guide on an image.
gimp_image_get_layer_by_tattoo	Find a layer with a given tattoo in an image.
gimp_image_get_layers	Returns the list of layers contained in the specified image.
gimp_image_get_name	Returns the specified image's name.
gimp_image_get_resolution	Returns the specified image's resolution.
gimp_image_get_selection	Returns the specified image's selection.
gimp_image_get_tattoo_state	Returns the tattoo state associated with the image.
gimp_image_get_unit	Returns the specified image's unit.
gimp_image_get_vectors	Returns the list of vectors contained in the specified image.
gimp_image_height	Return the height of the image
gimp_image_is_dirty	Checks if the image has unsaved changes.
gimp_image_list	Returns the list of images currently open.
gimp_image_lower_channel	Lower the specified layer in the image's layer stack
gimp_image_lower_layer	Lower the specified layer in the image's layer stack
gimp_image_lower_layer_to_bottom	Lower the specified layer in the image's layer stack to bottom of stack
gimp_image_merge_down	Merge the layer passed and the first visible layer below.
gimp_image_merge_visible_layers	Merge the visible image layers into one.
gimp_image_new	Creates a new image with the specified width, height, and type.
gimp_image_parasite_attach	Add a parasite to an image.
gimp_image_parasite_detach	Removes a parasite from an image.
gimp_image_parasite_find	Finds the named parasite in an image
gimp_image_parasite_list	List all parasites.
gimp_image_pick_color	Determine the color at the given drawable coordinates
gimp_image_pick_correlate_layer	Find the layer visible at the specified coordinates.
gimp_image_raise_channel	Raise the specified channel in the image's channel stack
gimp_image_raise_layer	Raise the specified layer in the image's layer stack
gimp_image_raise_layer_to_top	Raise the specified layer in the image's layer stack to top of stack
gimp_image_remove_channel	Remove the specified channel from the image.
gimp_image_remove_layer	Remove the specified layer from the image.
gimp_image_remove_layer_mask	This procedure is deprecated! Use 'gimp_layer_remove_mask' instead.
gimp_image_resize	Resize the image to the specified extents.
gimp_image_resize_to_layers	Resize the image to fit all layers.
gimp_image_rotate	Rotates the image by the specified degrees.
gimp_image_scale	Scale the image to the specified extents.
gimp_image_set_active_channel	Sets the specified image's active channel.
gimp_image_set_active_layer	Sets the specified image's active layer.
gimp_image_set_cmap	This procedure is deprecated! Use 'gimp_image_set_colormap' instead.
gimp_image_set_colormap	Sets the entries in the image's colormap.
gimp_image_set_component_active	Sets if the specified image's image component is active.
gimp_image_set_component_visible	Sets if the specified image's image component is visible.
gimp_image_set_filename	Sets the specified image's filename.
gimp_image_set_resolution	Sets the specified image's resolution.
gimp_image_set_tattoo_state	Set the tattoo state associated with the image.
gimp_image_set_unit	Sets the specified image's unit.
gimp_image_thumbnail	Get a thumbnail of an image.
gimp_image_undo_disable	Disable the image's undo stack.
gimp_image_undo_enable	Enable the image's undo stack.
gimp_image_undo_freeze	Freeze the image's undo stack.
gimp_image_undo_group_end	Finish a group undo.
gimp_image_undo_group_start	Starts a group undo.
gimp_image_undo_is_enabled	Check if the image's undo stack is enabled.
gimp_image_undo_thaw	Thaw the image's undo stack.
gimp_image_unset_active_channel	Unsets the active channel in the specified image.
gimp_image_width	Return the width of the image
gimp_layer_resize_to_image_size	Resize a layer to the image size.
plug_in_imagemap	Creates a clickable imagemap.

gimp_image_add_hguide

Input:

IMAGE	image	The image
INT32	yposition	The guide's y-offset from top of image

Returns:

INT32

guide

The new guide

This procedure adds a horizontal guide to an image. It takes the input image and the y-position of the new guide as parameters. It returns the guide ID of the new guide.
Adam D. Moss; 1998

gimp_image_add_vguide

Input:

IMAGE	image	The image
INT32	xposition	The guide's x-offset from left of image

Returns:

INT32

guide

The new guide

This procedure adds a vertical guide to an image. It takes the input image and the x-position of the new guide as parameters. It returns the guide ID of the new guide.
Adam D. Moss; 1998

gimp_image_base_type

Input:

IMAGE

image

The image

Returns:

INT32

base_type

The image's base type: { GIMP_RGB (0), GIMP_GRAY (1), GIMP_INDEXED (2) }

This procedure returns the image's base type. Layers in the image must be of this subtype, but can have an optional alpha channel.
Spencer Kimball & Peter Mattis; 1995-1996

Returns: nothing
This procedure sets the specified image's dirty count to 0, allowing operations to occur without having a 'dirtied' image. This is especially useful for creating and loading images which should not initially be considered dirty, even though layers must be created, filled, and installed in the image.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_convert_grayscale

Input:

IMAGE

image

The image

Returns: nothing
This procedure converts the specified image to grayscale with 8 bits per pixel (256 intensity levels). This process requires an image of type GIMP_RGB or GIMP_INDEXED.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_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 converts the specified image to 'indexed' color. This process requires an image of type GIMP_GRAY or GIMP_RGB. The 'palette_type' specifies what kind of palette to use, A type of '0' means to use an optimal palette of 'num_cols' generated from the colors in the image. A type of '1' means to re-use the previous palette (not currently implemented). A type of '2' means to use the so-called WWW-optimized palette. Type '3' means to use only black and white colors. A type of '4' means to use a palette from the gimp palettes directories. The 'dither type' specifies what kind of dithering to use. '0' means no dithering, '1' means standard Floyd-Steinberg error diffusion, '2' means Floyd-Steinberg error diffusion with reduced bleeding, '3' means dithering based on pixel location ('Fixed' dithering).
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_convert_rgb

Input:

IMAGE

image

The image

Returns: nothing
This procedure converts the specified image to RGB color. This process requires an image of type GIMP_GRAY or GIMP_INDEXED. No image content is lost in this process aside from the colormap for an indexed image.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_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 crops the image so that it's new width and height are equal to the supplied parameters. Offsets are also provided which describe the position of the previous image's content. All channels and layers within the image are cropped to the new image extents; this includes the image selection mask. If any parameters are out of range, an error is returned.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_delete

Input:

IMAGE

image

The image

Returns: nothing
If there are no displays associated with this image it will be deleted. This means that you can not delete an image through the PDB that was created by the user. If the associated display was however created through the PDB and you know the display ID, you may delete the display. Removal of the last associated display will then delete the image.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_delete_guide

Input:

IMAGE	image	The image
INT32	guide	The ID of the guide to be removed

Returns: nothing
This procedure takes an image and a guide ID as input and removes the specified guide from the specified image.
Adam D. Moss; 1998

gimp_image_duplicate

Input:

IMAGE

image

The image

Returns:

IMAGE

new_image

The new, duplicated image

This procedure duplicates the specified image, copying all layers, channels, and image information.
Spencer Kimball & Peter Mattis; 1997

gimp_image_find_next_guide

Input:

IMAGE	image	The image
INT32	guide	The ID of the current guide (0 if first invocation)

Returns:

INT32

next_guide

The next guide's ID

This procedure takes an image and a guide ID as input and finds the guide ID of the successor of the given guide ID in the image's guide list. If the supplied guide ID is 0, the procedure will return the first Guide. The procedure will return 0 if given the final guide ID as an argument or the image has no guides.
Adam D. Moss; 1998

gimp_image_flatten

Input:

IMAGE

image

The image

Returns:

LAYER

layer

The resulting layer

This procedure combines the visible layers in a manner analogous to merging with the CLIP_TO_IMAGE merge type. Non-visible layers are discarded, and the resulting image is stripped of its alpha channel.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_flip

Input:

IMAGE	image	The image
INT32	flip_type	Type of flip: GIMP_ORIENTATION_HORIZONTAL (0) or GIMP_ORIENTATION_VERTICAL (1)

Returns: nothing
This procedure flips (mirrors) the image.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_floating_sel_attached_to

Input:

IMAGE

image

The image

Returns:

DRAWABLE

drawable

The drawable the floating selection is attached to

This procedure returns the drawable the image's floating selection is attached to, if it exists. If it doesn't exist, -1 is returned as the drawable ID.
Wolfgang Hofer; 1998

gimp_image_floating_selection

Input:

IMAGE

image

The image

Returns:

LAYER

floating_sel

The image's floating selection

This procedure is deprecated! Use 'gimp_image_get_floating_sel' instead.
;

gimp_image_free_shadow

Input:

IMAGE

image

The image

Returns: nothing
This procedure is intended as a memory saving device. If any shadow memory has been allocated, it will be freed automatically on a call to 'gimp_image_delete'.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_get_cmap

Input:

IMAGE

image

The image

Returns:

INT32	num_bytes	Number of bytes in the colormap array: 0 < num_bytes
INT8ARRAY	colormap	The image's colormap

This procedure is deprecated! Use 'gimp_image_get_colormap' instead.
;

gimp_image_get_colormap

Input:

IMAGE

image

The image

Returns:

INT32	num_bytes	Number of bytes in the colormap array: 0 < num_bytes
INT8ARRAY	colormap	The image's colormap

This procedure returns an actual pointer to the image's colormap, as well as the number of bytes contained in the colormap. The actual number of colors in the transmitted colormap will be "num_bytes" / 3. If the image is not of base type GIMP_INDEXED, this pointer will be NULL.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_get_component_active

Input:

IMAGE	image	The image
INT32	component	The image component: { GIMP_RED_CHANNEL (0), GIMP_GREEN_CHANNEL (1), GIMP_BLUE_CHANNEL (2), GIMP_GRAY_CHANNEL (3), GIMP_INDEXED_CHANNEL (4), GIMP_ALPHA_CHANNEL (5) }

Returns:

INT32

active

Component is active (TRUE or FALSE)

This procedure returns if the specified image's image component (i.e. Red, Green, Blue intensity channels in an RGB image) is active or inactive -- whether or not it can be modified. If the specified component is not valid for the image type, an error is returned.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_get_component_visible

Input:

IMAGE	image	The image
INT32	component	The image component: { GIMP_RED_CHANNEL (0), GIMP_GREEN_CHANNEL (1), GIMP_BLUE_CHANNEL (2), GIMP_GRAY_CHANNEL (3), GIMP_INDEXED_CHANNEL (4), GIMP_ALPHA_CHANNEL (5) }

Returns:

INT32

visible

Component is visible (TRUE or FALSE)

This procedure returns if the specified image's image component (i.e. Red, Green, Blue intensity channels in an RGB image) is visible or invisible -- whether or not it can be seen. If the specified component is not valid for the image type, an error is returned.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_get_filename

Input:

IMAGE

image

The image

Returns:

STRING

filename

The filename

This procedure returns the specified image's filename in the filesystem encoding. The image has a filename only if it was loaded or has since been saved. Otherwise, this function returns %NULL.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_get_floating_sel

Input:

IMAGE

image

The image

Returns:

LAYER

floating_sel

The image's floating selection

This procedure returns the image's floating selection, if it exists. If it doesn't exist, -1 is returned as the layer ID.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_get_guide_orientation

Input:

IMAGE	image	The image
INT32	guide	The guide

Returns:

INT32

orientation

The guide's orientation: { GIMP_ORIENTATION_HORIZONTAL (0), GIMP_ORIENTATION_VERTICAL (1) }

This procedure takes an image and a guide ID as input and returns the orientations of the guide.
Adam D. Moss; 1998

gimp_image_get_guide_position

Input:

IMAGE	image	The image
INT32	guide	The guide

Returns:

INT32

position

The guide's position relative to top or left of image

This procedure takes an image and a guide ID as input and returns the position of the guide relative to the top or left of the image.
Adam D. Moss; 1998

gimp_image_get_name

Input:

IMAGE

image

The image

Returns:

STRING

name

The name

This procedure returns the specified image's name.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_get_resolution

Input:

IMAGE

image

The image

Returns:

SUCCESS	xresolution	The resolutionin the x-axis, in dots per inch
SUCCESS	yresolution	The resolutionin the y-axis, in dots per inch

This procedure returns the specified image's resolution in dots per inch. This value is independent of any of the layers in this image.
Austin Donnelly; 1998

gimp_image_get_selection

Input:

IMAGE

image

The image

Returns:

SELECTION

selection

The selection channel

This will always return a valid ID for a selection -- which is represented as a channel internally.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_get_tattoo_state

Input:

IMAGE

image

The image

Returns:

INT32

tattoo_state

The tattoo_state

This procedure returns the tattoo state of the image. Use only by save/load plugins that wish to preserve an images tattoo state. Using this function at other times will produce unexpected results.
Andy Thomas; 2000

gimp_image_get_vectors

Input:

IMAGE

image

The image

Returns:

INT32	num_vectors	The number of vectors contained in the image
INT32ARRAY	vector_ids	The list of vectors contained in the image

This procedure returns the list of vectors contained in the specified image.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_height

Input:

IMAGE

image

The image

Returns:

INT32

height

The image's height

This procedure returns the image's height. This value is independent of any of the layers in this image. This is the "canvas" height.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_is_dirty

Input:

IMAGE

image

The image

Returns:

INT32

dirty

True if the image has unsaved changes.

This procedure checks the specified image's dirty count to see if it needs to be saved.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_list

Input: none
Returns:

INT32	num_images	The number of images currently open
INT32ARRAY	image_ids	The list of images currently open

This procedure returns the list of images currently open in the GIMP.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_merge_down

Input:

IMAGE	image	The image
LAYER	merge_layer	The layer to merge down from
INT32	merge_type	The type of merge: { GIMP_EXPAND_AS_NECESSARY (0), GIMP_CLIP_TO_IMAGE (1), GIMP_CLIP_TO_BOTTOM_LAYER (2) }

Returns:

LAYER

layer

The resulting layer

This procedure combines the passed layer and the first visible layer below it using the specified merge type. A merge type of EXPAND_AS_NECESSARY expands the final layer to encompass the areas of the visible layers. A merge type of CLIP_TO_IMAGE clips the final layer to the extents of the image. A merge type of CLIP_TO_BOTTOM_LAYER clips the final layer to the size of the bottommost layer.
Larry Ewing; 1998

gimp_image_new

Input:

INT32	width	The width of the image
INT32	height	The height of the image
INT32	type	The type of image: { GIMP_RGB (0), GIMP_GRAY (1), GIMP_INDEXED (2) }

Returns:

IMAGE

image

The ID of the newly created image

Creates a new image, undisplayed with the specified extents and type. A layer should be created and added before this image is displayed, or subsequent calls to 'gimp_display_new' with this image as an argument will fail. Layers can be created using the 'gimp_layer_new' commands. They can be added to an image using the 'gimp_image_add_layer' command.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_pick_color

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 tool determines the color at the specified coordinates. The returned color is an RGB triplet even for grayscale and indexed drawables. If the coordinates lie outside of the extents of the specified drawable, then an error is returned. If the drawable has an alpha channel, the algorithm examines the alpha value of the drawable at the coordinates. If the alpha value is completely transparent (0), then an error is returned. 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 a merged sampling, the supplied drawable is ignored except for finding the image it belongs to.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_resize

Input:

IMAGE	image	The image
INT32	new_width	New image width: 0 < new_width
INT32	new_height	New image height: 0 < new_height
INT32	offx	x offset between upper left corner of old and new images: (new - old)
INT32	offy	y offset between upper left corner of old and new images: (new - old)

Returns: nothing
This procedure resizes the image so that it's new width and height are equal to the supplied parameters. Offsets are also provided which describe the position of the previous image's content. No bounds checking is currently provided, so don't supply parameters that are out of bounds. All channels within the image are resized according to the specified parameters; this includes the image selection mask. All layers within the image are repositioned according to the specified offsets.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_rotate

Input:

IMAGE	image	The image
INT32	rotate_type	Angle of rotation: GIMP_ROTATE_90 (0), GIMP_ROTATE_180 (1), GIMP_ROTATE_270 (2)

Returns: nothing
This procedure rotates the image.
Michael Natterer; 2003

gimp_image_scale

Input:

IMAGE	image	The image
INT32	new_width	New image width: 0 < new_width
INT32	new_height	New image height: 0 < new_height

Returns: nothing
This procedure scales the image so that its new width and height are equal to the supplied parameters. Offsets are also provided which describe the position of the previous image's content. No bounds checking is currently provided, so don't supply parameters that are out of bounds. All channels within the image are scaled according to the specified parameters; this includes the image selection mask. All layers within the image are repositioned according to the specified offsets.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_set_cmap

Input:

IMAGE	image	The image
INT32	num_bytes	Number of bytes in the colormap array: 0 <= num_bytes <= 768
INT8ARRAY	colormap	The new colormap values

Returns: nothing
This procedure is deprecated! Use 'gimp_image_set_colormap' instead.
;

gimp_image_set_colormap

Input:

IMAGE	image	The image
INT32	num_bytes	Number of bytes in the colormap array: 0 <= num_bytes <= 768
INT8ARRAY	colormap	The new colormap values

Returns: nothing
This procedure sets the entries in the specified image's colormap. The number of entries is specified by the "num_bytes" parameter and corresponds to the number of INT8 triples that must be contained in the "colormap" array. The actual number of colors in the transmitted colormap is "num_bytes" / 3.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_set_component_active

Input:

IMAGE	image	The image
INT32	component	The image component: { GIMP_RED_CHANNEL (0), GIMP_GREEN_CHANNEL (1), GIMP_BLUE_CHANNEL (2), GIMP_GRAY_CHANNEL (3), GIMP_INDEXED_CHANNEL (4), GIMP_ALPHA_CHANNEL (5) }
INT32	active	Component is active (TRUE or FALSE)

Returns: nothing
This procedure sets if the specified image's image component (i.e. Red, Green, Blue intensity channels in an RGB image) is active or inactive -- whether or not it can be modified. If the specified component is not valid for the image type, an error is returned.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_set_component_visible

Input:

IMAGE	image	The image
INT32	component	The image component: { GIMP_RED_CHANNEL (0), GIMP_GREEN_CHANNEL (1), GIMP_BLUE_CHANNEL (2), GIMP_GRAY_CHANNEL (3), GIMP_INDEXED_CHANNEL (4), GIMP_ALPHA_CHANNEL (5) }
INT32	visible	Component is visible (TRUE or FALSE)

Returns: nothing
This procedure sets if the specified image's image component (i.e. Red, Green, Blue intensity channels in an RGB image) is visible or invisible -- whether or not it can be seen. If the specified component is not valid for the image type, an error is returned.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_set_filename

Input:

IMAGE	image	The image
STRING	filename	The new image filename

Returns: nothing
This procedure sets the specified image's filename. The filename should be in the filesystem encoding.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_set_resolution

Input:

IMAGE	image	The image
SUCCESS	xresolution	The new image resolution (xresolution)in the x-axis, in dots per inch
SUCCESS	yresolution	The new image resolution (yresolution)in the y-axis, in dots per inch

Returns: nothing
This procedure sets the specified image's resolution in dots per inch. This value is independent of any of the layers in this image. No scaling or resizing is performed.
Austin Donnelly; 1998

gimp_image_set_tattoo_state

Input:

IMAGE	image	The image
INT32	tattoo_state	The new image tattoo_state

Returns: nothing
This procedure sets the tattoo state of the image. Use only by save/load plugins that wish to preserve an images tattoo state. Using this function at other times will produce unexpected results. A full check of uniqueness of states in layers, channels and paths will be performed by this procedure and a execution failure will be returned if this fails. A failure will also be returned if the new tattoo state value is less than the maximum tattoo value from all of the tattoos from the paths, layers and channels. After the image data has been loaded and all the tattoos have been set then this is the last procedure that should be called. If effectively does a status check on the tattoo values that have been set to make sure that all is OK.
Andy Thomas; 2000

gimp_image_thumbnail

Input:

IMAGE	image	The image
INT32	width	The thumbnail width
INT32	height	The thumbnail height

Returns:

INT32	width	The previews width
INT32	height	The previews height
INT32	bpp	The previews bpp
INT32	thumbnail_data_count	The number of bytes in thumbnail data
INT8ARRAY	thumbnail_data	The thumbnail data

This function gets data from which a thumbnail of an image preview can be created. Maximum x or y dimension is 1024 pixels. The pixels are returned in RGB[A] or GRAY[A] format. The bpp return value gives the number of bits per pixel in the image.
Andy Thomas; 1999

gimp_image_undo_disable

Input:

IMAGE

image

The image

Returns:

INT32

disabled

True if the image undo has been disabled

This procedure disables the image's undo stack, allowing subsequent operations to ignore their undo steps. This is generally called in conjunction with 'gimp_image_undo_enable' to temporarily disable an image undo stack. This is advantageous because saving undo steps can be time and memory intensive.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_undo_enable

Input:

IMAGE

image

The image

Returns:

INT32

enabled

True if the image undo has been enabled

This procedure enables the image's undo stack, allowing subsequent operations to store their undo steps. This is generally called in conjunction with 'gimp_image_undo_disable' to temporarily disable an image undo stack.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_image_undo_freeze

Input:

IMAGE

image

The image

Returns:

INT32

frozen

True if the image undo has been frozen

This procedure freezes the image's undo stack, allowing subsequent operations to ignore their undo steps. This is generally called in conjunction with 'gimp_image_undo_thaw' to temporarily disable an image undo stack. This is advantageous because saving undo steps can be time and memory intensive. 'gimp_image_undo_{freeze,thaw}' and 'gimp_image_undo_{disable,enable}' differ in that the former does not free up all undo steps when undo is thawed, so is more suited to interactive in-situ previews. It is important in this case that the image is back to the same state it was frozen in before thawing, else 'undo' behaviour is undefined.
Adam D. Moss; 1999

gimp_image_undo_group_end

Input:

IMAGE

image

The ID of the image in which to close an undo group

Returns: nothing
This function must be called once for each 'gimp-image-undo-group-start' call that is made.
Spencer Kimball & Peter Mattis; 1997

gimp_image_undo_group_start

Input:

IMAGE

image

The ID of the image in which to open an undo group

Returns: nothing
This function is used to start a group undo--necessary for logically combining two or more undo operations into a single operation. This call must be used in conjunction with a 'gimp-image-undo-group-end' call.
Spencer Kimball & Peter Mattis; 1997

gimp_image_undo_is_enabled

Input:

IMAGE

image

The image

Returns:

INT32

enabled

True if undo is enabled for this image

This procedure checks if the image's undo stack is currently enabled or disabled. This is useful when several plugins or scripts call each other and want to check if their caller has already used 'gimp_image_undo_disable' or 'gimp_image_undo_freeze'.
Raphael Quinet; 1999

gimp_image_undo_thaw

Input:

IMAGE

image

The image

Returns:

INT32

thawed

True if the image undo has been thawed

This procedure thaws the image's undo stack, allowing subsequent operations to store their undo steps. This is generally called in conjunction with 'gimp_image_undo_freeze' to temporarily freeze an image undo stack. 'gimp_image_undo_thaw' does NOT free the undo stack as 'gimp_image_undo_enable' does, so is suited for situations where one wishes to leave the undo stack in the same state in which one found it despite non-destructively playing with the image in the meantime. An example would be in-situ plugin previews. Balancing freezes and thaws and ensuring image consistancy is the responsibility of the caller.
Adam D. Moss; 1999

gimp_image_width

Input:

IMAGE

image

The image

Returns:

INT32

width

The image's width

This procedure returns the image's width. This value is independent of any of the layers in this image. This is the "canvas" width.
Spencer Kimball & Peter Mattis; 1995-1996

plug_in_imagemap

Input:

INT32	run_mode	Interactive
IMAGE	image	Input image (unused)
DRAWABLE	drawable	Input drawable

Returns: nothing
blurb repeated: Creates a clickable imagemap.
Maurits Rijk; 1998-2005

The Gimp 2.3.2 (win32)	Documentation fresh from PDB	22:53:15 Fr 22.07.2005
Generated by pdb2doc.py* written by Hans Breuer <Hans@Breuer.org>*