gimpimage

## gimpimage gimpimage — Operations on complete images. |

## Synopsis

    gint*               gimp_image_list                     (gint *num_images);
    gint32              gimp_image_new                      (gint width,
                                                             gint height,
                                                             GimpImageBaseType type);
    gint32              gimp_image_duplicate                (gint32 image_ID);
    gboolean            gimp_image_delete                   (gint32 image_ID);
    gboolean            gimp_image_is_valid                 (gint32 image_ID);
    GimpImageBaseType   gimp_image_base_type                (gint32 image_ID);
    gint                gimp_image_width                    (gint32 image_ID);
    gint                gimp_image_height                   (gint32 image_ID);
    gboolean            gimp_image_free_shadow              (gint32 image_ID);
    gboolean            gimp_image_flip                     (gint32 image_ID,
                                                             GimpOrientationType flip_type);
    gboolean            gimp_image_rotate                   (gint32 image_ID,
                                                             GimpRotationType rotate_type);
    gboolean            gimp_image_resize                   (gint32 image_ID,
                                                             gint new_width,
                                                             gint new_height,
                                                             gint offx,
                                                             gint offy);
    gboolean            gimp_image_resize_to_layers         (gint32 image_ID);
    gboolean            gimp_image_scale                    (gint32 image_ID,
                                                             gint new_width,
                                                             gint new_height);
    gboolean            gimp_image_scale_full               (gint32 image_ID,
                                                             gint new_width,
                                                             gint new_height,
                                                             GimpInterpolationType interpolation);
    gboolean            gimp_image_crop                     (gint32 image_ID,
                                                             gint new_width,
                                                             gint new_height,
                                                             gint offx,
                                                             gint offy);
    gint*               gimp_image_get_layers               (gint32 image_ID,
                                                             gint *num_layers);
    gint*               gimp_image_get_channels             (gint32 image_ID,
                                                             gint *num_channels);
    gint32              gimp_image_get_active_drawable      (gint32 image_ID);
    gint32              gimp_image_get_floating_sel         (gint32 image_ID);
    gint32              gimp_image_floating_sel_attached_to (gint32 image_ID);
    gboolean            gimp_image_pick_color               (gint32 image_ID,
                                                             gint32 drawable_ID,
                                                             gdouble x,
                                                             gdouble y,
                                                             gboolean sample_merged,
                                                             gboolean sample_average,
                                                             gdouble average_radius,
                                                             GimpRGB *color);
    gint32              gimp_image_pick_correlate_layer     (gint32 image_ID,
                                                             gint x,
                                                             gint y);
    gboolean            gimp_image_add_layer                (gint32 image_ID,
                                                             gint32 layer_ID,
                                                             gint position);
    gboolean            gimp_image_remove_layer             (gint32 image_ID,
                                                             gint32 layer_ID);
    gboolean            gimp_image_raise_layer              (gint32 image_ID,
                                                             gint32 layer_ID);
    gboolean            gimp_image_lower_layer              (gint32 image_ID,
                                                             gint32 layer_ID);
    gboolean            gimp_image_raise_layer_to_top       (gint32 image_ID,
                                                             gint32 layer_ID);
    gboolean            gimp_image_lower_layer_to_bottom    (gint32 image_ID,
                                                             gint32 layer_ID);
    gint                gimp_image_get_layer_position       (gint32 image_ID,
                                                             gint32 layer_ID);
    gboolean            gimp_image_add_channel              (gint32 image_ID,
                                                             gint32 channel_ID,
                                                             gint position);
    gboolean            gimp_image_remove_channel           (gint32 image_ID,
                                                             gint32 channel_ID);
    gboolean            gimp_image_raise_channel            (gint32 image_ID,
                                                             gint32 channel_ID);
    gboolean            gimp_image_lower_channel            (gint32 image_ID,
                                                             gint32 channel_ID);
    gint                gimp_image_get_channel_position     (gint32 image_ID,
                                                             gint32 channel_ID);
    gint32              gimp_image_flatten                  (gint32 image_ID);
    gint32              gimp_image_merge_visible_layers     (gint32 image_ID,
                                                             GimpMergeType merge_type);
    gint32              gimp_image_merge_down               (gint32 image_ID,
                                                             gint32 merge_layer_ID,
                                                             GimpMergeType merge_type);
    gboolean            gimp_image_clean_all                (gint32 image_ID);
    gboolean            gimp_image_is_dirty                 (gint32 image_ID);
    gint32              gimp_image_get_active_layer         (gint32 image_ID);
    gboolean            gimp_image_set_active_layer         (gint32 image_ID,
                                                             gint32 active_layer_ID);
    gint32              gimp_image_get_active_channel       (gint32 image_ID);
    gboolean            gimp_image_set_active_channel       (gint32 image_ID,
                                                             gint32 active_channel_ID);
    gboolean            gimp_image_unset_active_channel     (gint32 image_ID);
    gint32              gimp_image_get_selection            (gint32 image_ID);
    gboolean            gimp_image_get_component_active     (gint32 image_ID,
                                                             GimpChannelType component);
    gboolean            gimp_image_set_component_active     (gint32 image_ID,
                                                             GimpChannelType component,
                                                             gboolean active);
    gboolean            gimp_image_get_component_visible    (gint32 image_ID,
                                                             GimpChannelType component);
    gboolean            gimp_image_set_component_visible    (gint32 image_ID,
                                                             GimpChannelType component,
                                                             gboolean visible);
    gchar*              gimp_image_get_filename             (gint32 image_ID);
    gboolean            gimp_image_set_filename             (gint32 image_ID,
                                                             const gchar *filename);
    gchar*              gimp_image_get_name                 (gint32 image_ID);
    gboolean            gimp_image_get_resolution           (gint32 image_ID,
                                                             gdouble *xresolution,
                                                             gdouble *yresolution);
    gboolean            gimp_image_set_resolution           (gint32 image_ID,
                                                             gdouble xresolution,
                                                             gdouble yresolution);
    GimpUnit            gimp_image_get_unit                 (gint32 image_ID);
    gboolean            gimp_image_set_unit                 (gint32 image_ID,
                                                             GimpUnit unit);
    gboolean            gimp_image_set_tattoo_state         (gint32 image_ID,
                                                             gint tattoo_state);
    gint                gimp_image_get_tattoo_state         (gint32 image_ID);
    gint32              gimp_image_get_layer_by_tattoo      (gint32 image_ID,
                                                             gint tattoo);
    gint32              gimp_image_get_channel_by_tattoo    (gint32 image_ID,
                                                             gint tattoo);
    guchar *            gimp_image_get_cmap                 (gint32 image_ID,
                                                             gint *num_colors);
    gboolean            gimp_image_set_cmap                 (gint32 image_ID,
                                                             const guchar *cmap,
                                                             gint num_colors);
    guchar *            gimp_image_get_colormap             (gint32 image_ID,
                                                             gint *num_colors);
    gboolean            gimp_image_set_colormap             (gint32 image_ID,
                                                             const guchar *colormap,
                                                             gint num_colors);
    gint*               gimp_image_get_vectors              (gint32 image_ID,
                                                             gint *num_vectors);
    gint32              gimp_image_get_vectors_by_tattoo    (gint32 image_ID,
                                                             gint tattoo);
    guchar *            gimp_image_get_thumbnail_data       (gint32 image_ID,
                                                             gint *width,
                                                             gint *height,
                                                             gint *bpp);
    GimpParasite*       gimp_image_parasite_find            (gint32 image_ID,
                                                             const gchar *name);
    gboolean            gimp_image_parasite_list            (gint32 image_ID,
                                                             gint *num_parasites,
                                                             gchar ***parasites);
    gboolean            gimp_image_parasite_attach          (gint32 image_ID,
                                                             const GimpParasite *parasite);
    gboolean            gimp_image_parasite_detach          (gint32 image_ID,
                                                             const gchar *name);
    gboolean            gimp_image_attach_new_parasite      (gint32 image_ID,
                                                             const gchar *name,
                                                             gint flags,
                                                             gint size,
                                                             gconstpointer data);
    gboolean            gimp_image_add_vectors              (gint32 image_ID,
                                                             gint32 vectors_ID,
                                                             gint position);
    gboolean            gimp_image_remove_vectors           (gint32 image_ID,
                                                             gint32 vectors_ID);
    gint32              gimp_image_get_active_vectors       (gint32 image_ID);
    gboolean            gimp_image_set_active_vectors       (gint32 image_ID,
                                                             gint32 active_vectors_ID);
    gboolean            gimp_image_lower_vectors            (gint32 image_ID,
                                                             gint32 vectors_ID);
    gboolean            gimp_image_raise_vectors            (gint32 image_ID,
                                                             gint32 vectors_ID);
    gboolean            gimp_image_lower_vectors_to_bottom  (gint32 image_ID,
                                                             gint32 vectors_ID);
    gboolean            gimp_image_raise_vectors_to_top     (gint32 image_ID,
                                                             gint32 vectors_ID);
    gint                gimp_image_get_vectors_position     (gint32 image_ID,
                                                             gint32 vectors_ID);

