Image

---

Object Hierarchy:

Description:

Content:

Properties:

• public int id { get; construct; }

Static methods:

• public static bool convert_set_dither_matrix (int width, int height, Bytes matrix)
  Set dither matrix for conversion to indexed
• public static unowned Image? get_by_id (int32 image_id)
• public static bool id_is_valid (int image_id)
  Returns TRUE if the image ID is valid.
• public static unowned Image? metadata_load_thumbnail (File file) throws Error
  Retrieves a thumbnail from metadata if present.

Creation methods:

• public Image (int width, int height, ImageBaseType type)
  Creates a new image with the specified width, height, and type.
• public Image.with_precision (int width, int height, ImageBaseType type, Precision precision)
  Creates a new image with the specified width, height, type and precision.

Methods:

• public bool @delete ()
  Delete the specified image.
• public uint add_hguide (int yposition)
  Add a horizontal guide to an image.
• public uint add_sample_point (int position_x, int position_y)
  Add a sample point to an image.
• public uint add_vguide (int xposition)
  Add a vertical guide to an image.
• public bool attach_parasite (Parasite parasite)
  Add a parasite to an image.
• public bool autocrop (Drawable? drawable)
  Remove empty borders from the image
• public bool autocrop_selected_layers (Drawable? drawable)
  Crop the selected layers based on empty borders of the input drawable
• public bool clean_all ()
  Set the image dirty count to 0.
• public bool convert_color_profile (ColorProfile? profile, ColorRenderingIntent intent, bool bpc)
  This procedure converts from the image's color profile (or the built-in profile if none is set) to the given color profile.
• public bool convert_color_profile_from_file (File file, ColorRenderingIntent intent, bool bpc)
  Convert the image's layers to a color profile
• public bool convert_grayscale ()
  Convert specified image to grayscale
• public bool convert_indexed (ConvertDitherType dither_type, ConvertPaletteType palette_type, int num_cols, bool alpha_dither, bool remove_unused, string palette)
  Convert specified image to and Indexed image
• public bool convert_precision (Precision precision)
  Convert the image to the specified precision
• public bool convert_rgb ()
  Convert specified image to RGB color
• public bool crop (int new_width, int new_height, int offx, int offy)
  Crop the image to the specified extents.
• public bool delete_guide (uint guide)
  Deletes a guide from an image.
• public bool delete_sample_point (uint sample_point)
  Deletes a sample point from an image.
• public bool detach_parasite (string name)
  Removes a parasite from an image.
• public unowned Image duplicate ()
  Duplicate the specified image
• public bool export_path_to_file (File file, Path? path)
  save a path as an SVG file.
• public string export_path_to_string (Path? path)
  Save a path as an SVG string.
• public uint find_next_guide (int guide)
  Find next guide on an image.
• public uint find_next_sample_point (uint sample_point)
  Find next sample point on an image.
• public unowned Layer flatten ()
  Flatten all visible layers into a single layer.
• public bool flip (OrientationType flip_type)
  Flips the image horizontally or vertically.
• public unowned Drawable floating_sel_attached_to ()
  Return the drawable the floating selection is attached to.
• public bool freeze_channels ()
  Freeze the image's channel list.
• public bool freeze_layers ()
  Freeze the image's layer list.
• public bool freeze_paths ()
  Freeze the image's path list.
• public ImageBaseType get_base_type ()
  Get the base type of the image.
• public unowned Channel get_channel_by_name (string name)
  Find a channel with a given name in an image.
• public unowned Channel get_channel_by_tattoo (uint tattoo)
  Find a channel with a given tattoo in an image.
• public (unowned Channel)[] get_channels ()
  Returns the list of channels contained in the specified image.
• public ColorProfile? get_color_profile ()
  This procedure returns the image's color profile, or null if the image uses the built-in color profile.
• public bool get_component_active (ChannelType component)
  Returns if the specified image's image component is active.
• public bool get_component_visible (ChannelType component)
  Returns if the specified image's image component is visible.
• public LayerMode get_default_new_layer_mode ()
  Get the default mode for newly created layers of this image.
