diff options
Diffstat (limited to 'devel-docs/libgimp/html/libgimp-gimpimage.html')
| -rw-r--r-- | devel-docs/libgimp/html/libgimp-gimpimage.html | 4857 |
1 files changed, 4857 insertions, 0 deletions
diff --git a/devel-docs/libgimp/html/libgimp-gimpimage.html b/devel-docs/libgimp/html/libgimp-gimpimage.html new file mode 100644 index 0000000..c6112bc --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpimage.html @@ -0,0 +1,4857 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>gimpimage: GIMP Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="GIMP Library Reference Manual"> +<link rel="up" href="libgimp-image.html" title="Manipulating Images and their Properties"> +<link rel="prev" href="libgimp-gimpfloatingsel.html" title="gimpfloatingsel"> +<link rel="next" href="libgimp-gimpimagecolorprofile.html" title="gimpimagecolorprofile"> +<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#libgimp-gimpimage.description" class="shortcut">Description</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="libgimp-gimpfloatingsel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="libgimp-gimpimagecolorprofile.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="libgimp-gimpimage"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libgimp-gimpimage.top_of_page"></a>gimpimage</span></h2> +<p>gimpimage — Operations on complete images.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="libgimp-gimpimage.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_proto_type"> +<col class="functions_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<span class="returnvalue">gint</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-list" title="gimp_image_list ()">gimp_image_list</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-new" title="gimp_image_new ()">gimp_image_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-new-with-precision" title="gimp_image_new_with_precision ()">gimp_image_new_with_precision</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gchar</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-uri" title="gimp_image_get_uri ()">gimp_image_get_uri</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gchar</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-xcf-uri" title="gimp_image_get_xcf_uri ()">gimp_image_get_xcf_uri</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gchar</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-exported-uri" title="gimp_image_get_exported_uri ()">gimp_image_get_exported_uri</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gchar</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-imported-uri" title="gimp_image_get_imported_uri ()">gimp_image_get_imported_uri</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-duplicate" title="gimp_image_duplicate ()">gimp_image_duplicate</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-delete" title="gimp_image_delete ()">gimp_image_delete</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-is-valid" title="gimp_image_is_valid ()">gimp_image_is_valid</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../html/libgimpbase-gimpbaseenums.html#GimpImageBaseType"><span class="returnvalue">GimpImageBaseType</span></a> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-base-type" title="gimp_image_base_type ()">gimp_image_base_type</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../html/libgimpbase-gimpbaseenums.html#GimpPrecision"><span class="returnvalue">GimpPrecision</span></a> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-precision" title="gimp_image_get_precision ()">gimp_image_get_precision</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="libgimp-gimpenums.html#GimpLayerMode" title="enum GimpLayerMode"><span class="returnvalue">GimpLayerMode</span></a> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-default-new-layer-mode" title="gimp_image_get_default_new_layer_mode ()">gimp_image_get_default_new_layer_mode</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-width" title="gimp_image_width ()">gimp_image_width</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-height" title="gimp_image_height ()">gimp_image_height</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-free-shadow" title="gimp_image_free_shadow ()">gimp_image_free_shadow</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-layers" title="gimp_image_get_layers ()">gimp_image_get_layers</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-channels" title="gimp_image_get_channels ()">gimp_image_get_channels</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-active-drawable" title="gimp_image_get_active_drawable ()">gimp_image_get_active_drawable</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-floating-sel" title="gimp_image_get_floating_sel ()">gimp_image_get_floating_sel</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-floating-sel-attached-to" title="gimp_image_floating_sel_attached_to ()">gimp_image_floating_sel_attached_to</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-pick-color" title="gimp_image_pick_color ()">gimp_image_pick_color</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-pick-correlate-layer" title="gimp_image_pick_correlate_layer ()">gimp_image_pick_correlate_layer</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-item-position" title="gimp_image_get_item_position ()">gimp_image_get_item_position</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-reorder-item" title="gimp_image_reorder_item ()">gimp_image_reorder_item</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-raise-item" title="gimp_image_raise_item ()">gimp_image_raise_item</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-lower-item" title="gimp_image_lower_item ()">gimp_image_lower_item</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-raise-item-to-top" title="gimp_image_raise_item_to_top ()">gimp_image_raise_item_to_top</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-lower-item-to-bottom" title="gimp_image_lower_item_to_bottom ()">gimp_image_lower_item_to_bottom</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-add-layer" title="gimp_image_add_layer ()">gimp_image_add_layer</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-insert-layer" title="gimp_image_insert_layer ()">gimp_image_insert_layer</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-remove-layer" title="gimp_image_remove_layer ()">gimp_image_remove_layer</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-freeze-layers" title="gimp_image_freeze_layers ()">gimp_image_freeze_layers</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-thaw-layers" title="gimp_image_thaw_layers ()">gimp_image_thaw_layers</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-raise-layer" title="gimp_image_raise_layer ()">gimp_image_raise_layer</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-lower-layer" title="gimp_image_lower_layer ()">gimp_image_lower_layer</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-raise-layer-to-top" title="gimp_image_raise_layer_to_top ()">gimp_image_raise_layer_to_top</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-lower-layer-to-bottom" title="gimp_image_lower_layer_to_bottom ()">gimp_image_lower_layer_to_bottom</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-layer-position" title="gimp_image_get_layer_position ()">gimp_image_get_layer_position</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-add-channel" title="gimp_image_add_channel ()">gimp_image_add_channel</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-insert-channel" title="gimp_image_insert_channel ()">gimp_image_insert_channel</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-remove-channel" title="gimp_image_remove_channel ()">gimp_image_remove_channel</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-freeze-channels" title="gimp_image_freeze_channels ()">gimp_image_freeze_channels</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-thaw-channels" title="gimp_image_thaw_channels ()">gimp_image_thaw_channels</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-raise-channel" title="gimp_image_raise_channel ()">gimp_image_raise_channel</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-lower-channel" title="gimp_image_lower_channel ()">gimp_image_lower_channel</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-channel-position" title="gimp_image_get_channel_position ()">gimp_image_get_channel_position</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-flatten" title="gimp_image_flatten ()">gimp_image_flatten</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-merge-visible-layers" title="gimp_image_merge_visible_layers ()">gimp_image_merge_visible_layers</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-merge-down" title="gimp_image_merge_down ()">gimp_image_merge_down</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-merge-layer-group" title="gimp_image_merge_layer_group ()">gimp_image_merge_layer_group</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-clean-all" title="gimp_image_clean_all ()">gimp_image_clean_all</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-is-dirty" title="gimp_image_is_dirty ()">gimp_image_is_dirty</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-active-layer" title="gimp_image_get_active_layer ()">gimp_image_get_active_layer</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-set-active-layer" title="gimp_image_set_active_layer ()">gimp_image_set_active_layer</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-active-channel" title="gimp_image_get_active_channel ()">gimp_image_get_active_channel</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-set-active-channel" title="gimp_image_set_active_channel ()">gimp_image_set_active_channel</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-unset-active-channel" title="gimp_image_unset_active_channel ()">gimp_image_unset_active_channel</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-selection" title="gimp_image_get_selection ()">gimp_image_get_selection</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-component-active" title="gimp_image_get_component_active ()">gimp_image_get_component_active</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-set-component-active" title="gimp_image_set_component_active ()">gimp_image_set_component_active</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-component-visible" title="gimp_image_get_component_visible ()">gimp_image_get_component_visible</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-set-component-visible" title="gimp_image_set_component_visible ()">gimp_image_set_component_visible</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gchar</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-filename" title="gimp_image_get_filename ()">gimp_image_get_filename</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-set-filename" title="gimp_image_set_filename ()">gimp_image_set_filename</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gchar</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-name" title="gimp_image_get_name ()">gimp_image_get_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-resolution" title="gimp_image_get_resolution ()">gimp_image_get_resolution</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-set-resolution" title="gimp_image_set_resolution ()">gimp_image_set_resolution</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../html/libgimpbase-gimpunit.html#GimpUnit"><span class="returnvalue">GimpUnit</span></a> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-unit" title="gimp_image_get_unit ()">gimp_image_get_unit</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-set-unit" title="gimp_image_set_unit ()">gimp_image_set_unit</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-set-tattoo-state" title="gimp_image_set_tattoo_state ()">gimp_image_set_tattoo_state</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-tattoo-state" title="gimp_image_get_tattoo_state ()">gimp_image_get_tattoo_state</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-layer-by-tattoo" title="gimp_image_get_layer_by_tattoo ()">gimp_image_get_layer_by_tattoo</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-channel-by-tattoo" title="gimp_image_get_channel_by_tattoo ()">gimp_image_get_channel_by_tattoo</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-vectors-by-tattoo" title="gimp_image_get_vectors_by_tattoo ()">gimp_image_get_vectors_by_tattoo</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-layer-by-name" title="gimp_image_get_layer_by_name ()">gimp_image_get_layer_by_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-channel-by-name" title="gimp_image_get_channel_by_name ()">gimp_image_get_channel_by_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-vectors-by-name" title="gimp_image_get_vectors_by_name ()">gimp_image_get_vectors_by_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">guchar</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-cmap" title="gimp_image_get_cmap ()">gimp_image_get_cmap</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-set-cmap" title="gimp_image_set_cmap ()">gimp_image_set_cmap</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">guchar</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-colormap" title="gimp_image_get_colormap ()">gimp_image_get_colormap</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-set-colormap" title="gimp_image_set_colormap ()">gimp_image_set_colormap</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-vectors" title="gimp_image_get_vectors ()">gimp_image_get_vectors</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">guchar</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-thumbnail-data" title="gimp_image_get_thumbnail_data ()">gimp_image_get_thumbnail_data</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../html/libgimpbase-GimpMetadata.html#GimpMetadata"><span class="returnvalue">GimpMetadata</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-metadata" title="gimp_image_get_metadata ()">gimp_image_get_metadata</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-set-metadata" title="gimp_image_set_metadata ()">gimp_image_set_metadata</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-attach-parasite" title="gimp_image_attach_parasite ()">gimp_image_attach_parasite</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-detach-parasite" title="gimp_image_detach_parasite ()">gimp_image_detach_parasite</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../html/libgimpbase-GimpParasite.html#GimpParasite"><span class="returnvalue">GimpParasite</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-parasite" title="gimp_image_get_parasite ()">gimp_image_get_parasite</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gchar</span> ** +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-parasite-list" title="gimp_image_get_parasite_list ()">gimp_image_get_parasite_list</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="../html/libgimpbase-GimpParasite.html#GimpParasite"><span class="returnvalue">GimpParasite</span></a> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-parasite-find" title="gimp_image_parasite_find ()">gimp_image_parasite_find</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-parasite-list" title="gimp_image_parasite_list ()">gimp_image_parasite_list</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-parasite-attach" title="gimp_image_parasite_attach ()">gimp_image_parasite_attach</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-parasite-detach" title="gimp_image_parasite_detach ()">gimp_image_parasite_detach</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-attach-new-parasite" title="gimp_image_attach_new_parasite ()">gimp_image_attach_new_parasite</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-add-vectors" title="gimp_image_add_vectors ()">gimp_image_add_vectors</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-insert-vectors" title="gimp_image_insert_vectors ()">gimp_image_insert_vectors</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-remove-vectors" title="gimp_image_remove_vectors ()">gimp_image_remove_vectors</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-freeze-vectors" title="gimp_image_freeze_vectors ()">gimp_image_freeze_vectors</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-thaw-vectors" title="gimp_image_thaw_vectors ()">gimp_image_thaw_vectors</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint32</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-active-vectors" title="gimp_image_get_active_vectors ()">gimp_image_get_active_vectors</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-set-active-vectors" title="gimp_image_set_active_vectors ()">gimp_image_set_active_vectors</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-lower-vectors" title="gimp_image_lower_vectors ()">gimp_image_lower_vectors</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-raise-vectors" title="gimp_image_raise_vectors ()">gimp_image_raise_vectors</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-lower-vectors-to-bottom" title="gimp_image_lower_vectors_to_bottom ()">gimp_image_lower_vectors_to_bottom</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-raise-vectors-to-top" title="gimp_image_raise_vectors_to_top ()">gimp_image_raise_vectors_to_top</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-vectors-position" title="gimp_image_get_vectors_position ()">gimp_image_get_vectors_position</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libgimp-gimpimage.description"></a><h2>Description</h2> +<p>Operations on complete images: creation, resizing/rescaling, and +operations involving multiple layers.</p> +</div> +<div class="refsect1"> +<a name="libgimp-gimpimage.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="gimp-image-list"></a><h3>gimp_image_list ()</h3> +<pre class="programlisting"><span class="returnvalue">gint</span> * +gimp_image_list (<em class="parameter"><code><span class="type">gint</span> *num_images</code></em>);</pre> +<p>Returns the list of images currently open.</p> +<p>This procedure returns the list of images currently open in GIMP.</p> +<div class="refsect3"> +<a name="gimp-image-list.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>num_images</p></td> +<td class="parameter_description"><p>The number of images currently open.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-list.returns"></a><h4>Returns</h4> +<p> The list of images currently open. The returned value must +be freed with <code class="function">g_free()</code>.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-new"></a><h3>gimp_image_new ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_new (<em class="parameter"><code><span class="type">gint</span> width</code></em>, + <em class="parameter"><code><span class="type">gint</span> height</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpImageBaseType"><span class="type">GimpImageBaseType</span></a> type</code></em>);</pre> +<p>Creates a new image with the specified width, height, and type.</p> +<p>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 <a class="link" href="libgimp-gimpdisplay.html#gimp-display-new" title="gimp_display_new ()"><code class="function">gimp_display_new()</code></a> with this image +as an argument will fail. Layers can be created using the +<a class="link" href="libgimp-gimplayer.html#gimp-layer-new" title="gimp_layer_new ()"><code class="function">gimp_layer_new()</code></a> commands. They can be added to an image using the +<a class="link" href="libgimp-gimpimage.html#gimp-image-insert-layer" title="gimp_image_insert_layer ()"><code class="function">gimp_image_insert_layer()</code></a> command.</p> +<p>If your image's type if INDEXED, a colormap must also be added with +<a class="link" href="libgimp-gimpimage.html#gimp-image-set-colormap" title="gimp_image_set_colormap ()"><code class="function">gimp_image_set_colormap()</code></a>. An indexed image without a colormap will +output unexpected colors.</p> +<div class="refsect3"> +<a name="gimp-image-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>width</p></td> +<td class="parameter_description"><p>The width of the image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>height</p></td> +<td class="parameter_description"><p>The height of the image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>type</p></td> +<td class="parameter_description"><p>The type of image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-new.returns"></a><h4>Returns</h4> +<p> The ID of the newly created image.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-new-with-precision"></a><h3>gimp_image_new_with_precision ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_new_with_precision (<em class="parameter"><code><span class="type">gint</span> width</code></em>, + <em class="parameter"><code><span class="type">gint</span> height</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpImageBaseType"><span class="type">GimpImageBaseType</span></a> type</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpPrecision"><span class="type">GimpPrecision</span></a> precision</code></em>);</pre> +<p>Creates a new image with the specified width, height, type and +precision.</p> +<p>Creates a new image, undisplayed with the specified extents, type +and precision. Indexed images can only be created at +GIMP_PRECISION_U8_GAMMA precision. See <a class="link" href="libgimp-gimpimage.html#gimp-image-new" title="gimp_image_new ()"><code class="function">gimp_image_new()</code></a> for further +details.</p> +<div class="refsect3"> +<a name="gimp-image-new-with-precision.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>width</p></td> +<td class="parameter_description"><p>The width of the image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>height</p></td> +<td class="parameter_description"><p>The height of the image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>type</p></td> +<td class="parameter_description"><p>The type of image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>precision</p></td> +<td class="parameter_description"><p>The precision.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-new-with-precision.returns"></a><h4>Returns</h4> +<p> The ID of the newly created image.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-uri"></a><h3>gimp_image_get_uri ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> * +gimp_image_get_uri (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Returns the URI for the specified image.</p> +<p>This procedure returns the URI associated with the specified image. +The image has an URI only if it was loaded or imported from a file +or has since been saved or exported. Otherwise, this function +returns <code class="literal">NULL</code>. See also gimp-image-get-imported-uri to get the URI +of the current file if it was imported from a non-GIMP file format +and not yet saved, or gimp-image-get-exported-uri if the image has +been exported to a non-GIMP file format.</p> +<div class="refsect3"> +<a name="gimp-image-get-uri.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-uri.returns"></a><h4>Returns</h4> +<p> The URI. The returned value must be freed with <code class="function">g_free()</code>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-xcf-uri"></a><h3>gimp_image_get_xcf_uri ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> * +gimp_image_get_xcf_uri (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Returns the XCF URI for the specified image.</p> +<p>This procedure returns the XCF URI associated with the image. If +there is no such URI, this procedure returns <code class="literal">NULL</code>.</p> +<div class="refsect3"> +<a name="gimp-image-get-xcf-uri.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-xcf-uri.returns"></a><h4>Returns</h4> +<p> The imported URI. The returned value must be freed with +<code class="function">g_free()</code>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-exported-uri"></a><h3>gimp_image_get_exported_uri ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> * +gimp_image_get_exported_uri (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Returns the exported URI for the specified image.</p> +<p>This procedure returns the URI associated with the specified image +if the image was exported a non-native GIMP format. If the image was +not exported, this procedure returns <code class="literal">NULL</code>.</p> +<div class="refsect3"> +<a name="gimp-image-get-exported-uri.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-exported-uri.returns"></a><h4>Returns</h4> +<p> The exported URI. The returned value must be freed with +<code class="function">g_free()</code>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-imported-uri"></a><h3>gimp_image_get_imported_uri ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> * +gimp_image_get_imported_uri (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Returns the imported URI for the specified image.</p> +<p>This procedure returns the URI associated with the specified image +if the image was imported from a non-native Gimp format. If the +image was not imported, or has since been saved in the native Gimp +format, this procedure returns <code class="literal">NULL</code>.</p> +<div class="refsect3"> +<a name="gimp-image-get-imported-uri.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-imported-uri.returns"></a><h4>Returns</h4> +<p> The imported URI. The returned value must be freed with +<code class="function">g_free()</code>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-duplicate"></a><h3>gimp_image_duplicate ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_duplicate (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Duplicate the specified image</p> +<p>This procedure duplicates the specified image, copying all layers, +channels, and image information.</p> +<div class="refsect3"> +<a name="gimp-image-duplicate.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-duplicate.returns"></a><h4>Returns</h4> +<p> The new, duplicated image.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-delete"></a><h3>gimp_image_delete ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_delete (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Delete the specified image.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-delete.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-delete.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-is-valid"></a><h3>gimp_image_is_valid ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_is_valid (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Returns TRUE if the image is valid.</p> +<p>This procedure checks if the given image ID is valid and refers to +an existing image.</p> +<div class="refsect3"> +<a name="gimp-image-is-valid.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image to check.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-is-valid.returns"></a><h4>Returns</h4> +<p> Whether the image ID is valid.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-base-type"></a><h3>gimp_image_base_type ()</h3> +<pre class="programlisting"><a href="../html/libgimpbase-gimpbaseenums.html#GimpImageBaseType"><span class="returnvalue">GimpImageBaseType</span></a> +gimp_image_base_type (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Get the base type of the image.</p> +<p>This procedure returns the image's base type. Layers in the image +must be of this subtype, but can have an optional alpha channel.</p> +<div class="refsect3"> +<a name="gimp-image-base-type.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-base-type.returns"></a><h4>Returns</h4> +<p> The image's base type.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-precision"></a><h3>gimp_image_get_precision ()</h3> +<pre class="programlisting"><a href="../html/libgimpbase-gimpbaseenums.html#GimpPrecision"><span class="returnvalue">GimpPrecision</span></a> +gimp_image_get_precision (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Get the precision of the image.</p> +<p>This procedure returns the image's precision.</p> +<div class="refsect3"> +<a name="gimp-image-get-precision.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-precision.returns"></a><h4>Returns</h4> +<p> The image's precision.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-default-new-layer-mode"></a><h3>gimp_image_get_default_new_layer_mode ()</h3> +<pre class="programlisting"><a class="link" href="libgimp-gimpenums.html#GimpLayerMode" title="enum GimpLayerMode"><span class="returnvalue">GimpLayerMode</span></a> +gimp_image_get_default_new_layer_mode (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Get the default mode for newly created layers of this image.</p> +<p>Returns the default mode for newly created layers of this image.</p> +<div class="refsect3"> +<a name="gimp-image-get-default-new-layer-mode.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-default-new-layer-mode.returns"></a><h4>Returns</h4> +<p> The layer mode.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-width"></a><h3>gimp_image_width ()</h3> +<pre class="programlisting"><span class="returnvalue">gint</span> +gimp_image_width (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Return the width of the image</p> +<p>This procedure returns the image's width. This value is independent +of any of the layers in this image. This is the \"canvas\" width.</p> +<div class="refsect3"> +<a name="gimp-image-width.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-width.returns"></a><h4>Returns</h4> +<p> The image's width.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-height"></a><h3>gimp_image_height ()</h3> +<pre class="programlisting"><span class="returnvalue">gint</span> +gimp_image_height (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Return the height of the image</p> +<p>This procedure returns the image's height. This value is independent +of any of the layers in this image. This is the \"canvas\" height.</p> +<div class="refsect3"> +<a name="gimp-image-height.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-height.returns"></a><h4>Returns</h4> +<p> The image's height.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-free-shadow"></a><h3>gimp_image_free_shadow ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_free_shadow (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_free_shadow</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpdrawable.html#gimp-drawable-free-shadow" title="gimp_drawable_free_shadow ()"><code class="function">gimp_drawable_free_shadow()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-free-shadow.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-free-shadow.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-layers"></a><h3>gimp_image_get_layers ()</h3> +<pre class="programlisting"><span class="returnvalue">gint</span> * +gimp_image_get_layers (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> *num_layers</code></em>);</pre> +<p>Returns the list of layers contained in the specified image.</p> +<p>This procedure returns the list of layers contained in the specified +image. The order of layers is from topmost to bottommost.</p> +<div class="refsect3"> +<a name="gimp-image-get-layers.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>num_layers</p></td> +<td class="parameter_description"><p>The number of layers contained in the image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-layers.returns"></a><h4>Returns</h4> +<p> The list of layers contained in the image. The returned +value must be freed with <code class="function">g_free()</code>.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-channels"></a><h3>gimp_image_get_channels ()</h3> +<pre class="programlisting"><span class="returnvalue">gint</span> * +gimp_image_get_channels (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> *num_channels</code></em>);</pre> +<p>Returns the list of channels contained in the specified image.</p> +<p>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. Note that +\"channels\" are custom channels and do not include the image's +color components.</p> +<div class="refsect3"> +<a name="gimp-image-get-channels.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>num_channels</p></td> +<td class="parameter_description"><p>The number of channels contained in the image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-channels.returns"></a><h4>Returns</h4> +<p> The list of channels contained in the image. The returned +value must be freed with <code class="function">g_free()</code>.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-active-drawable"></a><h3>gimp_image_get_active_drawable ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_get_active_drawable (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Get the image's active drawable</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-get-active-drawable.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-active-drawable.returns"></a><h4>Returns</h4> +<p> The active drawable.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-floating-sel"></a><h3>gimp_image_get_floating_sel ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_get_floating_sel (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Return the floating selection of the image.</p> +<p>This procedure returns the image's floating selection, if it exists. +If it doesn't exist, -1 is returned as the layer ID.</p> +<div class="refsect3"> +<a name="gimp-image-get-floating-sel.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-floating-sel.returns"></a><h4>Returns</h4> +<p> The image's floating selection.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-floating-sel-attached-to"></a><h3>gimp_image_floating_sel_attached_to ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_floating_sel_attached_to (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Return the drawable the floating selection is attached to.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-floating-sel-attached-to.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-floating-sel-attached-to.returns"></a><h4>Returns</h4> +<p> The drawable the floating selection is attached to.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-pick-color"></a><h3>gimp_image_pick_color ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_pick_color (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> drawable_ID</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> x</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> y</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> sample_merged</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> sample_average</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> average_radius</code></em>, + <em class="parameter"><code><a href="../html/libgimpcolor-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *color</code></em>);</pre> +<p>Determine the color at the given drawable coordinates</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-pick-color.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>drawable_ID</p></td> +<td class="parameter_description"><p>The drawable to pick from.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>x</p></td> +<td class="parameter_description"><p>x coordinate of upper-left corner of rectangle.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>y</p></td> +<td class="parameter_description"><p>y coordinate of upper-left corner of rectangle.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>sample_merged</p></td> +<td class="parameter_description"><p>Use the composite image, not the drawable.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>sample_average</p></td> +<td class="parameter_description"><p>Average the color of all the pixels in a specified radius.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>average_radius</p></td> +<td class="parameter_description"><p>The radius of pixels to average.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>color</p></td> +<td class="parameter_description"><p>The return color.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-pick-color.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-pick-correlate-layer"></a><h3>gimp_image_pick_correlate_layer ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_pick_correlate_layer (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> x</code></em>, + <em class="parameter"><code><span class="type">gint</span> y</code></em>);</pre> +<p>Find the layer visible at the specified coordinates.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-pick-correlate-layer.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>x</p></td> +<td class="parameter_description"><p>The x coordinate for the pick.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>y</p></td> +<td class="parameter_description"><p>The y coordinate for the pick.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-pick-correlate-layer.returns"></a><h4>Returns</h4> +<p> The layer found at the specified coordinates.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-item-position"></a><h3>gimp_image_get_item_position ()</h3> +<pre class="programlisting"><span class="returnvalue">gint</span> +gimp_image_get_item_position (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Returns the position of the item in its level of its item tree.</p> +<p>This procedure determines the position of the specified item in its +level in its item tree in the image. If the item doesn't exist in +the image, or the item is not part of an item tree, an error is +returned.</p> +<div class="refsect3"> +<a name="gimp-image-get-item-position.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-item-position.returns"></a><h4>Returns</h4> +<p> The position of the item in its level in the item tree.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-reorder-item"></a><h3>gimp_image_reorder_item ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_reorder_item (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> parent_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> position</code></em>);</pre> +<p>Reorder the specified item within its item tree</p> +<p>This procedure reorders the specified item within its item tree.</p> +<div class="refsect3"> +<a name="gimp-image-reorder-item.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item to reorder.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>parent_ID</p></td> +<td class="parameter_description"><p>The new parent item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>position</p></td> +<td class="parameter_description"><p>The new position of the item.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-reorder-item.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-raise-item"></a><h3>gimp_image_raise_item ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_raise_item (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Raise the specified item in its level in its item tree</p> +<p>This procedure raises the specified item one step in the item tree. +The procedure call will fail if there is no item above it.</p> +<div class="refsect3"> +<a name="gimp-image-raise-item.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item to raise.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-raise-item.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-lower-item"></a><h3>gimp_image_lower_item ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_lower_item (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Lower the specified item in its level in its item tree</p> +<p>This procedure lowers the specified item one step in the item tree. +The procedure call will fail if there is no item below it.</p> +<div class="refsect3"> +<a name="gimp-image-lower-item.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item to lower.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-lower-item.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-raise-item-to-top"></a><h3>gimp_image_raise_item_to_top ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_raise_item_to_top (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Raise the specified item to the top of its level in its item tree</p> +<p>This procedure raises the specified item to top of its level in the +item tree. It will not move the item if there is no item above it.</p> +<div class="refsect3"> +<a name="gimp-image-raise-item-to-top.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item to raise to top.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-raise-item-to-top.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-lower-item-to-bottom"></a><h3>gimp_image_lower_item_to_bottom ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_lower_item_to_bottom (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> item_ID</code></em>);</pre> +<p>Lower the specified item to the bottom of its level in its item tree</p> +<p>This procedure lowers the specified item to bottom of its level in +the item tree. It will not move the layer if there is no layer below +it.</p> +<div class="refsect3"> +<a name="gimp-image-lower-item-to-bottom.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>item_ID</p></td> +<td class="parameter_description"><p>The item to lower to bottom.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-lower-item-to-bottom.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-add-layer"></a><h3>gimp_image_add_layer ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_add_layer (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> position</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_add_layer</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-insert-layer" title="gimp_image_insert_layer ()"><code class="function">gimp_image_insert_layer()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-add-layer.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>layer_ID</p></td> +<td class="parameter_description"><p>The layer.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>position</p></td> +<td class="parameter_description"><p>The layer position.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-add-layer.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-insert-layer"></a><h3>gimp_image_insert_layer ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_insert_layer (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> parent_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> position</code></em>);</pre> +<p>Add the specified layer to the image.</p> +<p>This procedure adds the specified layer to the image at the given +position. If the specified parent is a valid layer group (See +<a class="link" href="libgimp-gimpitem.html#gimp-item-is-group" title="gimp_item_is_group ()"><code class="function">gimp_item_is_group()</code></a> and <a class="link" href="libgimp-gimplayer.html#gimp-layer-group-new" title="gimp_layer_group_new ()"><code class="function">gimp_layer_group_new()</code></a>) then the layer is +added inside the group. If the parent is 0, the layer is added +inside the main stack, outside of any group. The position argument +specifies the location of the layer inside the stack (or the group, +if a valid parent was supplied), starting from the top (0) and +increasing. If the position is specified as -1 and the parent is +specified as 0, then the layer is inserted above the active layer, +or inside the group if the active layer is a layer group. The layer +type must be compatible with the image base type.</p> +<div class="refsect3"> +<a name="gimp-image-insert-layer.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>layer_ID</p></td> +<td class="parameter_description"><p>The layer.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>parent_ID</p></td> +<td class="parameter_description"><p>The parent layer.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>position</p></td> +<td class="parameter_description"><p>The layer position.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-insert-layer.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-remove-layer"></a><h3>gimp_image_remove_layer ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_remove_layer (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre> +<p>Remove the specified layer from the image.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-remove-layer.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>layer_ID</p></td> +<td class="parameter_description"><p>The layer.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-remove-layer.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-freeze-layers"></a><h3>gimp_image_freeze_layers ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_freeze_layers (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Freeze the image's layer list.</p> +<p>This procedure freezes the layer list of the image, suppressing any +updates to the Layers dialog in response to changes to the image's +layers. This can significantly improve performance while applying +changes affecting the layer list.</p> +<p>Each call to <a class="link" href="libgimp-gimpimage.html#gimp-image-freeze-layers" title="gimp_image_freeze_layers ()"><code class="function">gimp_image_freeze_layers()</code></a> should be matched by a +corresponding call to <a class="link" href="libgimp-gimpimage.html#gimp-image-thaw-layers" title="gimp_image_thaw_layers ()"><code class="function">gimp_image_thaw_layers()</code></a>, undoing its effects.</p> +<div class="refsect3"> +<a name="gimp-image-freeze-layers.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-freeze-layers.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10-2.html#api-index-2.10.2">2.10.2</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-thaw-layers"></a><h3>gimp_image_thaw_layers ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_thaw_layers (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Thaw the image's layer list.</p> +<p>This procedure thaws the layer list of the image, re-enabling +updates to the Layers dialog.</p> +<p>This procedure should match a corresponding call to +<a class="link" href="libgimp-gimpimage.html#gimp-image-freeze-layers" title="gimp_image_freeze_layers ()"><code class="function">gimp_image_freeze_layers()</code></a>.</p> +<div class="refsect3"> +<a name="gimp-image-thaw-layers.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-thaw-layers.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10-2.html#api-index-2.10.2">2.10.2</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-raise-layer"></a><h3>gimp_image_raise_layer ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_raise_layer (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_raise_layer</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-raise-item" title="gimp_image_raise_item ()"><code class="function">gimp_image_raise_item()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-raise-layer.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>layer_ID</p></td> +<td class="parameter_description"><p>The layer to raise.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-raise-layer.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-lower-layer"></a><h3>gimp_image_lower_layer ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_lower_layer (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_lower_layer</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-lower-item" title="gimp_image_lower_item ()"><code class="function">gimp_image_lower_item()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-lower-layer.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>layer_ID</p></td> +<td class="parameter_description"><p>The layer to lower.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-lower-layer.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-raise-layer-to-top"></a><h3>gimp_image_raise_layer_to_top ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_raise_layer_to_top (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_raise_layer_to_top</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-raise-item-to-top" title="gimp_image_raise_item_to_top ()"><code class="function">gimp_image_raise_item_to_top()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-raise-layer-to-top.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>layer_ID</p></td> +<td class="parameter_description"><p>The layer to raise to top.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-raise-layer-to-top.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-lower-layer-to-bottom"></a><h3>gimp_image_lower_layer_to_bottom ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_lower_layer_to_bottom (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_lower_layer_to_bottom</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-lower-item-to-bottom" title="gimp_image_lower_item_to_bottom ()"><code class="function">gimp_image_lower_item_to_bottom()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-lower-layer-to-bottom.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>layer_ID</p></td> +<td class="parameter_description"><p>The layer to lower to bottom.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-lower-layer-to-bottom.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-layer-position"></a><h3>gimp_image_get_layer_position ()</h3> +<pre class="programlisting"><span class="returnvalue">gint</span> +gimp_image_get_layer_position (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> layer_ID</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_get_layer_position</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-get-item-position" title="gimp_image_get_item_position ()"><code class="function">gimp_image_get_item_position()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-get-layer-position.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>layer_ID</p></td> +<td class="parameter_description"><p>The layer.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-layer-position.returns"></a><h4>Returns</h4> +<p> The position of the layer in the layer stack.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-add-channel"></a><h3>gimp_image_add_channel ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_add_channel (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> channel_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> position</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_add_channel</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-insert-channel" title="gimp_image_insert_channel ()"><code class="function">gimp_image_insert_channel()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-add-channel.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>channel_ID</p></td> +<td class="parameter_description"><p>The channel.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>position</p></td> +<td class="parameter_description"><p>The channel position.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-add-channel.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-insert-channel"></a><h3>gimp_image_insert_channel ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_insert_channel (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> channel_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> parent_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> position</code></em>);</pre> +<p>Add the specified channel to the image.</p> +<p>This procedure adds the specified channel to the image at the given +position. Since channel groups are not currently supported, the +parent argument must always be 0. The position argument specifies +the location of the channel inside the stack, starting from the top +(0) and increasing. If the position is specified as -1, then the +channel is inserted above the active channel.</p> +<div class="refsect3"> +<a name="gimp-image-insert-channel.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>channel_ID</p></td> +<td class="parameter_description"><p>The channel.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>parent_ID</p></td> +<td class="parameter_description"><p>The parent channel.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>position</p></td> +<td class="parameter_description"><p>The channel position.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-insert-channel.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-remove-channel"></a><h3>gimp_image_remove_channel ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_remove_channel (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> channel_ID</code></em>);</pre> +<p>Remove the specified channel from the image.</p> +<p>This procedure removes the specified channel from the image. If the +channel doesn't exist, an error is returned.</p> +<div class="refsect3"> +<a name="gimp-image-remove-channel.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>channel_ID</p></td> +<td class="parameter_description"><p>The channel.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-remove-channel.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-freeze-channels"></a><h3>gimp_image_freeze_channels ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_freeze_channels (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Freeze the image's channel list.</p> +<p>This procedure freezes the channel list of the image, suppressing +any updates to the Channels dialog in response to changes to the +image's channels. This can significantly improve performance while +applying changes affecting the channel list.</p> +<p>Each call to <a class="link" href="libgimp-gimpimage.html#gimp-image-freeze-channels" title="gimp_image_freeze_channels ()"><code class="function">gimp_image_freeze_channels()</code></a> should be matched by a +corresponding call to <a class="link" href="libgimp-gimpimage.html#gimp-image-thaw-channels" title="gimp_image_thaw_channels ()"><code class="function">gimp_image_thaw_channels()</code></a>, undoing its +effects.</p> +<div class="refsect3"> +<a name="gimp-image-freeze-channels.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-freeze-channels.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10-2.html#api-index-2.10.2">2.10.2</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-thaw-channels"></a><h3>gimp_image_thaw_channels ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_thaw_channels (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Thaw the image's channel list.</p> +<p>This procedure thaws the channel list of the image, re-enabling +updates to the Channels dialog.</p> +<p>This procedure should match a corresponding call to +<a class="link" href="libgimp-gimpimage.html#gimp-image-freeze-channels" title="gimp_image_freeze_channels ()"><code class="function">gimp_image_freeze_channels()</code></a>.</p> +<div class="refsect3"> +<a name="gimp-image-thaw-channels.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-thaw-channels.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10-2.html#api-index-2.10.2">2.10.2</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-raise-channel"></a><h3>gimp_image_raise_channel ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_raise_channel (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> channel_ID</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_raise_channel</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-raise-item" title="gimp_image_raise_item ()"><code class="function">gimp_image_raise_item()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-raise-channel.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>channel_ID</p></td> +<td class="parameter_description"><p>The channel to raise.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-raise-channel.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-lower-channel"></a><h3>gimp_image_lower_channel ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_lower_channel (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> channel_ID</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_lower_channel</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-lower-item" title="gimp_image_lower_item ()"><code class="function">gimp_image_lower_item()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-lower-channel.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>channel_ID</p></td> +<td class="parameter_description"><p>The channel to lower.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-lower-channel.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-channel-position"></a><h3>gimp_image_get_channel_position ()</h3> +<pre class="programlisting"><span class="returnvalue">gint</span> +gimp_image_get_channel_position (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> channel_ID</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_get_channel_position</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-get-item-position" title="gimp_image_get_item_position ()"><code class="function">gimp_image_get_item_position()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-get-channel-position.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>channel_ID</p></td> +<td class="parameter_description"><p>The channel.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-channel-position.returns"></a><h4>Returns</h4> +<p> The position of the channel in the channel stack.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-flatten"></a><h3>gimp_image_flatten ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_flatten (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Flatten all visible layers into a single layer. Discard all +invisible layers.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-flatten.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-flatten.returns"></a><h4>Returns</h4> +<p> The resulting layer.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-merge-visible-layers"></a><h3>gimp_image_merge_visible_layers ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_merge_visible_layers (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpMergeType"><span class="type">GimpMergeType</span></a> merge_type</code></em>);</pre> +<p>Merge the visible image layers into one.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-merge-visible-layers.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>merge_type</p></td> +<td class="parameter_description"><p>The type of merge.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-merge-visible-layers.returns"></a><h4>Returns</h4> +<p> The resulting layer.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-merge-down"></a><h3>gimp_image_merge_down ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_merge_down (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> merge_layer_ID</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpMergeType"><span class="type">GimpMergeType</span></a> merge_type</code></em>);</pre> +<p>Merge the layer passed and the first visible layer below.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-merge-down.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>merge_layer_ID</p></td> +<td class="parameter_description"><p>The layer to merge down from.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>merge_type</p></td> +<td class="parameter_description"><p>The type of merge.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-merge-down.returns"></a><h4>Returns</h4> +<p> The resulting layer.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-merge-layer-group"></a><h3>gimp_image_merge_layer_group ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_merge_layer_group (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> layer_group_ID</code></em>);</pre> +<p>Merge the passed layer group's layers into one normal layer.</p> +<p>This procedure combines the layers of the passed layer group into a +single normal layer, replacing the group.</p> +<div class="refsect3"> +<a name="gimp-image-merge-layer-group.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>layer_group_ID</p></td> +<td class="parameter_description"><p>The layer group to merge.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-merge-layer-group.returns"></a><h4>Returns</h4> +<p> The resulting layer.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10-14.html#api-index-2.10.14">2.10.14</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-clean-all"></a><h3>gimp_image_clean_all ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_clean_all (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Set the image dirty count to 0.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-clean-all.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-clean-all.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-is-dirty"></a><h3>gimp_image_is_dirty ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_is_dirty (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Checks if the image has unsaved changes.</p> +<p>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 <a class="link" href="libgimp-gimpimage.html#gimp-image-clean-all" title="gimp_image_clean_all ()"><code class="function">gimp_image_clean_all()</code></a> +after calling a save procedure to make the image clean.</p> +<div class="refsect3"> +<a name="gimp-image-is-dirty.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-is-dirty.returns"></a><h4>Returns</h4> +<p> TRUE if the image has unsaved changes.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-active-layer"></a><h3>gimp_image_get_active_layer ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_get_active_layer (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Returns the specified image's active layer.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-get-active-layer.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-active-layer.returns"></a><h4>Returns</h4> +<p> The active layer.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-set-active-layer"></a><h3>gimp_image_set_active_layer ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_set_active_layer (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> active_layer_ID</code></em>);</pre> +<p>Sets the specified image's active layer.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-set-active-layer.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>active_layer_ID</p></td> +<td class="parameter_description"><p>The new image active layer.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-set-active-layer.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-active-channel"></a><h3>gimp_image_get_active_channel ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_get_active_channel (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Returns the specified image's active channel.</p> +<p>If there is an active channel, this will return the channel ID, +otherwise, -1.</p> +<div class="refsect3"> +<a name="gimp-image-get-active-channel.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-active-channel.returns"></a><h4>Returns</h4> +<p> The active channel.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-set-active-channel"></a><h3>gimp_image_set_active_channel ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_set_active_channel (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> active_channel_ID</code></em>);</pre> +<p>Sets the specified image's active channel.</p> +<p>If the channel exists, it is set as the active channel in the image. +Any previous active channel or layer is set to inactive. An +exception is a previously existing floating selection, in which case +this procedure will return an execution error.</p> +<div class="refsect3"> +<a name="gimp-image-set-active-channel.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>active_channel_ID</p></td> +<td class="parameter_description"><p>The new image active channel.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-set-active-channel.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-unset-active-channel"></a><h3>gimp_image_unset_active_channel ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_unset_active_channel (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Unsets the active channel in the specified image.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-unset-active-channel.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-unset-active-channel.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-selection"></a><h3>gimp_image_get_selection ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_get_selection (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Returns the specified image's selection.</p> +<p>This will always return a valid ID for a selection -- which is +represented as a channel internally.</p> +<div class="refsect3"> +<a name="gimp-image-get-selection.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-selection.returns"></a><h4>Returns</h4> +<p> The selection channel.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-component-active"></a><h3>gimp_image_get_component_active ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_get_component_active (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpChannelType"><span class="type">GimpChannelType</span></a> component</code></em>);</pre> +<p>Returns if the specified image's image component is active.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-get-component-active.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>component</p></td> +<td class="parameter_description"><p>The image component.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-component-active.returns"></a><h4>Returns</h4> +<p> Component is active.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-set-component-active"></a><h3>gimp_image_set_component_active ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_set_component_active (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpChannelType"><span class="type">GimpChannelType</span></a> component</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> active</code></em>);</pre> +<p>Sets if the specified image's image component is active.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-set-component-active.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>component</p></td> +<td class="parameter_description"><p>The image component.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>active</p></td> +<td class="parameter_description"><p>Component is active.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-set-component-active.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-component-visible"></a><h3>gimp_image_get_component_visible ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_get_component_visible (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpChannelType"><span class="type">GimpChannelType</span></a> component</code></em>);</pre> +<p>Returns if the specified image's image component is visible.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-get-component-visible.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>component</p></td> +<td class="parameter_description"><p>The image component.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-component-visible.returns"></a><h4>Returns</h4> +<p> Component is visible.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-set-component-visible"></a><h3>gimp_image_set_component_visible ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_set_component_visible (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpChannelType"><span class="type">GimpChannelType</span></a> component</code></em>, + <em class="parameter"><code><span class="type">gboolean</span> visible</code></em>);</pre> +<p>Sets if the specified image's image component is visible.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-set-component-visible.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>component</p></td> +<td class="parameter_description"><p>The image component.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>visible</p></td> +<td class="parameter_description"><p>Component is visible.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-set-component-visible.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-filename"></a><h3>gimp_image_get_filename ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> * +gimp_image_get_filename (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Returns the specified image's filename.</p> +<p>This procedure returns the specified image's filename in the +filesystem encoding. The image has a filename only if it was loaded +or imported from a file or has since been saved or exported. +Otherwise, this function returns <code class="literal">NULL</code>. See also +<a class="link" href="libgimp-gimpimage.html#gimp-image-get-uri" title="gimp_image_get_uri ()"><code class="function">gimp_image_get_uri()</code></a>.</p> +<div class="refsect3"> +<a name="gimp-image-get-filename.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-filename.returns"></a><h4>Returns</h4> +<p> The filename. The returned value must be freed with +<code class="function">g_free()</code>.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-set-filename"></a><h3>gimp_image_set_filename ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_set_filename (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre> +<p>Sets the specified image's filename.</p> +<p>This procedure sets the specified image's filename. The filename +should be in the filesystem encoding.</p> +<div class="refsect3"> +<a name="gimp-image-set-filename.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>filename</p></td> +<td class="parameter_description"><p>The new image filename.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-set-filename.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-name"></a><h3>gimp_image_get_name ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> * +gimp_image_get_name (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Returns the specified image's name.</p> +<p>This procedure returns the image's name. If the image has a filename +or an URI, then the returned name contains the filename's or URI's +base name (the last component of the path). Otherwise it is the +translated string \"Untitled\". The returned name is formatted like +the image name in the image window title, it may contain '[]', +'(imported)' etc. and should only be used to label user interface +elements. Never use it to construct filenames.</p> +<div class="refsect3"> +<a name="gimp-image-get-name.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-name.returns"></a><h4>Returns</h4> +<p> The name. The returned value must be freed with <code class="function">g_free()</code>.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-resolution"></a><h3>gimp_image_get_resolution ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_get_resolution (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> *xresolution</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> *yresolution</code></em>);</pre> +<p>Returns the specified image's resolution.</p> +<p>This procedure returns the specified image's resolution in dots per +inch. This value is independent of any of the layers in this image.</p> +<div class="refsect3"> +<a name="gimp-image-get-resolution.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>xresolution</p></td> +<td class="parameter_description"><p>The resolution in the x-axis, in dots per inch.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>yresolution</p></td> +<td class="parameter_description"><p>The resolution in the y-axis, in dots per inch.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-resolution.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-set-resolution"></a><h3>gimp_image_set_resolution ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_set_resolution (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> xresolution</code></em>, + <em class="parameter"><code><span class="type">gdouble</span> yresolution</code></em>);</pre> +<p>Sets the specified image's resolution.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-set-resolution.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>xresolution</p></td> +<td class="parameter_description"><p>The new image resolution in the x-axis, in dots per inch.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>yresolution</p></td> +<td class="parameter_description"><p>The new image resolution in the y-axis, in dots per inch.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-set-resolution.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-unit"></a><h3>gimp_image_get_unit ()</h3> +<pre class="programlisting"><a href="../html/libgimpbase-gimpunit.html#GimpUnit"><span class="returnvalue">GimpUnit</span></a> +gimp_image_get_unit (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Returns the specified image's unit.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-get-unit.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-unit.returns"></a><h4>Returns</h4> +<p> The unit.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-set-unit"></a><h3>gimp_image_set_unit ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_set_unit (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpunit.html#GimpUnit"><span class="type">GimpUnit</span></a> unit</code></em>);</pre> +<p>Sets the specified image's unit.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-set-unit.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>unit</p></td> +<td class="parameter_description"><p>The new image unit.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-set-unit.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-set-tattoo-state"></a><h3>gimp_image_set_tattoo_state ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_set_tattoo_state (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> tattoo_state</code></em>);</pre> +<p>Set the tattoo state associated with the image.</p> +<p>This procedure sets the tattoo state of the image. Use only by +save/load plug-ins 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.</p> +<div class="refsect3"> +<a name="gimp-image-set-tattoo-state.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>tattoo_state</p></td> +<td class="parameter_description"><p>The new image tattoo state.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-set-tattoo-state.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-tattoo-state"></a><h3>gimp_image_get_tattoo_state ()</h3> +<pre class="programlisting"><span class="returnvalue">gint</span> +gimp_image_get_tattoo_state (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Returns the tattoo state associated with the image.</p> +<p>This procedure returns the tattoo state of the image. Use only by +save/load plug-ins that wish to preserve an images tattoo state. +Using this function at other times will produce unexpected results.</p> +<div class="refsect3"> +<a name="gimp-image-get-tattoo-state.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-tattoo-state.returns"></a><h4>Returns</h4> +<p> The tattoo state.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-layer-by-tattoo"></a><h3>gimp_image_get_layer_by_tattoo ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_get_layer_by_tattoo (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> tattoo</code></em>);</pre> +<p>Find a layer with a given tattoo in an image.</p> +<p>This procedure returns the layer with the given tattoo in the +specified image.</p> +<div class="refsect3"> +<a name="gimp-image-get-layer-by-tattoo.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>tattoo</p></td> +<td class="parameter_description"><p>The tattoo of the layer to find.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-layer-by-tattoo.returns"></a><h4>Returns</h4> +<p> The layer with the specified tattoo.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-channel-by-tattoo"></a><h3>gimp_image_get_channel_by_tattoo ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_get_channel_by_tattoo (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> tattoo</code></em>);</pre> +<p>Find a channel with a given tattoo in an image.</p> +<p>This procedure returns the channel with the given tattoo in the +specified image.</p> +<div class="refsect3"> +<a name="gimp-image-get-channel-by-tattoo.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>tattoo</p></td> +<td class="parameter_description"><p>The tattoo of the channel to find.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-channel-by-tattoo.returns"></a><h4>Returns</h4> +<p> The channel with the specified tattoo.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-vectors-by-tattoo"></a><h3>gimp_image_get_vectors_by_tattoo ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_get_vectors_by_tattoo (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> tattoo</code></em>);</pre> +<p>Find a vectors with a given tattoo in an image.</p> +<p>This procedure returns the vectors with the given tattoo in the +specified image.</p> +<div class="refsect3"> +<a name="gimp-image-get-vectors-by-tattoo.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>tattoo</p></td> +<td class="parameter_description"><p>The tattoo of the vectors to find.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-vectors-by-tattoo.returns"></a><h4>Returns</h4> +<p> The vectors with the specified tattoo.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-6.html#api-index-2.6">2.6</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-layer-by-name"></a><h3>gimp_image_get_layer_by_name ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_get_layer_by_name (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> +<p>Find a layer with a given name in an image.</p> +<p>This procedure returns the layer with the given name in the +specified image.</p> +<div class="refsect3"> +<a name="gimp-image-get-layer-by-name.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The name of the layer to find.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-layer-by-name.returns"></a><h4>Returns</h4> +<p> The layer with the specified name.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-channel-by-name"></a><h3>gimp_image_get_channel_by_name ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_get_channel_by_name (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> +<p>Find a channel with a given name in an image.</p> +<p>This procedure returns the channel with the given name in the +specified image.</p> +<div class="refsect3"> +<a name="gimp-image-get-channel-by-name.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The name of the channel to find.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-channel-by-name.returns"></a><h4>Returns</h4> +<p> The channel with the specified name.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-vectors-by-name"></a><h3>gimp_image_get_vectors_by_name ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_get_vectors_by_name (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> +<p>Find a vectors with a given name in an image.</p> +<p>This procedure returns the vectors with the given name in the +specified image.</p> +<div class="refsect3"> +<a name="gimp-image-get-vectors-by-name.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The name of the vectors to find.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-vectors-by-name.returns"></a><h4>Returns</h4> +<p> The vectors with the specified name.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-cmap"></a><h3>gimp_image_get_cmap ()</h3> +<pre class="programlisting"><span class="returnvalue">guchar</span> * +gimp_image_get_cmap (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> *num_colors</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_get_cmap</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-get-colormap" title="gimp_image_get_colormap ()"><code class="function">gimp_image_get_colormap()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-get-cmap.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>num_colors</p></td> +<td class="parameter_description"><p>Number of colors in the colormap array.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-cmap.returns"></a><h4>Returns</h4> +<p> The image's colormap.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-set-cmap"></a><h3>gimp_image_set_cmap ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_set_cmap (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code>const <span class="type">guchar</span> *cmap</code></em>, + <em class="parameter"><code><span class="type">gint</span> num_colors</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_set_cmap</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-set-colormap" title="gimp_image_set_colormap ()"><code class="function">gimp_image_set_colormap()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-set-cmap.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cmap</p></td> +<td class="parameter_description"><p>The new colormap values.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>num_colors</p></td> +<td class="parameter_description"><p>Number of colors in the colormap array.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-set-cmap.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-colormap"></a><h3>gimp_image_get_colormap ()</h3> +<pre class="programlisting"><span class="returnvalue">guchar</span> * +gimp_image_get_colormap (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> *num_colors</code></em>);</pre> +<p>Returns the image's colormap</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-get-colormap.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>num_colors</p></td> +<td class="parameter_description"><p>Returns the number of colors in the colormap array.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-colormap.returns"></a><h4>Returns</h4> +<p> The image's colormap.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-set-colormap"></a><h3>gimp_image_set_colormap ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_set_colormap (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code>const <span class="type">guchar</span> *colormap</code></em>, + <em class="parameter"><code><span class="type">gint</span> num_colors</code></em>);</pre> +<p>Sets the entries in the image's colormap.</p> +<p>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.</p> +<div class="refsect3"> +<a name="gimp-image-set-colormap.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>colormap</p></td> +<td class="parameter_description"><p>The new colormap values.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>num_colors</p></td> +<td class="parameter_description"><p>Number of colors in the colormap array.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-set-colormap.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-vectors"></a><h3>gimp_image_get_vectors ()</h3> +<pre class="programlisting"><span class="returnvalue">gint</span> * +gimp_image_get_vectors (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> *num_vectors</code></em>);</pre> +<p>Returns the list of vectors contained in the specified image.</p> +<p>This procedure returns the list of vectors contained in the +specified image.</p> +<div class="refsect3"> +<a name="gimp-image-get-vectors.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>num_vectors</p></td> +<td class="parameter_description"><p>The number of vectors contained in the image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-vectors.returns"></a><h4>Returns</h4> +<p> The list of vectors contained in the image. The returned +value must be freed with <code class="function">g_free()</code>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-thumbnail-data"></a><h3>gimp_image_get_thumbnail_data ()</h3> +<pre class="programlisting"><span class="returnvalue">guchar</span> * +gimp_image_get_thumbnail_data (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> *width</code></em>, + <em class="parameter"><code><span class="type">gint</span> *height</code></em>, + <em class="parameter"><code><span class="type">gint</span> *bpp</code></em>);</pre> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-metadata"></a><h3>gimp_image_get_metadata ()</h3> +<pre class="programlisting"><a href="../html/libgimpbase-GimpMetadata.html#GimpMetadata"><span class="returnvalue">GimpMetadata</span></a> * +gimp_image_get_metadata (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Returns the image's metadata.</p> +<p>Returns exif/iptc/xmp metadata from the image.</p> +<div class="refsect3"> +<a name="gimp-image-get-metadata.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-metadata.returns"></a><h4>Returns</h4> +<p> The exif/ptc/xmp metadata, or <code class="literal">NULL</code> if there is none.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-set-metadata"></a><h3>gimp_image_set_metadata ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_set_metadata (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-GimpMetadata.html#GimpMetadata"><span class="type">GimpMetadata</span></a> *metadata</code></em>);</pre> +<p>Set the image's metadata.</p> +<p>Sets exif/iptc/xmp metadata on the image, or deletes it if +<em class="parameter"><code>metadata</code></em> + is <code class="literal">NULL</code>.</p> +<div class="refsect3"> +<a name="gimp-image-set-metadata.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>metadata</p></td> +<td class="parameter_description"><p>The exif/ptc/xmp metadata.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-set-metadata.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-attach-parasite"></a><h3>gimp_image_attach_parasite ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_attach_parasite (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code>const <a href="../html/libgimpbase-GimpParasite.html#GimpParasite"><span class="type">GimpParasite</span></a> *parasite</code></em>);</pre> +<p>Add a parasite to an image.</p> +<p>This procedure attaches a parasite to an image. It has no return +values.</p> +<div class="refsect3"> +<a name="gimp-image-attach-parasite.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>parasite</p></td> +<td class="parameter_description"><p>The parasite to attach to an image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-attach-parasite.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-detach-parasite"></a><h3>gimp_image_detach_parasite ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_detach_parasite (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> +<p>Removes a parasite from an image.</p> +<p>This procedure detaches a parasite from an image. It has no return +values.</p> +<div class="refsect3"> +<a name="gimp-image-detach-parasite.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The name of the parasite to detach from an image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-detach-parasite.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-parasite"></a><h3>gimp_image_get_parasite ()</h3> +<pre class="programlisting"><a href="../html/libgimpbase-GimpParasite.html#GimpParasite"><span class="returnvalue">GimpParasite</span></a> * +gimp_image_get_parasite (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> +<p>Look up a parasite in an image</p> +<p>Finds and returns the parasite that was previously attached to an +image.</p> +<div class="refsect3"> +<a name="gimp-image-get-parasite.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The name of the parasite to find.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-parasite.returns"></a><h4>Returns</h4> +<p> The found parasite.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-parasite-list"></a><h3>gimp_image_get_parasite_list ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> ** +gimp_image_get_parasite_list (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> *num_parasites</code></em>);</pre> +<p>List all parasites.</p> +<p>Returns a list of all currently attached parasites.</p> +<div class="refsect3"> +<a name="gimp-image-get-parasite-list.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>num_parasites</p></td> +<td class="parameter_description"><p>The number of attached parasites.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-parasite-list.returns"></a><h4>Returns</h4> +<p> The names of currently attached parasites. The returned +value must be freed with <code class="function">g_strfreev()</code>.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-parasite-find"></a><h3>gimp_image_parasite_find ()</h3> +<pre class="programlisting"><a href="../html/libgimpbase-GimpParasite.html#GimpParasite"><span class="returnvalue">GimpParasite</span></a> * +gimp_image_parasite_find (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_parasite_find</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-get-parasite" title="gimp_image_get_parasite ()"><code class="function">gimp_image_get_parasite()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-parasite-find.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The name of the parasite to find.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-parasite-find.returns"></a><h4>Returns</h4> +<p> The found parasite.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-parasite-list"></a><h3>gimp_image_parasite_list ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_parasite_list (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> *num_parasites</code></em>, + <em class="parameter"><code><span class="type">gchar</span> ***parasites</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_parasite_list</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-get-parasite-list" title="gimp_image_get_parasite_list ()"><code class="function">gimp_image_get_parasite_list()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-parasite-list.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>num_parasites</p></td> +<td class="parameter_description"><p>The number of attached parasites.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>parasites</p></td> +<td class="parameter_description"><p>The names of currently attached parasites.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-parasite-list.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-parasite-attach"></a><h3>gimp_image_parasite_attach ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_parasite_attach (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code>const <a href="../html/libgimpbase-GimpParasite.html#GimpParasite"><span class="type">GimpParasite</span></a> *parasite</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_parasite_attach</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-attach-parasite" title="gimp_image_attach_parasite ()"><code class="function">gimp_image_attach_parasite()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-parasite-attach.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>parasite</p></td> +<td class="parameter_description"><p>The parasite to attach to an image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-parasite-attach.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-parasite-detach"></a><h3>gimp_image_parasite_detach ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_parasite_detach (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_parasite_detach</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-detach-parasite" title="gimp_image_detach_parasite ()"><code class="function">gimp_image_detach_parasite()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-parasite-detach.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The name of the parasite to detach from an image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-parasite-detach.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-attach-new-parasite"></a><h3>gimp_image_attach_new_parasite ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_attach_new_parasite (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>, + <em class="parameter"><code><span class="type">gint</span> flags</code></em>, + <em class="parameter"><code><span class="type">gint</span> size</code></em>, + <em class="parameter"><code><span class="type">gconstpointer</span> data</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_attach_new_parasite</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-attach-parasite" title="gimp_image_attach_parasite ()"><code class="function">gimp_image_attach_parasite()</code></a> instead.</p> +</div> +<p>Convenience function that creates a parasite and attaches it +to GIMP.</p> +<div class="refsect3"> +<a name="gimp-image-attach-new-parasite.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>the ID of the image to attach the <a href="../html/libgimpbase-GimpParasite.html#GimpParasite"><span class="type">GimpParasite</span></a> to.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>the name of the <a href="../html/libgimpbase-GimpParasite.html#GimpParasite"><span class="type">GimpParasite</span></a> to create and attach.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>flags</p></td> +<td class="parameter_description"><p>the flags set on the <a href="../html/libgimpbase-GimpParasite.html#GimpParasite"><span class="type">GimpParasite</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>size</p></td> +<td class="parameter_description"><p>the size of the parasite data in bytes.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>a pointer to the data attached with the <a href="../html/libgimpbase-GimpParasite.html#GimpParasite"><span class="type">GimpParasite</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-attach-new-parasite.returns"></a><h4>Returns</h4> +<p> TRUE on successful creation and attachment of +the new parasite.</p> +<p>See Also: <a class="link" href="libgimp-gimpimage.html#gimp-image-parasite-attach" title="gimp_image_parasite_attach ()"><code class="function">gimp_image_parasite_attach()</code></a></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-add-vectors"></a><h3>gimp_image_add_vectors ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_add_vectors (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> vectors_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> position</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_add_vectors</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-insert-vectors" title="gimp_image_insert_vectors ()"><code class="function">gimp_image_insert_vectors()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-add-vectors.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>vectors_ID</p></td> +<td class="parameter_description"><p>The vectors object.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>position</p></td> +<td class="parameter_description"><p>The vectors objects position.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-add-vectors.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-insert-vectors"></a><h3>gimp_image_insert_vectors ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_insert_vectors (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> vectors_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> parent_ID</code></em>, + <em class="parameter"><code><span class="type">gint</span> position</code></em>);</pre> +<p>Add the specified vectors to the image.</p> +<p>This procedure adds the specified vectors to the image at the given +position. Since vectors groups are not currently supported, the +parent argument must always be 0. The position argument specifies +the location of the vectors inside the stack, starting from the top +(0) and increasing. If the position is specified as -1, then the +vectors is inserted above the active vectors.</p> +<div class="refsect3"> +<a name="gimp-image-insert-vectors.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>vectors_ID</p></td> +<td class="parameter_description"><p>The vectors.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>parent_ID</p></td> +<td class="parameter_description"><p>The parent vectors.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>position</p></td> +<td class="parameter_description"><p>The vectors position.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-insert-vectors.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-remove-vectors"></a><h3>gimp_image_remove_vectors ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_remove_vectors (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> vectors_ID</code></em>);</pre> +<p>Remove the specified path from the image.</p> +<p>This procedure removes the specified path from the image. If the +path doesn't exist, an error is returned.</p> +<div class="refsect3"> +<a name="gimp-image-remove-vectors.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>vectors_ID</p></td> +<td class="parameter_description"><p>The vectors object.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-remove-vectors.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-freeze-vectors"></a><h3>gimp_image_freeze_vectors ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_freeze_vectors (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Freeze the image's vectors list.</p> +<p>This procedure freezes the vectors list of the image, suppressing +any updates to the Paths dialog in response to changes to the +image's vectors. This can significantly improve performance while +applying changes affecting the vectors list.</p> +<p>Each call to <a class="link" href="libgimp-gimpimage.html#gimp-image-freeze-vectors" title="gimp_image_freeze_vectors ()"><code class="function">gimp_image_freeze_vectors()</code></a> should be matched by a +corresponding call to <a class="link" href="libgimp-gimpimage.html#gimp-image-thaw-vectors" title="gimp_image_thaw_vectors ()"><code class="function">gimp_image_thaw_vectors()</code></a>, undoing its +effects.</p> +<div class="refsect3"> +<a name="gimp-image-freeze-vectors.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-freeze-vectors.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10-2.html#api-index-2.10.2">2.10.2</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-thaw-vectors"></a><h3>gimp_image_thaw_vectors ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_thaw_vectors (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Thaw the image's vectors list.</p> +<p>This procedure thaws the vectors list of the image, re-enabling +updates to the Paths dialog.</p> +<p>This procedure should match a corresponding call to +<a class="link" href="libgimp-gimpimage.html#gimp-image-freeze-vectors" title="gimp_image_freeze_vectors ()"><code class="function">gimp_image_freeze_vectors()</code></a>.</p> +<div class="refsect3"> +<a name="gimp-image-thaw-vectors.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-thaw-vectors.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-10-2.html#api-index-2.10.2">2.10.2</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-active-vectors"></a><h3>gimp_image_get_active_vectors ()</h3> +<pre class="programlisting"><span class="returnvalue">gint32</span> +gimp_image_get_active_vectors (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre> +<p>Returns the specified image's active vectors.</p> +<p>If there is an active path, its ID will be returned, otherwise, -1.</p> +<div class="refsect3"> +<a name="gimp-image-get-active-vectors.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-active-vectors.returns"></a><h4>Returns</h4> +<p> The active vectors.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-set-active-vectors"></a><h3>gimp_image_set_active_vectors ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_set_active_vectors (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> active_vectors_ID</code></em>);</pre> +<p>Sets the specified image's active vectors.</p> +<p>If the path exists, it is set as the active path in the image.</p> +<div class="refsect3"> +<a name="gimp-image-set-active-vectors.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>active_vectors_ID</p></td> +<td class="parameter_description"><p>The new image active vectors.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-set-active-vectors.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-lower-vectors"></a><h3>gimp_image_lower_vectors ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_lower_vectors (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> vectors_ID</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_lower_vectors</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-lower-item" title="gimp_image_lower_item ()"><code class="function">gimp_image_lower_item()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-lower-vectors.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>vectors_ID</p></td> +<td class="parameter_description"><p>The vectors object to lower.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-lower-vectors.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-raise-vectors"></a><h3>gimp_image_raise_vectors ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_raise_vectors (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> vectors_ID</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_raise_vectors</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-raise-item" title="gimp_image_raise_item ()"><code class="function">gimp_image_raise_item()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-raise-vectors.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>vectors_ID</p></td> +<td class="parameter_description"><p>The vectors object to raise.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-raise-vectors.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-lower-vectors-to-bottom"></a><h3>gimp_image_lower_vectors_to_bottom ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_lower_vectors_to_bottom (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> vectors_ID</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_lower_vectors_to_bottom</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-lower-item-to-bottom" title="gimp_image_lower_item_to_bottom ()"><code class="function">gimp_image_lower_item_to_bottom()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-lower-vectors-to-bottom.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>vectors_ID</p></td> +<td class="parameter_description"><p>The vectors object to lower to bottom.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-lower-vectors-to-bottom.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-raise-vectors-to-top"></a><h3>gimp_image_raise_vectors_to_top ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_image_raise_vectors_to_top (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> vectors_ID</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_raise_vectors_to_top</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-raise-item-to-top" title="gimp_image_raise_item_to_top ()"><code class="function">gimp_image_raise_item_to_top()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-raise-vectors-to-top.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>vectors_ID</p></td> +<td class="parameter_description"><p>The vectors object to raise to top.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-raise-vectors-to-top.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-image-get-vectors-position"></a><h3>gimp_image_get_vectors_position ()</h3> +<pre class="programlisting"><span class="returnvalue">gint</span> +gimp_image_get_vectors_position (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>, + <em class="parameter"><code><span class="type">gint32</span> vectors_ID</code></em>);</pre> +<div class="warning"> +<p><code class="literal">gimp_image_get_vectors_position</code> is deprecated and should not be used in newly-written code.</p> +<p>Use <a class="link" href="libgimp-gimpimage.html#gimp-image-get-item-position" title="gimp_image_get_item_position ()"><code class="function">gimp_image_get_item_position()</code></a> instead.</p> +</div> +<div class="refsect3"> +<a name="gimp-image-get-vectors-position.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>image_ID</p></td> +<td class="parameter_description"><p>The image.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>vectors_ID</p></td> +<td class="parameter_description"><p>The vectors object.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-image-get-vectors-position.returns"></a><h4>Returns</h4> +<p> The position of the vectors object in the vectors stack.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.33.1</div> +</body> +</html>
\ No newline at end of file |