## Description

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

## Details

### gimp_image_list ()

    gint*               gimp_image_list                     (gint *num_images);

Returns the list of images currently open.

This procedure returns the list of images currently open in GIMP.

`num_images` : | The number of images currently open.
Returns : | The list of images currently open.

### gimp_image_new ()

    gint32              gimp_image_new                      (gint width,
                                                             gint height,
                                                             GimpImageBaseType type);

Creates a new image with the specified width, height, and type.

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.

`width` : | The width of the image.
`height` : | The height of the image.
`type` : | The type of image.
Returns : | The ID of the newly created image.

### gimp_image_duplicate ()

    gint32              gimp_image_duplicate                (gint32 image_ID);

Duplicate the specified image

This procedure duplicates the specified image, copying all layers, channels, and image information.

`image_ID` : | The image.
Returns : | The new, duplicated image.

### gimp_image_delete ()

    gboolean            gimp_image_delete                   (gint32 image_ID);

Delete the specified image.

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.

`image_ID` : | The image.
Returns : | TRUE on success.

### gimp_image_is_valid ()

    gboolean            gimp_image_is_valid                 (gint32 image_ID);

Returns TRUE if the image is valid.

This procedure checks if the given image ID is valid and refers to an existing image.

`image_ID` : | The image to check.
Returns : | Whether the image ID is valid.

Since GIMP 2.4

### gimp_image_base_type ()

    GimpImageBaseType   gimp_image_base_type                (gint32 image_ID);

Get the base type of the image.

This procedure returns the image's base type. Layers in the image must be of this subtype, but can have an optional alpha channel.

`image_ID` : | The image.
Returns : | The image's base type.

### gimp_image_width ()

    gint                gimp_image_width                    (gint32 image_ID);

Return the width of the image

This procedure returns the image's width. This value is independent of any of the layers in this image. This is the \"canvas\" width.

`image_ID` : | The image.
Returns : | The image's width.

### gimp_image_height ()

    gint                gimp_image_height                   (gint32 image_ID);

Return the height of the image

This procedure returns the image's height. This value is independent of any of the layers in this image. This is the \"canvas\" height.

`image_ID` : | The image.
Returns : | The image's height.

### gimp_image_free_shadow ()

    gboolean            gimp_image_free_shadow              (gint32 image_ID);

### Warning

`gimp_image_free_shadow` is deprecated and should not be used in newly-written code.

This procedure is deprecated! Use `gimp_drawable_free_shadow()` instead.

`image_ID` : | The image.
Returns : | TRUE on success.

### gimp_image_flip ()

    gboolean            gimp_image_flip                     (gint32 image_ID,
                                                             GimpOrientationType flip_type);

Flips the image horizontally or vertically.

This procedure flips (mirrors) the image.

`image_ID` : | The image.
`flip_type` : | Type of flip.
Returns : | TRUE on success.

### gimp_image_rotate ()

    gboolean            gimp_image_rotate                   (gint32 image_ID,
                                                             GimpRotationType rotate_type);

Rotates the image by the specified degrees.

This procedure rotates the image.

`image_ID` : | The image.
`rotate_type` : | Angle of rotation.
Returns : | TRUE on success.

### gimp_image_resize ()

    gboolean            gimp_image_resize                   (gint32 image_ID,
                                                             gint new_width,
                                                             gint new_height,
                                                             gint offx,
                                                             gint offy);

Resize the image to the specified extents.

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. 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.

`image_ID` : | The image.
`new_width` : | New image width.
`new_height` : | New image height.
`offx` : | x offset between upper left corner of old and new images: (new - old).
`offy` : | y offset between upper left corner of old and new images: (new - old).
Returns : | TRUE on success.

### gimp_image_resize_to_layers ()

    gboolean            gimp_image_resize_to_layers         (gint32 image_ID);

Resize the image to fit all layers.

This procedure resizes the image to the bounding box of all layers of the image. All channels within the image are resized to the new size; this includes the image selection mask. All layers within the image are repositioned to the new image area.

`image_ID` : | The image.
Returns : | TRUE on success.

Since GIMP 2.2

### gimp_image_scale ()

    gboolean            gimp_image_scale                    (gint32 image_ID,
                                                             gint new_width,
                                                             gint new_height);

Scale the image using the default interpolation method.

This procedure scales the image so that its new width and height are equal to the supplied parameters. All layers and channels within the image are scaled according to the specified parameters; this includes the image selection mask. The default interpolation method is used.

`image_ID` : | The image.
`new_width` : | New image width.
`new_height` : | New image height.
Returns : | TRUE on success.

### gimp_image_scale_full ()

    gboolean            gimp_image_scale_full               (gint32 image_ID,
                                                             gint new_width,
                                                             gint new_height,
                                                             GimpInterpolationType interpolation);

Scale the image using a specific interpolation method.

This procedure scales the image so that its new width and height are equal to the supplied parameters. All layers and channels within the image are scaled according to the specified parameters; this includes the image selection mask. This procedure allows you to specify the interpolation method explicitly.

`image_ID` : | The image.
`new_width` : | New image width.
`new_height` : | New image height.
`interpolation` : | Type of interpolation.
Returns : | TRUE on success.

Since GIMP 2.6

### gimp_image_crop ()

    gboolean            gimp_image_crop                     (gint32 image_ID,
                                                             gint new_width,
                                                             gint new_height,
                                                             gint offx,
                                                             gint offy);

Crop the image to the specified extents.

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.

`image_ID` : | The image.
`new_width` : | New image width: (0 < new_width <= width).
`new_height` : | New image height: (0 < new_height <= height).
`offx` : | X offset: (0 <= offx <= (width - new_width)).
`offy` : | Y offset: (0 <= offy <= (height - new_height)).
Returns : | TRUE on success.

### gimp_image_get_layers ()

    gint*               gimp_image_get_layers               (gint32 image_ID,
                                                             gint *num_layers);

Returns the list of layers contained in the specified image.

This procedure returns the list of layers contained in the specified image. The order of layers is from topmost to bottommost.

`image_ID` : | The image.
`num_layers` : | The number of layers contained in the image.
Returns : | The list of layers contained in the image.

### gimp_image_get_channels ()

    gint*               gimp_image_get_channels             (gint32 image_ID,
                                                             gint *num_channels);

Returns the list of channels contained in the specified image.

This procedure returns the list of channels contained in the specified image. This does not include the selection mask, or layer masks. The order is from topmost to bottommost.

`image_ID` : | The image.
`num_channels` : | The number of channels contained in the image.
Returns : | The list of channels contained in the image.

### gimp_image_get_active_drawable ()

    gint32              gimp_image_get_active_drawable      (gint32 image_ID);

Get the image's active drawable

This procedure returns the ID of the image's active drawable. This can be either a layer, a channel, or a layer mask. The active drawable is specified by the active image channel. If that is -1, then by the active image layer. If the active image layer has a layer mask and the layer mask is in edit mode, then the layer mask is the active drawable.

`image_ID` : | The image.
Returns : | The active drawable.

### gimp_image_get_floating_sel ()

    gint32              gimp_image_get_floating_sel         (gint32 image_ID);

Return the floating selection of the image.

This procedure returns the image's floating selection, if it exists. If it doesn't exist, -1 is returned as the layer ID.

`image_ID` : | The image.
Returns : | The image's floating selection.

### gimp_image_floating_sel_attached_to ()

    gint32              gimp_image_floating_sel_attached_to (gint32 image_ID);

Return 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.

`image_ID` : | The image.
Returns : | The drawable the floating selection is attached to.

### gimp_image_pick_color ()

    gboolean            gimp_image_pick_color               (gint32 image_ID,
                                                             gint32 drawable_ID,
                                                             gdouble x,
                                                             gdouble y,
                                                             gboolean sample_merged,
                                                             gboolean sample_average,
                                                             gdouble average_radius,
                                                             GimpRGB *color);

Determine the color at the given drawable coordinates

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 TRUE, 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.

`image_ID` : | The image.
`drawable_ID` : | The drawable to pick from.
`x` : | x coordinate of upper-left corner of rectangle.
`y` : | y coordinate of upper-left corner of rectangle.
`sample_merged` : | Use the composite image, not the drawable.
`sample_average` : | Average the color of all the pixels in a specified radius.
`average_radius` : | The radius of pixels to average.
`color` : | The return color.
Returns : | TRUE on success.

### gimp_image_pick_correlate_layer ()

    gint32              gimp_image_pick_correlate_layer     (gint32 image_ID,
                                                             gint x,
                                                             gint y);

Find the layer visible at the specified coordinates.

This procedure finds the layer which is visible at the specified coordinates. Layers which do not qualify are those whose extents do not pass within the specified coordinates, or which are transparent at the specified coordinates. This procedure will return -1 if no layer is found.

`image_ID` : | The image.
`x` : | The x coordinate for the pick.
`y` : | The y coordinate for the pick.
Returns : | The layer found at the specified coordinates.

### gimp_image_add_layer ()

    gboolean            gimp_image_add_layer                (gint32 image_ID,
                                                             gint32 layer_ID,
                                                             gint position);

Add the specified layer to the image.

This procedure adds the specified layer to the image at the given position. If the position is specified as -1, then the layer is inserted above the active layer. The layer type must be compatible with the image base type.

`image_ID` : | The image.
`layer_ID` : | The layer.
`position` : | The layer position.
Returns : | TRUE on success.

### gimp_image_remove_layer ()

    gboolean            gimp_image_remove_layer             (gint32 image_ID,
                                                             gint32 layer_ID);

Remove the specified layer from the image.

This procedure removes the specified layer from the image. If the layer doesn't exist, an error is returned. If there are no layers left in the image, this call will fail. If this layer is the last layer remaining, the image will become empty and have no active layer.

`image_ID` : | The image.
`layer_ID` : | The layer.
Returns : | TRUE on success.

### gimp_image_raise_layer ()

    gboolean            gimp_image_raise_layer              (gint32 image_ID,
                                                             gint32 layer_ID);

Raise the specified layer in the image's layer stack

This procedure raises the specified layer one step in the existing layer stack. The procecure call will fail if there is no layer above it.

`image_ID` : | The image.
`layer_ID` : | The layer to raise.
Returns : | TRUE on success.

### gimp_image_lower_layer ()

    gboolean            gimp_image_lower_layer              (gint32 image_ID,
                                                             gint32 layer_ID);

Lower the specified layer in the image's layer stack

This procedure lowers the specified layer one step in the existing layer stack. The procecure call will fail if there is no layer below it.

`image_ID` : | The image.
`layer_ID` : | The layer to lower.
Returns : | TRUE on success.

### gimp_image_raise_layer_to_top ()

    gboolean            gimp_image_raise_layer_to_top       (gint32 image_ID,
                                                             gint32 layer_ID);

Raise the specified layer in the image's layer stack to top of stack

This procedure raises the specified layer to top of the existing layer stack. It will not move the layer if there is no layer above it.

`image_ID` : | The image.
`layer_ID` : | The layer to raise to top.
Returns : | TRUE on success.

### gimp_image_lower_layer_to_bottom ()

    gboolean            gimp_image_lower_layer_to_bottom    (gint32 image_ID,
                                                             gint32 layer_ID);

Lower the specified layer in the image's layer stack to bottom of stack