• public ColorProfile get_effective_color_profile ()
  This procedure returns the color profile that is actually used for this image, which is the profile returned by [method@Gimp.
• public File get_exported_file ()
  Returns the exported file for the specified image.
• public File get_file ()
  Returns the file for the specified image.
• public unowned Layer get_floating_sel ()
  Return the floating selection of the image.
• public OrientationType get_guide_orientation (uint guide)
  Get orientation of a guide on an image.
• public int get_guide_position (uint guide)
  Get position of a guide on an image.
• public int get_height ()
  Return the height of the image
• public int32 get_id ()
• public File get_imported_file ()
  Returns the imported file for the specified image.
• public int get_item_position (Item item)
  Returns the position of the item in its level of its item tree.
• public unowned Layer get_layer_by_name (string name)
  Find a layer with a given name in an image.
• public unowned Layer get_layer_by_tattoo (uint tattoo)
  Find a layer with a given tattoo in an image.
• public (unowned Layer)[] get_layers ()
  Returns the list of root layers contained in the specified image.
• public Metadata? get_metadata ()
  Returns the image's metadata.
• public string get_name ()
  Returns the specified image's name.
• public unowned Palette get_palette ()
  Returns the image's colormap
• public Parasite get_parasite (string name)
  Look up a parasite in an image
• public string[] get_parasite_list ()
  List all parasites.
• public unowned Path get_path_by_name (string name)
  Find a path with a given name in an image.
• public unowned Path get_path_by_tattoo (uint tattoo)
  Find a path with a given tattoo in an image.
• public (unowned Path)[] get_paths ()
  Returns the list of paths contained in the specified image.
• public Precision get_precision ()
  Get the precision of the image.
• public bool get_resolution (out double xresolution, out double yresolution)
  Returns the specified image's resolution.
• public int get_sample_point_position (uint sample_point, out int position_y)
  Get position of a sample point on an image.
• public (unowned Channel)[] get_selected_channels ()
  Returns the specified image's selected channels.
• public (unowned Drawable)[] get_selected_drawables ()
  Get the image's selected drawables
• public (unowned Layer)[] get_selected_layers ()
  Returns the specified image's selected layers.
• public (unowned Path)[] get_selected_paths ()
  Returns the specified image's selected paths.
• public unowned Selection get_selection ()
  Returns the specified image's selection.
• public bool get_simulation_bpc ()
  Returns whether the image has Black Point Compensation enabled for its simulation
• public ColorRenderingIntent get_simulation_intent ()
  Returns the image's simulation rendering intent
• public ColorProfile? get_simulation_profile ()
  This procedure returns the image's simulation color profile, or null if the image has no simulation color profile assigned.
• public uint get_tattoo_state ()
  Returns the tattoo state associated with the image.
• public Pixbuf get_thumbnail (int width, int height, PixbufTransparency alpha)
  Retrieves a thumbnail pixbuf for this .
• public Bytes get_thumbnail_data (ref int width, ref int height, out int bpp)
  Get a thumbnail of an image.
• public unowned Unit get_unit ()
  Returns the specified image's unit.
• public int get_width ()
  Return the width of the image
• public File get_xcf_file ()
  Returns the XCF file for the specified image.
• public Color grid_get_background_color ()
  Sets the background color of an image's grid.
• public Color grid_get_foreground_color ()
  Sets the foreground color of an image's grid.
• public bool grid_get_offset (out double xoffset, out double yoffset)
  Gets the offset of an image's grid.
• public bool grid_get_spacing (out double xspacing, out double yspacing)
  Gets the spacing of an image's grid.
• public GridStyle grid_get_style ()
  Gets the style of an image's grid.
• public bool grid_set_background_color (Color bgcolor)
  Gets the background color of an image's grid.
• public bool grid_set_foreground_color (Color fgcolor)
  Gets the foreground color of an image's grid.
• public bool grid_set_offset (double xoffset, double yoffset)
  Sets the offset of an image's grid.
• public bool grid_set_spacing (double xspacing, double yspacing)
  Sets the spacing of an image's grid.
• public bool grid_set_style (GridStyle style)
  Sets the style unit of an image's grid.
• public bool import_paths_from_file (File file, bool merge, bool scale, out (unowned Path)[] paths)
  Import paths from an SVG file.
• public bool import_paths_from_string (string string, int length, bool merge, bool scale, out (unowned Path)[] paths)
  Import paths from an SVG string.
• public bool insert_channel (Channel channel, Channel? parent, int position)
  Add the specified channel to the image.
• public bool insert_layer (Layer layer, Layer? parent, int position)
  Add the specified layer to the image.
• public bool insert_path (Path path, Path? parent, int position)
  Add the specified path to the image.
• public bool is_dirty ()
  Checks if the image has unsaved changes.
• public bool is_valid ()
  Returns TRUE if the image is valid.
• public bool lower_item (Item item)
  Lower the specified item in its level in its item tree
• public bool lower_item_to_bottom (Item item)
  Lower the specified item to the bottom of its level in its item tree
• public unowned Layer merge_down (Layer merge_layer, MergeType merge_type)
  Merge the layer passed and the first visible layer below.
• public unowned Layer merge_visible_layers (MergeType merge_type)
  Merge the visible image layers into one.
• public Metadata metadata_save_filter (string mime_type, Metadata metadata, MetadataSaveFlags flags, File file) throws Error
  Filters the metadata retrieved from the image with [ method@Gimp.
• public Metadata metadata_save_prepare (string mime_type, MetadataSaveFlags suggested_flags)
  Gets the image metadata for storing it in an exported file.
• public bool pick_color (Drawable[] drawables, double x, double y, bool sample_merged, bool sample_average, double average_radius, out Color color)
  Determine the color at the given coordinates
• public unowned Layer pick_correlate_layer (int x, int y)
  Find the layer visible at the specified coordinates.
• public bool policy_color_profile (bool interactive)
  Execute the color profile conversion policy.
• public bool policy_rotate (bool interactive)
  Execute the \"Orientation\" metadata policy.
• public bool raise_item (Item item)
  Raise the specified item in its level in its item tree
• public bool raise_item_to_top (Item item)
  Raise the specified item to the top of its level in its item tree
• public bool remove_channel (Channel channel)
  Remove the specified channel from the image.
• public bool remove_layer (Layer layer)
  Remove the specified layer from the image.
• public bool remove_path (Path path)
  Remove the specified path from the image.
• public bool reorder_item (Item item, Item? parent, int position)
  Reorder the specified item within its item tree
• public bool resize (int new_width, int new_height, int offx, int offy)
  Resize the image to the specified extents.
• public bool resize_to_layers ()
  Resize the image to fit all layers.
• public bool rotate (RotationType rotate_type)
  Rotates the image by the specified degrees.
• public bool scale (int new_width, int new_height)
  Scale the image using the default interpolation method.
• public bool select_color (ChannelOps operation, Drawable drawable, Color color)
  Create a selection by selecting all pixels (in the specified drawable) with the same (or similar) color to that specified.
• public bool select_contiguous_color (ChannelOps operation, Drawable drawable, double x, double y)
  Create a selection by selecting all pixels around specified coordinates with the same (or similar) color to that at the coordinates.
• public bool select_ellipse (ChannelOps operation, double x, double y, double width, double height)
  Create an elliptical selection over the specified image.
• public bool select_item (ChannelOps operation, Item item)
  Transforms the specified item into a selection
• public bool select_polygon (ChannelOps operation, double[] segs)
  Create a polygonal selection over the specified image.
• public bool select_rectangle (ChannelOps operation, double x, double y, double width, double height)
  Create a rectangular selection over the specified image;
• public bool select_round_rectangle (ChannelOps operation, double x, double y, double width, double height, double corner_radius_x, double corner_radius_y)
  Create a rectangular selection with round corners over the specified image;
• public bool set_color_profile (ColorProfile? profile)
  This procedure sets the image's color profile.
• public bool set_color_profile_from_file (File file)
  Sets the image's color profile from an ICC file
• public bool set_component_active (ChannelType component, bool active)
  Sets if the specified image's image component is active.
• public bool set_component_visible (ChannelType component, bool visible)
  Sets if the specified image's image component is visible.
• public bool set_file (File file)
  Sets the specified XCF image's file.
• public bool set_metadata (Metadata metadata)
  Set the image's metadata.
• public unowned Palette set_palette (Palette new_palette)
  Set the image's colormap to a copy of palette
• public bool set_resolution (double xresolution, double yresolution)
  Sets the specified image's resolution.
• public bool set_selected_channels (Channel[] channels)
  Sets the specified image's selected channels.
• public bool set_selected_layers (Layer[] layers)
  Sets the specified image's selected layers.
• public bool set_selected_paths (Path[] paths)
  Sets the specified image's selected paths.
• public bool set_simulation_bpc (bool bpc)
  Sets whether the image has Black Point Compensation enabled for its simulation
• public bool set_simulation_intent (ColorRenderingIntent intent)
  Sets the image's simulation rendering intent
• public bool set_simulation_profile (ColorProfile? profile)
  This procedure sets the image's simulation color profile.
• public bool set_simulation_profile_from_file (File file)
  Sets the image's simulation color profile from an ICC file
• public bool set_tattoo_state (uint tattoo_state)
  Set the tattoo state associated with the image.
• public bool set_unit (Unit unit)
  Sets the specified image's unit.
• public bool take_selected_channels (owned List<unowned Channel> channels)
  The channels are set as the selected channels in the image.
• public bool take_selected_layers (owned List<unowned Layer> layers)
  The layers are set as the selected layers in the image.
• public bool take_selected_paths (owned List<unowned Path> paths)
  The paths are set as the selected paths in the image.
• public bool thaw_channels ()
  Thaw the image's channel list.
• public bool thaw_layers ()
  Thaw the image's layer list.
• public bool thaw_paths ()
  Thaw the image's path list.
• public bool undo_disable ()
  Disable the image's undo stack.
• public bool undo_enable ()
  Enable the image's undo stack.
• public bool undo_freeze ()
  Freeze the image's undo stack.
• public bool undo_group_end ()
  Finish a group undo.
• public bool undo_group_start ()
  Starts a group undo.
• public bool undo_is_enabled ()
  Check if the image's undo stack is enabled.
• public bool undo_thaw ()
  Thaw the image's undo stack.
• public bool unset_active_channel ()
  Unsets the active channel in the specified image.

Inherited Members: