Gimp.Image
Description: Reference for Gimp.Image

### Class

# GimpImage

#### Description [src]

    final class Gimp.Image : GObject.Object
    {
      /* No available fields */
    }

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

#### Hierarchy

#### Ancestors

- GObject

#### Constructors

###### gimp_image_new

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

###### gimp_image_new_with_precision

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

since: 2.10

#### Functions

###### gimp_image_convert_set_dither_matrix

Set dither matrix for conversion to indexed.

since: 2.4

###### gimp_image_get_by_id

No description available.

since: 3.0

###### gimp_image_id_is_valid

Returns TRUE if the image ID is valid.

since: 3.0

###### gimp_image_metadata_load_thumbnail

Retrieves a thumbnail from metadata if present.

since: 2.10

#### Instance methods

###### gimp_image_add_hguide

Add a horizontal guide to an image.

###### gimp_image_add_sample_point

Add a sample point to an image.

since: 2.10

###### gimp_image_add_vguide

Add a vertical guide to an image.

###### gimp_image_attach_parasite

Add a parasite to an image.

since: 2.8

###### gimp_image_autocrop

Remove empty borders from the image.

###### gimp_image_autocrop_selected_layers

Crop the selected layers based on empty borders of the input drawable.

###### gimp_image_clean_all

Set the image dirty count to 0.

###### gimp_image_convert_color_profile

This procedure converts from the image’s color profile (or the built-in profile if none is set) to the given color profile.

since: 2.10

###### gimp_image_convert_color_profile_from_file

Convert the image’s layers to a color profile.

since: 2.10

###### gimp_image_convert_grayscale

Convert specified image to grayscale.

###### gimp_image_convert_indexed

Convert specified image to and Indexed image.

###### gimp_image_convert_precision

Convert the image to the specified precision.

since: 2.10

###### 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_delete_sample_point

Deletes a sample point from an image.

since: 2.10

###### gimp_image_detach_parasite

Removes a parasite from an image.

since: 2.8

###### gimp_image_duplicate

Duplicate the specified image.

###### gimp_image_export_path_to_file

Save a path as an SVG file.

since: 2.6

###### gimp_image_export_path_to_string

Save a path as an SVG string.

since: 2.6

###### gimp_image_find_next_guide

Find next guide on an image.

###### gimp_image_find_next_sample_point

Find next sample point on an image.

since: 2.10

###### 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_freeze_channels

Freeze the image’s channel list.

since: 2.10.2

###### gimp_image_freeze_layers

Freeze the image’s layer list.

since: 2.10.2

###### gimp_image_freeze_paths

Freeze the image’s path list.

since: 2.10.2

###### gimp_image_get_base_type

Get the base type of the image.

###### gimp_image_get_channel_by_name

Find a channel with a given name in an image.

since: 2.8

###### 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_color_profile

This procedure returns the image’s color profile, or `NULL` if the image uses the built-in color profile.

since: 2.10

###### 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_default_new_layer_mode

Get the default mode for newly created layers of this image.

since: 2.10

###### gimp_image_get_effective_color_profile

This procedure returns the color profile that is actually used for this image, which is the profile returned by `gimp_image_get_color_profile()` if the image has a profile assigned, or a built-in profile for the given color space otherwise.

since: 2.10

###### gimp_image_get_exported_file

Returns the exported file for the specified image.

since: 2.8

###### gimp_image_get_file

Returns the file for the specified image.

since: 2.8

###### 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_height

Return the height of the image.

###### gimp_image_get_id

No description available.

since: 3.0

###### gimp_image_get_imported_file

Returns the imported file for the specified image.

since: 2.8

###### gimp_image_get_item_position

Returns the position of the item in its level of its item tree.

since: 2.8

###### gimp_image_get_layer_by_name

Find a layer with a given name in an image.

since: 2.8

###### gimp_image_get_layer_by_tattoo

Find a layer with a given tattoo in an image.

###### gimp_image_get_layers

Returns the list of root layers contained in the specified image.

###### gimp_image_get_metadata

Returns the image’s metadata.

since: 2.10

###### gimp_image_get_name

Returns the specified image’s name.

###### gimp_image_get_palette

Returns the image’s colormap.

since: 3.0

###### gimp_image_get_parasite

Look up a parasite in an image.

since: 2.8

###### gimp_image_get_parasite_list

List all parasites.

since: 2.8

###### gimp_image_get_path_by_name

Find a path with a given name in an image.

since: 2.8

###### gimp_image_get_path_by_tattoo

Find a path with a given tattoo in an image.

since: 2.6

###### gimp_image_get_paths

Returns the list of paths contained in the specified image.

since: 2.4

###### gimp_image_get_precision

Get the precision of the image.

since: 2.10

###### gimp_image_get_resolution

Returns the specified image’s resolution.

###### gimp_image_get_sample_point_position

Get position of a sample point on an image.

since: 2.10

###### gimp_image_get_selected_channels

Returns the specified image’s selected channels.

since: 3.0.0

###### gimp_image_get_selected_drawables

Get the image’s selected drawables.

since: 3.0.0

###### gimp_image_get_selected_layers

Returns the specified image’s selected layers.

since: 3.0.0

###### gimp_image_get_selected_paths

Returns the specified image’s selected paths.

since: 3.0.0

###### gimp_image_get_selection

Returns the specified image’s selection.

###### gimp_image_get_simulation_bpc

Returns whether the image has Black Point Compensation enabled for its simulation.

since: 3.0

###### gimp_image_get_simulation_intent

Returns the image’s simulation rendering intent.

since: 3.0

###### gimp_image_get_simulation_profile

This procedure returns the image’s simulation color profile, or `NULL` if the image has no simulation color profile assigned.

since: 3.0

###### gimp_image_get_tattoo_state

Returns the tattoo state associated with the image.

###### gimp_image_get_thumbnail

Retrieves a thumbnail pixbuf for `image`. The thumbnail will be not larger than the requested size.

since: 2.2

###### gimp_image_get_thumbnail_data

Get a thumbnail of an image.

###### gimp_image_get_unit

Returns the specified image’s unit.

###### gimp_image_get_width

Return the width of the image.

###### gimp_image_get_xcf_file

Returns the XCF file for the specified image.

since: 2.8

###### gimp_image_grid_get_background_color

Sets the background color of an image’s grid.

since: 2.4

###### gimp_image_grid_get_foreground_color

Sets the foreground color of an image’s grid.

since: 2.4

###### gimp_image_grid_get_offset

Gets the offset of an image’s grid.

since: 2.4

###### gimp_image_grid_get_spacing

Gets the spacing of an image’s grid.

since: 2.4

###### gimp_image_grid_get_style

Gets the style of an image’s grid.

since: 2.4

###### gimp_image_grid_set_background_color

Gets the background color of an image’s grid.

since: 2.4

###### gimp_image_grid_set_foreground_color

Gets the foreground color of an image’s grid.

since: 2.4

###### gimp_image_grid_set_offset

Sets the offset of an image’s grid.

since: 2.4

###### gimp_image_grid_set_spacing

Sets the spacing of an image’s grid.

since: 2.4

###### gimp_image_grid_set_style

Sets the style unit of an image’s grid.

since: 2.4

###### gimp_image_import_paths_from_file

Import paths from an SVG file.

since: 2.4

###### gimp_image_import_paths_from_string

Import paths from an SVG string.

since: 2.4

###### gimp_image_insert_channel

Add the specified channel to the image.

###### gimp_image_insert_layer

Add the specified layer to the image.

###### gimp_image_insert_path

Add the specified path to the image.

###### gimp_image_is_dirty

Checks if the image has unsaved changes.

###### gimp_image_is_valid

Returns TRUE if the image is valid.

since: 2.4

###### gimp_image_list_channels

Returns the list of channels contained in the specified image.

since: 3.0

###### gimp_image_list_layers

Returns the list of layers contained in the specified image.

since: 3.0

###### gimp_image_list_paths

Returns the list of paths contained in the specified image.

since: 3.0

###### gimp_image_list_selected_channels

Returns the list of channels selected in the specified image.

since: 3.0

###### gimp_image_list_selected_drawables

Returns the list of drawables selected in the specified image.

since: 3.0

###### gimp_image_list_selected_layers

Returns the list of layers selected in the specified image.

since: 3.0

###### gimp_image_list_selected_paths

Returns the list of paths selected in the specified image.

since: 3.0

###### gimp_image_lower_item

Lower the specified item in its level in its item tree.

since: 2.8

###### gimp_image_lower_item_to_bottom

Lower the specified item to the bottom of its level in its item tree.

since: 2.8

###### 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_metadata_save_filter