This procedure lowers the specified layer to bottom of the existing layer stack. It will not move the layer if there is no layer below it.

`image_ID` : | The image.
`layer_ID` : | The layer to lower to bottom.
Returns : | TRUE on success.

### gimp_image_get_layer_position ()

    gint                gimp_image_get_layer_position       (gint32 image_ID,
                                                             gint32 layer_ID);

Returns the position of the layer in the layer stack.

This procedure determines the position of the specified layer in the images layer stack. If the layer doesn't exist in the image, an error is returned.

`image_ID` : | The image.
`layer_ID` : | The layer.
Returns : | The position of the layer in the layer stack.

Since GIMP 2.4

### gimp_image_add_channel ()

    gboolean            gimp_image_add_channel              (gint32 image_ID,
                                                             gint32 channel_ID,
                                                             gint position);

Add the specified channel to the image.

This procedure adds the specified channel to the image. The position channel is not currently used, so the channel is always inserted at the top of the channel stack.

`image_ID` : | The image.
`channel_ID` : | The channel.
`position` : | The channel position.
Returns : | TRUE on success.

### gimp_image_remove_channel ()

    gboolean            gimp_image_remove_channel           (gint32 image_ID,
                                                             gint32 channel_ID);

Remove the specified channel from the image.

This procedure removes the specified channel from the image. If the channel doesn't exist, an error is returned.

`image_ID` : | The image.
`channel_ID` : | The channel.
Returns : | TRUE on success.

### gimp_image_raise_channel ()

    gboolean            gimp_image_raise_channel            (gint32 image_ID,
                                                             gint32 channel_ID);

Raise the specified channel in the image's channel stack

This procedure raises the specified channel one step in the existing channel stack. The procecure call will fail if there is no channel above it.

`image_ID` : | The image.
`channel_ID` : | The channel to raise.
Returns : | TRUE on success.

### gimp_image_lower_channel ()

    gboolean            gimp_image_lower_channel            (gint32 image_ID,
                                                             gint32 channel_ID);

Lower the specified channel in the image's channel stack

This procedure lowers the specified channel one step in the existing channel stack. The procecure call will fail if there is no channel below it.

`image_ID` : | The image.
`channel_ID` : | The channel to lower.
Returns : | TRUE on success.

### gimp_image_get_channel_position ()

    gint                gimp_image_get_channel_position     (gint32 image_ID,
                                                             gint32 channel_ID);

Returns the position of the channel in the channel stack.

This procedure determines the position of the specified channel in the images channel stack. If the channel doesn't exist in the image, an error is returned.

`image_ID` : | The image.
`channel_ID` : | The channel.
Returns : | The position of the channel in the channel stack.

Since GIMP 2.4

### gimp_image_flatten ()

    gint32              gimp_image_flatten                  (gint32 image_ID);

Flatten all visible layers into a single layer. Discard all invisible layers.

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.

`image_ID` : | The image.
Returns : | The resulting layer.

### gimp_image_merge_visible_layers ()

    gint32              gimp_image_merge_visible_layers     (gint32 image_ID,
                                                             GimpMergeType merge_type);

Merge the visible image layers into one.

This procedure combines the visible layers into a single layer 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.

`image_ID` : | The image.
`merge_type` : | The type of merge.
Returns : | The resulting layer.

### gimp_image_merge_down ()

    gint32              gimp_image_merge_down               (gint32 image_ID,
                                                             gint32 merge_layer_ID,
                                                             GimpMergeType merge_type);

Merge the layer passed and the first visible layer below.

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.

`image_ID` : | The image.
`merge_layer_ID` : | The layer to merge down from.
`merge_type` : | The type of merge.
Returns : | The resulting layer.

### gimp_image_clean_all ()

    gboolean            gimp_image_clean_all                (gint32 image_ID);

Set the image dirty count to 0.

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. Note that save plug-ins must NOT call this function themselves after saving the image.

`image_ID` : | The image.
Returns : | TRUE on success.

### gimp_image_is_dirty ()

    gboolean            gimp_image_is_dirty                 (gint32 image_ID);

Checks if the image has unsaved changes.

This procedure checks the specified image's dirty count to see if it needs to be saved. Note that saving the image does not automatically set the dirty count to 0, you need to call `gimp_image_clean_all()` after calling a save procedure to make the image clean.

`image_ID` : | The image.
Returns : | TRUE if the image has unsaved changes.

### gimp_image_get_active_layer ()

    gint32              gimp_image_get_active_layer         (gint32 image_ID);

Returns the specified image's active layer.

If there is an active layer, its ID will be returned, otherwise, -1. If a channel is currently active, then no layer will be. If a layer mask is active, then this will return the associated layer.

`image_ID` : | The image.
Returns : | The active layer.

### gimp_image_set_active_layer ()

    gboolean            gimp_image_set_active_layer         (gint32 image_ID,
                                                             gint32 active_layer_ID);

Sets the specified image's active layer.

If the layer exists, it is set as the active layer in the image. Any previous active layer or channel is set to inactive. An exception is a previously existing floating selection, in which case this procedure will return an execution error.

`image_ID` : | The image.
`active_layer_ID` : | The new image active layer.
Returns : | TRUE on success.

### gimp_image_get_active_channel ()

    gint32              gimp_image_get_active_channel       (gint32 image_ID);

Returns the specified image's active channel.

If there is an active channel, this will return the channel ID, otherwise, -1.

`image_ID` : | The image.
Returns : | The active channel.

### gimp_image_set_active_channel ()

    gboolean            gimp_image_set_active_channel       (gint32 image_ID,
                                                             gint32 active_channel_ID);

Sets the specified image's active channel.

If the channel exists, it is set as the active channel in the image. Any previous active channel or channel is set to inactive. An exception is a previously existing floating selection, in which case this procedure will return an execution error.

`image_ID` : | The image.
`active_channel_ID` : | The new image active channel.
Returns : | TRUE on success.

### gimp_image_unset_active_channel ()

    gboolean            gimp_image_unset_active_channel     (gint32 image_ID);

Unsets the active channel in the specified image.

If an active channel exists, it is unset. There then exists no active channel, and if desired, one can be set through a call to 'Set Active Channel'. No error is returned in the case of no existing active channel.

`image_ID` : | The image.
Returns : | TRUE on success.

### gimp_image_get_selection ()

    gint32              gimp_image_get_selection            (gint32 image_ID);

Returns the specified image's selection.

This will always return a valid ID for a selection -- which is represented as a channel internally.

`image_ID` : | The image.
Returns : | The selection channel.

### gimp_image_get_component_active ()

    gboolean            gimp_image_get_component_active     (gint32 image_ID,
                                                             GimpChannelType component);

Returns if the specified image's image component is active.

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.

`image_ID` : | The image.
`component` : | The image component.
Returns : | Component is active.

### gimp_image_set_component_active ()

    gboolean            gimp_image_set_component_active     (gint32 image_ID,
                                                             GimpChannelType component,
                                                             gboolean active);

Sets if the specified image's image component is active.

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.

`image_ID` : | The image.
`component` : | The image component.
`active` : | Component is active.
Returns : | TRUE on success.

### gimp_image_get_component_visible ()

    gboolean            gimp_image_get_component_visible    (gint32 image_ID,
                                                             GimpChannelType component);

Returns if the specified image's image component is visible.

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.

`image_ID` : | The image.
`component` : | The image component.
Returns : | Component is visible.

### gimp_image_set_component_visible ()

    gboolean            gimp_image_set_component_visible    (gint32 image_ID,
                                                             GimpChannelType component,
                                                             gboolean visible);

Sets if the specified image's image component is visible.

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.

`image_ID` : | The image.
`component` : | The image component.
`visible` : | Component is visible.
Returns : | TRUE on success.

### gimp_image_get_filename ()

    gchar*              gimp_image_get_filename             (gint32 image_ID);

Returns the specified image's 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`.

`image_ID` : | The image.
Returns : | The filename.

### gimp_image_set_filename ()

    gboolean            gimp_image_set_filename             (gint32 image_ID,
                                                             const gchar *filename);

Sets the specified image's filename.

This procedure sets the specified image's filename. The filename should be in the filesystem encoding.

`image_ID` : | The image.
`filename` : | The new image filename.
Returns : | TRUE on success.

### gimp_image_get_name ()

    gchar*              gimp_image_get_name                 (gint32 image_ID);

Returns the specified image's name.

This procedure returns the specified image's name.

`image_ID` : | The image.
Returns : | The name.

### gimp_image_get_resolution ()

    gboolean            gimp_image_get_resolution           (gint32 image_ID,
                                                             gdouble *xresolution,
                                                             gdouble *yresolution);

Returns the specified image's resolution.

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

`image_ID` : | The image.
`xresolution` : | The resolution in the x-axis, in dots per inch.
`yresolution` : | The resolution in the y-axis, in dots per inch.
Returns : | TRUE on success.

### gimp_image_set_resolution ()

    gboolean            gimp_image_set_resolution           (gint32 image_ID,
                                                             gdouble xresolution,
                                                             gdouble yresolution);

Sets the specified image's resolution.

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.

`image_ID` : | The image.
`xresolution` : | The new image resolution in the x-axis, in dots per inch.
`yresolution` : | The new image resolution in the y-axis, in dots per inch.
Returns : | TRUE on success.

### gimp_image_get_unit ()

    GimpUnit            gimp_image_get_unit                 (gint32 image_ID);

Returns the specified image's unit.

This procedure returns the specified image's unit. This value is independent of any of the layers in this image. See the gimp_unit_*() procedure definitions for the valid range of unit IDs and a description of the unit system.

`image_ID` : | The image.
Returns : | The unit.

### gimp_image_set_unit ()

    gboolean            gimp_image_set_unit                 (gint32 image_ID,
                                                             GimpUnit unit);

Sets the specified image's unit.

This procedure sets the specified image's unit. No scaling or resizing is performed. This value is independent of any of the layers in this image. See the gimp_unit_*() procedure definitions for the valid range of unit IDs and a description of the unit system.

`image_ID` : | The image.
`unit` : | The new image unit.
Returns : | TRUE on success.

### gimp_image_set_tattoo_state ()

    gboolean            gimp_image_set_tattoo_state         (gint32 image_ID,
                                                             gint tattoo_state);

