3456 lines
184 KiB
HTML
3456 lines
184 KiB
HTML
<!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</title>
|
||
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
|
||
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
|
||
<link rel="up" href="libgimp-image.html" title="Manupulating Images and their Properties">
|
||
<link rel="prev" href="libgimp-gimpguides.html" title="gimpguides">
|
||
<link rel="next" href="libgimp-gimpimageselect.html" title="gimpimageselect">
|
||
<meta name="generator" content="GTK-Doc V1.18 (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="2">
|
||
<tr valign="middle">
|
||
<td><a accesskey="p" href="libgimp-gimpguides.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
|
||
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
|
||
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
|
||
<th width="100%" align="center">GIMP Library Reference Manual</th>
|
||
<td><a accesskey="n" href="libgimp-gimpimageselect.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
|
||
</tr>
|
||
<tr><td colspan="5" class="shortcuts">
|
||
<a href="#libgimp-gimpimage.synopsis" class="shortcut">Top</a>
|
||
|
|
||
<a href="#libgimp-gimpimage.description" class="shortcut">Description</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 valign="top" align="right"></td>
|
||
</tr></table></div>
|
||
<div class="refsynopsisdiv">
|
||
<a name="libgimp-gimpimage.synopsis"></a><h2>Synopsis</h2>
|
||
<pre class="synopsis"><span class="returnvalue">gint</span> * <a class="link" href="libgimp-gimpimage.html#gimp-image-list" title="gimp_image_list ()">gimp_image_list</a> (<em class="parameter"><code><span class="type">gint</span> *num_images</code></em>);
|
||
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-new" title="gimp_image_new ()">gimp_image_new</a> (<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="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageBaseType"><span class="type">GimpImageBaseType</span></a> type</code></em>);
|
||
<span class="returnvalue">gchar</span> * <a class="link" href="libgimp-gimpimage.html#gimp-image-get-uri" title="gimp_image_get_uri ()">gimp_image_get_uri</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gchar</span> * <a class="link" href="libgimp-gimpimage.html#gimp-image-get-xcf-uri" title="gimp_image_get_xcf_uri ()">gimp_image_get_xcf_uri</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gchar</span> * <a class="link" href="libgimp-gimpimage.html#gimp-image-get-exported-uri" title="gimp_image_get_exported_uri ()">gimp_image_get_exported_uri</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gchar</span> * <a class="link" href="libgimp-gimpimage.html#gimp-image-get-imported-uri" title="gimp_image_get_imported_uri ()">gimp_image_get_imported_uri</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-duplicate" title="gimp_image_duplicate ()">gimp_image_duplicate</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-delete" title="gimp_image_delete ()">gimp_image_delete</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-is-valid" title="gimp_image_is_valid ()">gimp_image_is_valid</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageBaseType"><span class="returnvalue">GimpImageBaseType</span></a> <a class="link" href="libgimp-gimpimage.html#gimp-image-base-type" title="gimp_image_base_type ()">gimp_image_base_type</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gint</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-width" title="gimp_image_width ()">gimp_image_width</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gint</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-height" title="gimp_image_height ()">gimp_image_height</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-free-shadow" title="gimp_image_free_shadow ()">gimp_image_free_shadow</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-flip" title="gimp_image_flip ()">gimp_image_flip</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpOrientationType" title="enum GimpOrientationType"><span class="type">GimpOrientationType</span></a> flip_type</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-rotate" title="gimp_image_rotate ()">gimp_image_rotate</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpRotationType" title="enum GimpRotationType"><span class="type">GimpRotationType</span></a> rotate_type</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-resize" title="gimp_image_resize ()">gimp_image_resize</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_width</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_height</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> offx</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> offy</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-resize-to-layers" title="gimp_image_resize_to_layers ()">gimp_image_resize_to_layers</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-scale" title="gimp_image_scale ()">gimp_image_scale</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_width</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_height</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-scale-full" title="gimp_image_scale_full ()">gimp_image_scale_full</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_width</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_height</code></em>,
|
||
<em class="parameter"><code><a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpInterpolationType"><span class="type">GimpInterpolationType</span></a> interpolation</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-crop" title="gimp_image_crop ()">gimp_image_crop</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_width</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_height</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> offx</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> offy</code></em>);
|
||
<span class="returnvalue">gint</span> * <a class="link" href="libgimp-gimpimage.html#gimp-image-get-layers" title="gimp_image_get_layers ()">gimp_image_get_layers</a> (<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>);
|
||
<span class="returnvalue">gint</span> * <a class="link" href="libgimp-gimpimage.html#gimp-image-get-channels" title="gimp_image_get_channels ()">gimp_image_get_channels</a> (<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>);
|
||
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-get-active-drawable" title="gimp_image_get_active_drawable ()">gimp_image_get_active_drawable</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-get-floating-sel" title="gimp_image_get_floating_sel ()">gimp_image_get_floating_sel</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gint32</span> <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> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-pick-color" title="gimp_image_pick_color ()">gimp_image_pick_color</a> (<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="/local/head/share/gtk-doc/html/libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"><span class="type">GimpRGB</span></a> *color</code></em>);
|
||
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-pick-correlate-layer" title="gimp_image_pick_correlate_layer ()">gimp_image_pick_correlate_layer</a> (<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>);
|
||
<span class="returnvalue">gint</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-get-item-position" title="gimp_image_get_item_position ()">gimp_image_get_item_position</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-reorder-item" title="gimp_image_reorder_item ()">gimp_image_reorder_item</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-raise-item" title="gimp_image_raise_item ()">gimp_image_raise_item</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-lower-item" title="gimp_image_lower_item ()">gimp_image_lower_item</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <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> (<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>);
|
||
<span class="returnvalue">gboolean</span> <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> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-add-layer" title="gimp_image_add_layer ()">gimp_image_add_layer</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-insert-layer" title="gimp_image_insert_layer ()">gimp_image_insert_layer</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-remove-layer" title="gimp_image_remove_layer ()">gimp_image_remove_layer</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-raise-layer" title="gimp_image_raise_layer ()">gimp_image_raise_layer</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-lower-layer" title="gimp_image_lower_layer ()">gimp_image_lower_layer</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <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> (<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>);
|
||
<span class="returnvalue">gboolean</span> <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> (<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>);
|
||
<span class="returnvalue">gint</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-get-layer-position" title="gimp_image_get_layer_position ()">gimp_image_get_layer_position</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-add-channel" title="gimp_image_add_channel ()">gimp_image_add_channel</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-insert-channel" title="gimp_image_insert_channel ()">gimp_image_insert_channel</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-remove-channel" title="gimp_image_remove_channel ()">gimp_image_remove_channel</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-raise-channel" title="gimp_image_raise_channel ()">gimp_image_raise_channel</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-lower-channel" title="gimp_image_lower_channel ()">gimp_image_lower_channel</a> (<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>);
|
||
<span class="returnvalue">gint</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-get-channel-position" title="gimp_image_get_channel_position ()">gimp_image_get_channel_position</a> (<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>);
|
||
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-flatten" title="gimp_image_flatten ()">gimp_image_flatten</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-merge-visible-layers" title="gimp_image_merge_visible_layers ()">gimp_image_merge_visible_layers</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpMergeType" title="enum GimpMergeType"><span class="type">GimpMergeType</span></a> merge_type</code></em>);
|
||
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-merge-down" title="gimp_image_merge_down ()">gimp_image_merge_down</a> (<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 class="link" href="libgimp-gimpenums.html#GimpMergeType" title="enum GimpMergeType"><span class="type">GimpMergeType</span></a> merge_type</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-clean-all" title="gimp_image_clean_all ()">gimp_image_clean_all</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-is-dirty" title="gimp_image_is_dirty ()">gimp_image_is_dirty</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-get-active-layer" title="gimp_image_get_active_layer ()">gimp_image_get_active_layer</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-set-active-layer" title="gimp_image_set_active_layer ()">gimp_image_set_active_layer</a> (<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>);
|
||
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-get-active-channel" title="gimp_image_get_active_channel ()">gimp_image_get_active_channel</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-set-active-channel" title="gimp_image_set_active_channel ()">gimp_image_set_active_channel</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-unset-active-channel" title="gimp_image_unset_active_channel ()">gimp_image_unset_active_channel</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-get-selection" title="gimp_image_get_selection ()">gimp_image_get_selection</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-get-component-active" title="gimp_image_get_component_active ()">gimp_image_get_component_active</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelType"><span class="type">GimpChannelType</span></a> component</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-set-component-active" title="gimp_image_set_component_active ()">gimp_image_set_component_active</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><a href="/local/head/share/gtk-doc/html/libgimpbase/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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-get-component-visible" title="gimp_image_get_component_visible ()">gimp_image_get_component_visible</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelType"><span class="type">GimpChannelType</span></a> component</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-set-component-visible" title="gimp_image_set_component_visible ()">gimp_image_set_component_visible</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><a href="/local/head/share/gtk-doc/html/libgimpbase/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>);
|
||
<span class="returnvalue">gchar</span> * <a class="link" href="libgimp-gimpimage.html#gimp-image-get-filename" title="gimp_image_get_filename ()">gimp_image_get_filename</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-set-filename" title="gimp_image_set_filename ()">gimp_image_set_filename</a> (<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>);
|
||
<span class="returnvalue">gchar</span> * <a class="link" href="libgimp-gimpimage.html#gimp-image-get-name" title="gimp_image_get_name ()">gimp_image_get_name</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-get-resolution" title="gimp_image_get_resolution ()">gimp_image_get_resolution</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-set-resolution" title="gimp_image_set_resolution ()">gimp_image_set_resolution</a> (<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>);
|
||
<a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpunit.html#GimpUnit"><span class="returnvalue">GimpUnit</span></a> <a class="link" href="libgimp-gimpimage.html#gimp-image-get-unit" title="gimp_image_get_unit ()">gimp_image_get_unit</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-set-unit" title="gimp_image_set_unit ()">gimp_image_set_unit</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpunit.html#GimpUnit"><span class="type">GimpUnit</span></a> unit</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-set-tattoo-state" title="gimp_image_set_tattoo_state ()">gimp_image_set_tattoo_state</a> (<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>);
|
||
<span class="returnvalue">gint</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-get-tattoo-state" title="gimp_image_get_tattoo_state ()">gimp_image_get_tattoo_state</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gint32</span> <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> (<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>);
|
||
<span class="returnvalue">gint32</span> <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> (<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>);
|
||
<span class="returnvalue">gint32</span> <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> (<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>);
|
||
<span class="returnvalue">gint32</span> <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> (<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>);
|
||
<span class="returnvalue">gint32</span> <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> (<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>);
|
||
<span class="returnvalue">gint32</span> <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> (<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>);
|
||
<span class="returnvalue">guchar</span> * <a class="link" href="libgimp-gimpimage.html#gimp-image-get-cmap" title="gimp_image_get_cmap ()">gimp_image_get_cmap</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-set-cmap" title="gimp_image_set_cmap ()">gimp_image_set_cmap</a> (<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>);
|
||
<span class="returnvalue">guchar</span> * <a class="link" href="libgimp-gimpimage.html#gimp-image-get-colormap" title="gimp_image_get_colormap ()">gimp_image_get_colormap</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-set-colormap" title="gimp_image_set_colormap ()">gimp_image_set_colormap</a> (<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>);
|
||
<span class="returnvalue">gint</span> * <a class="link" href="libgimp-gimpimage.html#gimp-image-get-vectors" title="gimp_image_get_vectors ()">gimp_image_get_vectors</a> (<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>);
|
||
<span class="returnvalue">guchar</span> * <a class="link" href="libgimp-gimpimage.html#gimp-image-get-thumbnail-data" title="gimp_image_get_thumbnail_data ()">gimp_image_get_thumbnail_data</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-attach-parasite" title="gimp_image_attach_parasite ()">gimp_image_attach_parasite</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code>const <a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"><span class="type">GimpParasite</span></a> *parasite</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-detach-parasite" title="gimp_image_detach_parasite ()">gimp_image_detach_parasite</a> (<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>);
|
||
<a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"><span class="returnvalue">GimpParasite</span></a> * <a class="link" href="libgimp-gimpimage.html#gimp-image-get-parasite" title="gimp_image_get_parasite ()">gimp_image_get_parasite</a> (<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>);
|
||
<span class="returnvalue">gchar</span> ** <a class="link" href="libgimp-gimpimage.html#gimp-image-get-parasite-list" title="gimp_image_get_parasite_list ()">gimp_image_get_parasite_list</a> (<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>);
|
||
<a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"><span class="returnvalue">GimpParasite</span></a> * <a class="link" href="libgimp-gimpimage.html#gimp-image-parasite-find" title="gimp_image_parasite_find ()">gimp_image_parasite_find</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-parasite-list" title="gimp_image_parasite_list ()">gimp_image_parasite_list</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-parasite-attach" title="gimp_image_parasite_attach ()">gimp_image_parasite_attach</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code>const <a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"><span class="type">GimpParasite</span></a> *parasite</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-parasite-detach" title="gimp_image_parasite_detach ()">gimp_image_parasite_detach</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-attach-new-parasite" title="gimp_image_attach_new_parasite ()">gimp_image_attach_new_parasite</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-add-vectors" title="gimp_image_add_vectors ()">gimp_image_add_vectors</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-insert-vectors" title="gimp_image_insert_vectors ()">gimp_image_insert_vectors</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-remove-vectors" title="gimp_image_remove_vectors ()">gimp_image_remove_vectors</a> (<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>);
|
||
<span class="returnvalue">gint32</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-get-active-vectors" title="gimp_image_get_active_vectors ()">gimp_image_get_active_vectors</a> (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-set-active-vectors" title="gimp_image_set_active_vectors ()">gimp_image_set_active_vectors</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-lower-vectors" title="gimp_image_lower_vectors ()">gimp_image_lower_vectors</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-raise-vectors" title="gimp_image_raise_vectors ()">gimp_image_raise_vectors</a> (<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>);
|
||
<span class="returnvalue">gboolean</span> <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> (<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>);
|
||
<span class="returnvalue">gboolean</span> <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> (<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>);
|
||
<span class="returnvalue">gint</span> <a class="link" href="libgimp-gimpimage.html#gimp-image-get-vectors-position" title="gimp_image_get_vectors_position ()">gimp_image_get_vectors_position</a> (<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>
|
||
<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.details"></a><h2>Details</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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>num_images</code></em> :</span></p></td>
|
||
<td>The number of images currently open.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The list of images currently open.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="/local/head/share/gtk-doc/html/libgimpbase/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>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
|
||
<td>The width of the image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
|
||
<td>The height of the image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
|
||
<td>The type of image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The ID of the newly created image.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The URI.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.8</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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The imported URI.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.8</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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The exported URI.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.8</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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The imported URI.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.8</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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The new, duplicated image.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image to check.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>Whether the image ID is valid.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.4</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-image-base-type"></a><h3>gimp_image_base_type ()</h3>
|
||
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/libgimpbase/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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The image's base type.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The image's width.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The image's height.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_free_shadow</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-image-flip"></a><h3>gimp_image_flip ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_image_flip (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpOrientationType" title="enum GimpOrientationType"><span class="type">GimpOrientationType</span></a> flip_type</code></em>);</pre>
|
||
<p>
|
||
Flips the image horizontally or vertically.
|
||
</p>
|
||
<p>
|
||
This procedure flips (mirrors) the image.
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>flip_type</code></em> :</span></p></td>
|
||
<td>Type of flip.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-image-rotate"></a><h3>gimp_image_rotate ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_image_rotate (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpRotationType" title="enum GimpRotationType"><span class="type">GimpRotationType</span></a> rotate_type</code></em>);</pre>
|
||
<p>
|
||
Rotates the image by the specified degrees.
|
||
</p>
|
||
<p>
|
||
This procedure rotates the image.
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>rotate_type</code></em> :</span></p></td>
|
||
<td>Angle of rotation.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-image-resize"></a><h3>gimp_image_resize ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_image_resize (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_width</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_height</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> offx</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> offy</code></em>);</pre>
|
||
<p>
|
||
Resize the image to the specified extents.
|
||
</p>
|
||
<p>
|
||
This procedure resizes the image so that it's new width and height
|
||
are equal to the supplied parameters. Offsets are also provided
|
||
which describe the position of the previous image's content. All
|
||
channels within the image are resized according to the specified
|
||
parameters; this includes the image selection mask. All layers
|
||
within the image are repositioned according to the specified
|
||
offsets.
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>new_width</code></em> :</span></p></td>
|
||
<td>New image width.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>new_height</code></em> :</span></p></td>
|
||
<td>New image height.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>offx</code></em> :</span></p></td>
|
||
<td>x offset between upper left corner of old and new images: (new - old).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>offy</code></em> :</span></p></td>
|
||
<td>y offset between upper left corner of old and new images: (new - old).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-image-resize-to-layers"></a><h3>gimp_image_resize_to_layers ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_image_resize_to_layers (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre>
|
||
<p>
|
||
Resize the image to fit all layers.
|
||
</p>
|
||
<p>
|
||
This procedure resizes the image to the bounding box of all layers
|
||
of the image. All channels within the image are resized to the new
|
||
size; this includes the image selection mask. All layers within the
|
||
image are repositioned to the new image area.
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.2</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-image-scale"></a><h3>gimp_image_scale ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_image_scale (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_width</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_height</code></em>);</pre>
|
||
<p>
|
||
Scale the image using the default interpolation method.
|
||
</p>
|
||
<p>
|
||
This procedure scales the image so that its new width and height are
|
||
equal to the supplied parameters. All layers and channels within the
|
||
image are scaled according to the specified parameters; this
|
||
includes the image selection mask. The interpolation method used can
|
||
be set with <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-interpolation" title="gimp_context_set_interpolation ()"><code class="function">gimp_context_set_interpolation()</code></a>.
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>new_width</code></em> :</span></p></td>
|
||
<td>New image width.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>new_height</code></em> :</span></p></td>
|
||
<td>New image height.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-image-scale-full"></a><h3>gimp_image_scale_full ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_image_scale_full (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_width</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_height</code></em>,
|
||
<em class="parameter"><code><a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpbaseenums.html#GimpInterpolationType"><span class="type">GimpInterpolationType</span></a> interpolation</code></em>);</pre>
|
||
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_scale_full</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="libgimp-gimpimage.html#gimp-image-scale" title="gimp_image_scale ()"><code class="function">gimp_image_scale()</code></a> instead.</p>
|
||
</div>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>new_width</code></em> :</span></p></td>
|
||
<td>New image width.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>new_height</code></em> :</span></p></td>
|
||
<td>New image height.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>interpolation</code></em> :</span></p></td>
|
||
<td>Type of interpolation.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.6</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-image-crop"></a><h3>gimp_image_crop ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_image_crop (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_width</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> new_height</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> offx</code></em>,
|
||
<em class="parameter"><code><span class="type">gint</span> offy</code></em>);</pre>
|
||
<p>
|
||
Crop the image to the specified extents.
|
||
</p>
|
||
<p>
|
||
This procedure crops the image so that it's new width and height are
|
||
equal to the supplied parameters. Offsets are also provided which
|
||
describe the position of the previous image's content. All channels
|
||
and layers within the image are cropped to the new image extents;
|
||
this includes the image selection mask. If any parameters are out of
|
||
range, an error is returned.
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>new_width</code></em> :</span></p></td>
|
||
<td>New image width: (0 < new_width <= width).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>new_height</code></em> :</span></p></td>
|
||
<td>New image height: (0 < new_height <= height).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>offx</code></em> :</span></p></td>
|
||
<td>X offset: (0 <= offx <= (width - new_width)).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>offy</code></em> :</span></p></td>
|
||
<td>Y offset: (0 <= offy <= (height - new_height)).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>num_layers</code></em> :</span></p></td>
|
||
<td>The number of layers contained in the image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The list of layers contained in the image.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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.
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>num_channels</code></em> :</span></p></td>
|
||
<td>The number of channels contained in the image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The list of channels contained in the image.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The active drawable.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The image's floating selection.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The drawable the floating selection is attached to.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="/local/head/share/gtk-doc/html/libgimpcolor/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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>drawable_ID</code></em> :</span></p></td>
|
||
<td>The drawable to pick from.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
|
||
<td>x coordinate of upper-left corner of rectangle.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
|
||
<td>y coordinate of upper-left corner of rectangle.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>sample_merged</code></em> :</span></p></td>
|
||
<td>Use the composite image, not the drawable.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>sample_average</code></em> :</span></p></td>
|
||
<td>Average the color of all the pixels in a specified radius.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>average_radius</code></em> :</span></p></td>
|
||
<td>The radius of pixels to average.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
|
||
<td>The return color.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
|
||
<td>The x coordinate for the pick.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
|
||
<td>The y coordinate for the pick.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The layer found at the specified coordinates.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>item_ID</code></em> :</span></p></td>
|
||
<td>The item.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The position of the item in its level in the item tree.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.8</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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>item_ID</code></em> :</span></p></td>
|
||
<td>The item to reorder.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>parent_ID</code></em> :</span></p></td>
|
||
<td>The new parent item.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
|
||
<td>The new position of the item.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.8</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 procecure call will fail if there is no item above it.
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>item_ID</code></em> :</span></p></td>
|
||
<td>The item to raise.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.8</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 procecure call will fail if there is no item below it.
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>item_ID</code></em> :</span></p></td>
|
||
<td>The item to lower.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.8</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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>item_ID</code></em> :</span></p></td>
|
||
<td>The item to raise to top.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.8</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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>item_ID</code></em> :</span></p></td>
|
||
<td>The item to lower to bottom.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.8</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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_add_layer</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
|
||
<td>The layer.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
|
||
<td>The layer position.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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.
|
||
The layer type must be compatible with the image base type.
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
|
||
<td>The layer.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>parent_ID</code></em> :</span></p></td>
|
||
<td>The parent layer.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
|
||
<td>The layer position.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
|
||
<td>The layer.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_raise_layer</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
|
||
<td>The layer to raise.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_lower_layer</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
|
||
<td>The layer to lower.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_raise_layer_to_top</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
|
||
<td>The layer to raise to top.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_lower_layer_to_bottom</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
|
||
<td>The layer to lower to bottom.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_get_layer_position</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>layer_ID</code></em> :</span></p></td>
|
||
<td>The layer.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The position of the layer in the layer stack.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.4</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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_add_channel</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>channel_ID</code></em> :</span></p></td>
|
||
<td>The channel.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
|
||
<td>The channel position.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>channel_ID</code></em> :</span></p></td>
|
||
<td>The channel.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>parent_ID</code></em> :</span></p></td>
|
||
<td>The parent channel.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
|
||
<td>The channel position.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>channel_ID</code></em> :</span></p></td>
|
||
<td>The channel.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_raise_channel</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>channel_ID</code></em> :</span></p></td>
|
||
<td>The channel to raise.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_lower_channel</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>channel_ID</code></em> :</span></p></td>
|
||
<td>The channel to lower.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_get_channel_position</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>channel_ID</code></em> :</span></p></td>
|
||
<td>The channel.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The position of the channel in the channel stack.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.4</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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The resulting layer.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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 class="link" href="libgimp-gimpenums.html#GimpMergeType" title="enum 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>merge_type</code></em> :</span></p></td>
|
||
<td>The type of merge.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The resulting layer.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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 class="link" href="libgimp-gimpenums.html#GimpMergeType" title="enum 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>merge_layer_ID</code></em> :</span></p></td>
|
||
<td>The layer to merge down from.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>merge_type</code></em> :</span></p></td>
|
||
<td>The type of merge.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The resulting layer.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE if the image has unsaved changes.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The active layer.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>active_layer_ID</code></em> :</span></p></td>
|
||
<td>The new image active layer.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The active channel.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>active_channel_ID</code></em> :</span></p></td>
|
||
<td>The new image active channel.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The selection channel.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="/local/head/share/gtk-doc/html/libgimpbase/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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
|
||
<td>The image component.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>Component is active.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="/local/head/share/gtk-doc/html/libgimpbase/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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
|
||
<td>The image component.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>active</code></em> :</span></p></td>
|
||
<td>Component is active.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="/local/head/share/gtk-doc/html/libgimpbase/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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
|
||
<td>The image component.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>Component is visible.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="/local/head/share/gtk-doc/html/libgimpbase/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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>component</code></em> :</span></p></td>
|
||
<td>The image component.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>visible</code></em> :</span></p></td>
|
||
<td>Component is visible.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The filename.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
|
||
<td>The new image filename.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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 this is the base name (the last component of the
|
||
path). Otherwise it is the translated string \"Untitled\".
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The name.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>xresolution</code></em> :</span></p></td>
|
||
<td>The resolution in the x-axis, in dots per inch.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>yresolution</code></em> :</span></p></td>
|
||
<td>The resolution in the y-axis, in dots per inch.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>xresolution</code></em> :</span></p></td>
|
||
<td>The new image resolution in the x-axis, in dots per inch.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>yresolution</code></em> :</span></p></td>
|
||
<td>The new image resolution in the y-axis, in dots per inch.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-image-get-unit"></a><h3>gimp_image_get_unit ()</h3>
|
||
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/libgimpbase/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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The unit.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="/local/head/share/gtk-doc/html/libgimpbase/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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>unit</code></em> :</span></p></td>
|
||
<td>The new image unit.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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 plugins that wish to preserve an images tattoo state.
|
||
Using this function at other times will produce unexpected results.
|
||
A full check of uniqueness of states in layers, channels and paths
|
||
will be performed by this procedure and a execution failure will be
|
||
returned if this fails. A failure will also be returned if the new
|
||
tattoo state value is less than the maximum tattoo value from all of
|
||
the tattoos from the paths, layers and channels. After the image
|
||
data has been loaded and all the tattoos have been set then this is
|
||
the last procedure that should be called. If effectively does a
|
||
status check on the tattoo values that have been set to make sure
|
||
that all is OK.
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>tattoo_state</code></em> :</span></p></td>
|
||
<td>The new image tattoo state.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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 plugins that wish to preserve an images tattoo state.
|
||
Using this function at other times will produce unexpected results.
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The tattoo state.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>tattoo</code></em> :</span></p></td>
|
||
<td>The tattoo of the layer to find.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The layer with the specified tattoo.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>tattoo</code></em> :</span></p></td>
|
||
<td>The tattoo of the channel to find.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The channel with the specified tattoo.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>tattoo</code></em> :</span></p></td>
|
||
<td>The tattoo of the vectors to find.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The vectors with the specified tattoo.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.6</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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
|
||
<td>The name of the layer to find.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The layer with the specified name.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.8</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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
|
||
<td>The name of the channel to find.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The channel with the specified name.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.8</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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
|
||
<td>The name of the vectors to find.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The vectors with the specified name.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.8</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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_get_cmap</code> is deprecated and should not be used in newly-written code.</p>
|
||
</div>
|
||
<p>
|
||
This procedure is deprecated! 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 class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>num_colors</code></em> :</span></p></td>
|
||
<td>Number of colors in the colormap array.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The image's colormap.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_set_cmap</code> is deprecated and should not be used in newly-written code.</p>
|
||
</div>
|
||
<p>
|
||
This procedure is deprecated! 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 class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>cmap</code></em> :</span></p></td>
|
||
<td>The new colormap values.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>num_colors</code></em> :</span></p></td>
|
||
<td>Number of colors in the colormap array.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>num_colors</code></em> :</span></p></td>
|
||
<td>Returns the number of colors in the colormap array.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The image's colormap.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>colormap</code></em> :</span></p></td>
|
||
<td>The new colormap values.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>num_colors</code></em> :</span></p></td>
|
||
<td>Number of colors in the colormap array.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>num_vectors</code></em> :</span></p></td>
|
||
<td>The number of vectors contained in the image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The list of vectors contained in the image.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.4</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>
|
||
<p>
|
||
</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="/local/head/share/gtk-doc/html/libgimpbase/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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>parasite</code></em> :</span></p></td>
|
||
<td>The parasite to attach to an image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.8</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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
|
||
<td>The name of the parasite to detach from an image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.8</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-image-get-parasite"></a><h3>gimp_image_get_parasite ()</h3>
|
||
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/libgimpbase/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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
|
||
<td>The name of the parasite to find.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The found parasite.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.8</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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>num_parasites</code></em> :</span></p></td>
|
||
<td>The number of attached parasites.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The names of currently attached parasites.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.8</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gimp-image-parasite-find"></a><h3>gimp_image_parasite_find ()</h3>
|
||
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/libgimpbase/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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_parasite_find</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
|
||
<td>The name of the parasite to find.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The found parasite.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_parasite_list</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>num_parasites</code></em> :</span></p></td>
|
||
<td>The number of attached parasites.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>parasites</code></em> :</span></p></td>
|
||
<td>The names of currently attached parasites.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"><span class="type">GimpParasite</span></a> *parasite</code></em>);</pre>
|
||
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_parasite_attach</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>parasite</code></em> :</span></p></td>
|
||
<td>The parasite to attach to an image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_parasite_detach</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
|
||
<td>The name of the parasite to detach from an image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_attach_new_parasite</code> is deprecated and should not be used in newly-written code. Use <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> instead.</p>
|
||
</div>
|
||
<p>
|
||
Convenience function that creates a parasite and attaches it
|
||
to GIMP.
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>the ID of the image to attach the <a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"><span class="type">GimpParasite</span></a> to.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
|
||
<td>the name of the <a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"><span class="type">GimpParasite</span></a> to create and attach.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
|
||
<td>the flags set on the <a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"><span class="type">GimpParasite</span></a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
|
||
<td>the size of the parasite data in bytes.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
|
||
<td>a pointer to the data attached with the <a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"><span class="type">GimpParasite</span></a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on successful creation and attachment of
|
||
the new parasite.
|
||
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>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_add_vectors</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>vectors_ID</code></em> :</span></p></td>
|
||
<td>The vectors object.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
|
||
<td>The vectors objects position.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>vectors_ID</code></em> :</span></p></td>
|
||
<td>The vectors.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>parent_ID</code></em> :</span></p></td>
|
||
<td>The parent vectors.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
|
||
<td>The vectors position.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>vectors_ID</code></em> :</span></p></td>
|
||
<td>The vectors object.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.4</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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The active vectors.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>active_vectors_ID</code></em> :</span></p></td>
|
||
<td>The new image active vectors.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_lower_vectors</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>vectors_ID</code></em> :</span></p></td>
|
||
<td>The vectors object to lower.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.4</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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_raise_vectors</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>vectors_ID</code></em> :</span></p></td>
|
||
<td>The vectors object to raise.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.4</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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_lower_vectors_to_bottom</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>vectors_ID</code></em> :</span></p></td>
|
||
<td>The vectors object to lower to bottom.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.4</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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_raise_vectors_to_top</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>vectors_ID</code></em> :</span></p></td>
|
||
<td>The vectors object to raise to top.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>TRUE on success.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.4</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" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_image_get_vectors_position</code> is deprecated and should not be used in newly-written code. 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="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></p></td>
|
||
<td>The image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>vectors_ID</code></em> :</span></p></td>
|
||
<td>The vectors object.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td>The position of the vectors object in the vectors stack.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.4</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<hr>
|
||
Generated by GTK-Doc V1.18</div>
|
||
</body>
|
||
</html> |