Filters the `metadata` retrieved from the image with `gimp_image_metadata_save_prepare()`, taking into account the passed `flags`.

since: 3.0

###### gimp_image_metadata_save_prepare

Gets the image metadata for storing it in an exported file.

since: 2.10

###### gimp_image_pick_color

Determine the color at the given coordinates.

###### gimp_image_pick_correlate_layer

Find the layer visible at the specified coordinates.

###### gimp_image_policy_color_profile

Execute the color profile conversion policy.

since: 3.0

###### gimp_image_policy_rotate

Execute the "Orientation" metadata policy.

since: 3.0

###### gimp_image_raise_item

Raise the specified item in its level in its item tree.

since: 2.8

###### gimp_image_raise_item_to_top

Raise the specified item to the top of its level in its item tree.

since: 2.8

###### 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_path

Remove the specified path from the image.

since: 2.4

###### gimp_image_reorder_item

Reorder the specified item within its item tree.

since: 2.8

###### gimp_image_resize

Resize the image to the specified extents.

###### gimp_image_resize_to_layers

Resize the image to fit all layers.

since: 2.2

###### gimp_image_rotate

Rotates the image by the specified degrees.

###### gimp_image_scale

Scale the image using the default interpolation method.

###### gimp_image_select_color

Create a selection by selecting all pixels (in the specified drawable) with the same (or similar) color to that specified.

since: 2.8

###### gimp_image_select_contiguous_color

Create a selection by selecting all pixels around specified coordinates with the same (or similar) color to that at the coordinates.

since: 2.8

###### gimp_image_select_ellipse

Create an elliptical selection over the specified image.

since: 2.8

###### gimp_image_select_item

Transforms the specified item into a selection.

since: 2.8

###### gimp_image_select_polygon

Create a polygonal selection over the specified image.

since: 2.8

###### gimp_image_select_rectangle

Create a rectangular selection over the specified image;.

since: 2.8

###### gimp_image_select_round_rectangle

Create a rectangular selection with round corners over the specified image;.

since: 2.8

###### gimp_image_set_color_profile

This procedure sets the image’s color profile.

since: 2.10

###### gimp_image_set_color_profile_from_file

Sets the image’s color profile from an ICC file.

since: 2.10

###### 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_file

Sets the specified XCF image’s file.

###### gimp_image_set_metadata

Set the image’s metadata.

since: 2.10

###### gimp_image_set_palette

Set the image’s colormap to a copy of `palette`.

since: 3.0

###### gimp_image_set_resolution

Sets the specified image’s resolution.

###### gimp_image_set_selected_channels

Sets the specified image’s selected channels.

since: 3.0.0

###### gimp_image_set_selected_layers

Sets the specified image’s selected layers.

since: 3.0.0

###### gimp_image_set_selected_paths

Sets the specified image’s selected paths.

since: 3.0.0

###### gimp_image_set_simulation_bpc

Sets whether the image has Black Point Compensation enabled for its simulation.

since: 3.0

###### gimp_image_set_simulation_intent

Sets the image’s simulation rendering intent.

since: 3.0

###### gimp_image_set_simulation_profile

This procedure sets the image’s simulation color profile.

since: 3.0

###### gimp_image_set_simulation_profile_from_file

Sets the image’s simulation color profile from an ICC file.

since: 3.0

###### 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_take_selected_channels

The channels are set as the selected channels in the image. Any previous selected layers or channels are unselected. An exception is a previously existing floating selection, in which case this procedure will return an execution error.

since: 3.0

###### gimp_image_take_selected_layers

The layers are set as the selected layers in the image. Any previous selected layers or channels are unselected. An exception is a previously existing floating selection, in which case this procedure will return an execution error.

since: 3.0

###### gimp_image_take_selected_paths

The paths are set as the selected paths in the image. Any previous selected paths are unselected.

since: 3.0

###### gimp_image_thaw_channels

Thaw the image’s channel list.

since: 2.10.2

###### gimp_image_thaw_layers

Thaw the image’s layer list.

since: 2.10.2

###### gimp_image_thaw_paths

Thaw the image’s path list.

since: 2.10.2

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

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

#### Properties

###### Gimp.Image:id

No description available.

#### Signals

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct GimpImageClass {
      GObjectClass parent_class;

    }

No description available.

###### Class members

`parent_class: GObjectClass`

  No description available.