Set the tattoo state associated with the image.

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.

`image_ID` : | The image.
`tattoo_state` : | The new image tattoo state.
Returns : | TRUE on success.

### gimp_image_get_tattoo_state ()

    gint                gimp_image_get_tattoo_state         (gint32 image_ID);

Returns the tattoo state associated with the image.

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.

`image_ID` : | The image.
Returns : | The tattoo state.

### gimp_image_get_layer_by_tattoo ()

    gint32              gimp_image_get_layer_by_tattoo      (gint32 image_ID,
                                                             gint tattoo);

Find a layer with a given tattoo in an image.

This procedure returns the layer with the given tattoo in the specified image.

`image_ID` : | The image.
`tattoo` : | The tattoo of the layer to find.
Returns : | The layer with the specified tattoo.

### gimp_image_get_channel_by_tattoo ()

    gint32              gimp_image_get_channel_by_tattoo    (gint32 image_ID,
                                                             gint tattoo);

Find a channel with a given tattoo in an image.

This procedure returns the channel with the given tattoo in the specified image.

`image_ID` : | The image.
`tattoo` : | The tattoo of the channel to find.
Returns : | The channel with the specified tattoo.

### gimp_image_get_cmap ()

    guchar *            gimp_image_get_cmap                 (gint32 image_ID,
                                                             gint *num_colors);

### Warning

`gimp_image_get_cmap` is deprecated and should not be used in newly-written code.

This procedure is deprecated! Use `gimp_image_get_colormap()` instead.

`image_ID` : | The image.
`num_colors` : | Number of colors in the colormap array.
Returns : | The image's colormap.

### gimp_image_set_cmap ()

    gboolean            gimp_image_set_cmap                 (gint32 image_ID,
                                                             const guchar *cmap,
                                                             gint num_colors);

### Warning

`gimp_image_set_cmap` is deprecated and should not be used in newly-written code.

This procedure is deprecated! Use `gimp_image_set_colormap()` instead.

`image_ID` : | The image.
`cmap` : | The new colormap values.
`num_colors` : | Number of colors in the colormap array.
Returns : | TRUE on success.

### gimp_image_get_colormap ()

    guchar *            gimp_image_get_colormap             (gint32 image_ID,
                                                             gint *num_colors);

Returns the image's colormap

This procedure returns an actual pointer to the image's colormap, as well as the number of colors contained in the colormap. If the image is not of base type INDEXED, this pointer will be NULL.

`image_ID` : | The image.
`num_colors` : | Returns the number of colors in the colormap array.
Returns : | The image's colormap.

### gimp_image_set_colormap ()

    gboolean            gimp_image_set_colormap             (gint32 image_ID,
                                                             const guchar *colormap,
                                                             gint num_colors);

Sets the entries in the image's colormap.

This procedure sets the entries in the specified image's colormap. The number of colors is specified by the \"num_colors\" parameter and corresponds to the number of INT8 triples that must be contained in the \"cmap\" array.

`image_ID` : | The image.
`colormap` : | The new colormap values.
`num_colors` : | Number of colors in the colormap array.
Returns : | TRUE on success.

### gimp_image_get_vectors ()

    gint*               gimp_image_get_vectors              (gint32 image_ID,
                                                             gint *num_vectors);

Returns the list of vectors contained in the specified image.

This procedure returns the list of vectors contained in the specified image.

`image_ID` : | The image.
`num_vectors` : | The number of vectors contained in the image.
Returns : | The list of vectors contained in the image.

Since GIMP 2.4

### gimp_image_get_vectors_by_tattoo ()

    gint32              gimp_image_get_vectors_by_tattoo    (gint32 image_ID,
                                                             gint tattoo);

Find a vectors with a given tattoo in an image.

This procedure returns the vectors with the given tattoo in the specified image.

`image_ID` : | The image.
`tattoo` : | The tattoo of the vectors to find.
Returns : | The vectors with the specified tattoo.

Since GIMP 2.6

### gimp_image_get_thumbnail_data ()

    guchar *            gimp_image_get_thumbnail_data       (gint32 image_ID,
                                                             gint *width,
                                                             gint *height,
                                                             gint *bpp);

`image_ID` : |
`width` : |
`height` : |
`bpp` : |
Returns : |

### gimp_image_parasite_find ()

    GimpParasite*       gimp_image_parasite_find            (gint32 image_ID,
                                                             const gchar *name);

Look up a parasite in an image

Finds and returns the parasite that was previously attached to an image.

`image_ID` : | The image.
`name` : | The name of the parasite to find.
Returns : | The found parasite.

### gimp_image_parasite_list ()

    gboolean            gimp_image_parasite_list            (gint32 image_ID,
                                                             gint *num_parasites,
                                                             gchar ***parasites);

List all parasites.

Returns a list of all currently attached parasites.

`image_ID` : | The image.
`num_parasites` : | The number of attached parasites.
`parasites` : | The names of currently attached parasites.
Returns : | TRUE on success.

### gimp_image_parasite_attach ()

    gboolean            gimp_image_parasite_attach          (gint32 image_ID,
                                                             const GimpParasite *parasite);

Add a parasite to an image.

This procedure attaches a parasite to an image. It has no return values.

`image_ID` : | The image.
`parasite` : | The parasite to attach to an image.
Returns : | TRUE on success.

### gimp_image_parasite_detach ()

    gboolean            gimp_image_parasite_detach          (gint32 image_ID,
                                                             const gchar *name);

Removes a parasite from an image.

This procedure detaches a parasite from an image. It has no return values.

`image_ID` : | The image.
`name` : | The name of the parasite to detach from an image.
Returns : | TRUE on success.

### gimp_image_attach_new_parasite ()

    gboolean            gimp_image_attach_new_parasite      (gint32 image_ID,
                                                             const gchar *name,
                                                             gint flags,
                                                             gint size,
                                                             gconstpointer data);

Convenience function that creates a parasite and attaches it to GIMP.

`image_ID` : | the ID of the image to attach the GimpParasite to.
`name` : | the name of the GimpParasite to create and attach.
`flags` : | the flags set on the GimpParasite.
`size` : | the size of the parasite data in bytes.
`data` : | a pointer to the data attached with the GimpParasite.
Returns : | TRUE on successful creation and attachment of the new parasite. See Also: `gimp_image_parasite_attach()`

### gimp_image_add_vectors ()

    gboolean            gimp_image_add_vectors              (gint32 image_ID,
                                                             gint32 vectors_ID,
                                                             gint position);

Add the specified vectors object to the image.

This procedure adds the specified vectors object to the image at the given position. If the position is specified as -1, then the vectors object is inserted at the top of the vectors stack.

`image_ID` : | The image.
`vectors_ID` : | The vectors object.
`position` : | The vectors objects position.
Returns : | TRUE on success.

### gimp_image_remove_vectors ()

    gboolean            gimp_image_remove_vectors           (gint32 image_ID,
                                                             gint32 vectors_ID);

Remove the specified path from the image.

This procedure removes the specified path from the image. If the path doesn't exist, an error is returned.

`image_ID` : | The image.
`vectors_ID` : | The vectors object.
Returns : | TRUE on success.

Since GIMP 2.4

### gimp_image_get_active_vectors ()

    gint32              gimp_image_get_active_vectors       (gint32 image_ID);

Returns the specified image's active vectors.

If there is an active path, its ID will be returned, otherwise, -1.

`image_ID` : | The image.
Returns : | The active vectors.

### gimp_image_set_active_vectors ()

    gboolean            gimp_image_set_active_vectors       (gint32 image_ID,
                                                             gint32 active_vectors_ID);

Sets the specified image's active vectors.

If the path exists, it is set as the active path in the image.

`image_ID` : | The image.
`active_vectors_ID` : | The new image active vectors.
Returns : | TRUE on success.

### gimp_image_lower_vectors ()

    gboolean            gimp_image_lower_vectors            (gint32 image_ID,
                                                             gint32 vectors_ID);

Lower the specified vectors in the image's vectors stack

This procedure lowers the specified vectors one step in the existing vectors stack. The procecure call will fail if there is no vectors below it.

`image_ID` : | The image.
`vectors_ID` : | The vectors object to lower.
Returns : | TRUE on success.

Since GIMP 2.4

### gimp_image_raise_vectors ()

    gboolean            gimp_image_raise_vectors            (gint32 image_ID,
                                                             gint32 vectors_ID);

Raise the specified vectors in the image's vectors stack

This procedure raises the specified vectors one step in the existing vectors stack. The procecure call will fail if there is no vectors above it.

`image_ID` : | The image.
`vectors_ID` : | The vectors object to raise.
Returns : | TRUE on success.

Since GIMP 2.4

### gimp_image_lower_vectors_to_bottom ()

    gboolean            gimp_image_lower_vectors_to_bottom  (gint32 image_ID,
                                                             gint32 vectors_ID);

Lower the specified vectors in the image's vectors stack to bottom of stack

This procedure lowers the specified vectors to bottom of the existing vectors stack. It will not move the vectors if there is no vectors below it.

`image_ID` : | The image.
`vectors_ID` : | The vectors object to lower to bottom.
Returns : | TRUE on success.

Since GIMP 2.4

### gimp_image_raise_vectors_to_top ()

    gboolean            gimp_image_raise_vectors_to_top     (gint32 image_ID,
                                                             gint32 vectors_ID);

Raise the specified vectors in the image's vectors stack to top of stack

This procedure raises the specified vectors to top of the existing vectors stack. It will not move the vectors if there is no vectors above it.

`image_ID` : | The image.
`vectors_ID` : | The vectors object to raise to top.
Returns : | TRUE on success.

Since GIMP 2.4

### gimp_image_get_vectors_position ()

    gint                gimp_image_get_vectors_position     (gint32 image_ID,
                                                             gint32 vectors_ID);

Returns the position of the vectors object in the vectors objects stack.

This procedure determines the position of the specified vectors object in the images vectors object stack. If the vectors object doesn't exist in the image, an error is returned.

`image_ID` : | The image.
`vectors_ID` : | The vectors object.
Returns : | The position of the vectors object in the vectors stack.

Since GIMP 2.4