~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/html/libgimp-gimpimage.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gimpimage</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
7
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
8
 
<link rel="up" href="libgimp-image.html" title="Manupulating Images and all their Properties">
 
8
<link rel="up" href="libgimp-image.html" title="Manupulating Images and their Properties">
9
9
<link rel="prev" href="libgimp-gimpguides.html" title="gimpguides">
10
10
<link rel="next" href="libgimp-gimplayer.html" title="gimplayer">
11
 
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
14
 
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;GIMP Library">
 
13
<link rel="part" href="libgimp.html" title="Part&#160;I.&#160;GIMP Library">
15
14
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
16
 
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
 
15
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
17
16
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
18
17
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
19
 
<link rel="part" href="libgimpui.html" title="Part&#160;III.&#160;GIMP User Interface Library">
 
18
<link rel="part" href="libgimpui.html" title="Part&#160;II.&#160;GIMP User Interface Library">
20
19
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
 
20
<link rel="index" href="libgimp-index.html" title="Index">
 
21
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
 
22
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
 
23
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
21
24
</head>
22
25
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
23
26
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
28
31
<th width="100%" align="center">GIMP Library Reference Manual</th>
29
32
<td><a accesskey="n" href="libgimp-gimplayer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
30
33
</tr>
31
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2566891" class="shortcut">Top</a>
 
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2559844" class="shortcut">Top</a>
32
35
                  &#160;|&#160;
33
 
                  <a href="#id2610072" class="shortcut">Description</a></nobr></td></tr>
 
36
                  <a href="#id2651822" class="shortcut">Description</a></nobr></td></tr>
34
37
</table>
35
38
<div class="refentry" lang="en">
36
39
<a name="libgimp-gimpimage"></a><div class="titlepage"></div>
37
40
<div class="refnamediv"><table width="100%"><tr>
38
41
<td valign="top">
39
42
<h2>
40
 
<a name="id2566891"></a><span class="refentrytitle">gimpimage</span>
 
43
<a name="id2559844"></a><span class="refentrytitle">gimpimage</span>
41
44
</h2>
42
45
<p>gimpimage &#8212; Operations on complete images.</p>
43
46
</td>
49
52
 
50
53
 
51
54
 
52
 
gint*       <a href="libgimp-gimpimage.html#gimp-image-list">gimp_image_list</a>                 (gint *num_images);
53
 
gint32      <a href="libgimp-gimpimage.html#gimp-image-new">gimp_image_new</a>                  (gint width,
54
 
                                             gint height,
55
 
                                             <a
 
55
gint*               <a href="libgimp-gimpimage.html#gimp-image-list">gimp_image_list</a>                     (gint *num_images);
 
56
gint32              <a href="libgimp-gimpimage.html#gimp-image-new">gimp_image_new</a>                      (gint width,
 
57
                                                         gint height,
 
58
                                                         <a
56
59
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageBaseType"
57
60
>GimpImageBaseType</a> type);
58
 
gint32      <a href="libgimp-gimpimage.html#gimp-image-duplicate">gimp_image_duplicate</a>            (gint32 image_ID);
59
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-delete">gimp_image_delete</a>               (gint32 image_ID);
 
61
gint32              <a href="libgimp-gimpimage.html#gimp-image-duplicate">gimp_image_duplicate</a>                (gint32 image_ID);
 
62
gboolean            <a href="libgimp-gimpimage.html#gimp-image-delete">gimp_image_delete</a>                   (gint32 image_ID);
 
63
gboolean            <a href="libgimp-gimpimage.html#gimp-image-is-valid">gimp_image_is_valid</a>                 (gint32 image_ID);
60
64
<a
61
65
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageBaseType"
62
 
>GimpImageBaseType</a> <a href="libgimp-gimpimage.html#gimp-image-base-type">gimp_image_base_type</a>      (gint32 image_ID);
63
 
gint        <a href="libgimp-gimpimage.html#gimp-image-width">gimp_image_width</a>                (gint32 image_ID);
64
 
gint        <a href="libgimp-gimpimage.html#gimp-image-height">gimp_image_height</a>               (gint32 image_ID);
65
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-free-shadow">gimp_image_free_shadow</a>          (gint32 image_ID);
66
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-flip">gimp_image_flip</a>                 (gint32 image_ID,
67
 
                                             <a href="libgimp-gimpenums.html#GimpOrientationType">GimpOrientationType</a> flip_type);
68
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-rotate">gimp_image_rotate</a>               (gint32 image_ID,
69
 
                                             <a href="libgimp-gimpenums.html#GimpRotationType">GimpRotationType</a> rotate_type);
70
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-resize">gimp_image_resize</a>               (gint32 image_ID,
71
 
                                             gint new_width,
72
 
                                             gint new_height,
73
 
                                             gint offx,
74
 
                                             gint offy);
75
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-resize-to-layers">gimp_image_resize_to_layers</a>     (gint32 image_ID);
76
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-scale">gimp_image_scale</a>                (gint32 image_ID,
77
 
                                             gint new_width,
78
 
                                             gint new_height);
79
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-crop">gimp_image_crop</a>                 (gint32 image_ID,
80
 
                                             gint new_width,
81
 
                                             gint new_height,
82
 
                                             gint offx,
83
 
                                             gint offy);
84
 
gint*       <a href="libgimp-gimpimage.html#gimp-image-get-layers">gimp_image_get_layers</a>           (gint32 image_ID,
85
 
                                             gint *num_layers);
86
 
gint*       <a href="libgimp-gimpimage.html#gimp-image-get-channels">gimp_image_get_channels</a>         (gint32 image_ID,
87
 
                                             gint *num_channels);
88
 
gint32      <a href="libgimp-gimpimage.html#gimp-image-get-active-drawable">gimp_image_get_active_drawable</a>  (gint32 image_ID);
89
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-unset-active-channel">gimp_image_unset_active_channel</a> (gint32 image_ID);
90
 
gint32      <a href="libgimp-gimpimage.html#gimp-image-get-floating-sel">gimp_image_get_floating_sel</a>     (gint32 image_ID);
91
 
gint32      <a href="libgimp-gimpimage.html#gimp-image-floating-sel-attached-to">gimp_image_floating_sel_attached_to</a>
92
 
                                            (gint32 image_ID);
93
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-pick-color">gimp_image_pick_color</a>           (gint32 image_ID,
94
 
                                             gint32 drawable_ID,
95
 
                                             gdouble x,
96
 
                                             gdouble y,
97
 
                                             gboolean sample_merged,
98
 
                                             gboolean sample_average,
99
 
                                             gdouble average_radius,
100
 
                                             <a
 
66
>GimpImageBaseType</a>   <a href="libgimp-gimpimage.html#gimp-image-base-type">gimp_image_base_type</a>                (gint32 image_ID);
 
67
gint                <a href="libgimp-gimpimage.html#gimp-image-width">gimp_image_width</a>                    (gint32 image_ID);
 
68
gint                <a href="libgimp-gimpimage.html#gimp-image-height">gimp_image_height</a>                   (gint32 image_ID);
 
69
gboolean            <a href="libgimp-gimpimage.html#gimp-image-free-shadow">gimp_image_free_shadow</a>              (gint32 image_ID);
 
70
gboolean            <a href="libgimp-gimpimage.html#gimp-image-flip">gimp_image_flip</a>                     (gint32 image_ID,
 
71
                                                         <a href="libgimp-gimpenums.html#GimpOrientationType">GimpOrientationType</a> flip_type);
 
72
gboolean            <a href="libgimp-gimpimage.html#gimp-image-rotate">gimp_image_rotate</a>                   (gint32 image_ID,
 
73
                                                         <a href="libgimp-gimpenums.html#GimpRotationType">GimpRotationType</a> rotate_type);
 
74
gboolean            <a href="libgimp-gimpimage.html#gimp-image-resize">gimp_image_resize</a>                   (gint32 image_ID,
 
75
                                                         gint new_width,
 
76
                                                         gint new_height,
 
77
                                                         gint offx,
 
78
                                                         gint offy);
 
79
gboolean            <a href="libgimp-gimpimage.html#gimp-image-resize-to-layers">gimp_image_resize_to_layers</a>         (gint32 image_ID);
 
80
gboolean            <a href="libgimp-gimpimage.html#gimp-image-scale">gimp_image_scale</a>                    (gint32 image_ID,
 
81
                                                         gint new_width,
 
82
                                                         gint new_height);
 
83
gboolean            <a href="libgimp-gimpimage.html#gimp-image-crop">gimp_image_crop</a>                     (gint32 image_ID,
 
84
                                                         gint new_width,
 
85
                                                         gint new_height,
 
86
                                                         gint offx,
 
87
                                                         gint offy);
 
88
gint*               <a href="libgimp-gimpimage.html#gimp-image-get-layers">gimp_image_get_layers</a>               (gint32 image_ID,
 
89
                                                         gint *num_layers);
 
90
gint*               <a href="libgimp-gimpimage.html#gimp-image-get-channels">gimp_image_get_channels</a>             (gint32 image_ID,
 
91
                                                         gint *num_channels);
 
92
gint32              <a href="libgimp-gimpimage.html#gimp-image-get-active-drawable">gimp_image_get_active_drawable</a>      (gint32 image_ID);
 
93
gint32              <a href="libgimp-gimpimage.html#gimp-image-get-floating-sel">gimp_image_get_floating_sel</a>         (gint32 image_ID);
 
94
gint32              <a href="libgimp-gimpimage.html#gimp-image-floating-sel-attached-to">gimp_image_floating_sel_attached_to</a> (gint32 image_ID);
 
95
gboolean            <a href="libgimp-gimpimage.html#gimp-image-pick-color">gimp_image_pick_color</a>               (gint32 image_ID,
 
96
                                                         gint32 drawable_ID,
 
97
                                                         gdouble x,
 
98
                                                         gdouble y,
 
99
                                                         gboolean sample_merged,
 
100
                                                         gboolean sample_average,
 
101
                                                         gdouble average_radius,
 
102
                                                         <a
101
103
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
102
104
>GimpRGB</a> *color);
103
 
gint32      <a href="libgimp-gimpimage.html#gimp-image-pick-correlate-layer">gimp_image_pick_correlate_layer</a> (gint32 image_ID,
104
 
                                             gint x,
105
 
                                             gint y);
106
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-add-layer">gimp_image_add_layer</a>            (gint32 image_ID,
107
 
                                             gint32 layer_ID,
108
 
                                             gint position);
109
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-remove-layer">gimp_image_remove_layer</a>         (gint32 image_ID,
110
 
                                             gint32 layer_ID);
111
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-raise-layer">gimp_image_raise_layer</a>          (gint32 image_ID,
112
 
                                             gint32 layer_ID);
113
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-lower-layer">gimp_image_lower_layer</a>          (gint32 image_ID,
114
 
                                             gint32 layer_ID);
115
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-raise-layer-to-top">gimp_image_raise_layer_to_top</a>   (gint32 image_ID,
116
 
                                             gint32 layer_ID);
117
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-lower-layer-to-bottom">gimp_image_lower_layer_to_bottom</a>
118
 
                                            (gint32 image_ID,
119
 
                                             gint32 layer_ID);
120
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-add-channel">gimp_image_add_channel</a>          (gint32 image_ID,
121
 
                                             gint32 channel_ID,
122
 
                                             gint position);
123
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-remove-channel">gimp_image_remove_channel</a>       (gint32 image_ID,
124
 
                                             gint32 channel_ID);
125
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-raise-channel">gimp_image_raise_channel</a>        (gint32 image_ID,
126
 
                                             gint32 channel_ID);
127
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-lower-channel">gimp_image_lower_channel</a>        (gint32 image_ID,
128
 
                                             gint32 layer_ID);
129
 
gint32      <a href="libgimp-gimpimage.html#gimp-image-flatten">gimp_image_flatten</a>              (gint32 image_ID);
130
 
gint32      <a href="libgimp-gimpimage.html#gimp-image-merge-visible-layers">gimp_image_merge_visible_layers</a> (gint32 image_ID,
131
 
                                             <a href="libgimp-gimpenums.html#GimpMergeType">GimpMergeType</a> merge_type);
132
 
gint32      <a href="libgimp-gimpimage.html#gimp-image-merge-down">gimp_image_merge_down</a>           (gint32 image_ID,
133
 
                                             gint32 merge_layer_ID,
134
 
                                             <a href="libgimp-gimpenums.html#GimpMergeType">GimpMergeType</a> merge_type);
135
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-clean-all">gimp_image_clean_all</a>            (gint32 image_ID);
136
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-is-dirty">gimp_image_is_dirty</a>             (gint32 image_ID);
137
 
gint32      <a href="libgimp-gimpimage.html#gimp-image-get-active-layer">gimp_image_get_active_layer</a>     (gint32 image_ID);
138
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-set-active-layer">gimp_image_set_active_layer</a>     (gint32 image_ID,
139
 
                                             gint32 active_layer_ID);
140
 
gint32      <a href="libgimp-gimpimage.html#gimp-image-get-active-channel">gimp_image_get_active_channel</a>   (gint32 image_ID);
141
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-set-active-channel">gimp_image_set_active_channel</a>   (gint32 image_ID,
142
 
                                             gint32 active_channel_ID);
143
 
gint32      <a href="libgimp-gimpimage.html#gimp-image-get-selection">gimp_image_get_selection</a>        (gint32 image_ID);
144
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-get-component-active">gimp_image_get_component_active</a> (gint32 image_ID,
145
 
                                             <a href="libgimp-gimpenums.html#GimpChannelType">GimpChannelType</a> component);
146
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-set-component-active">gimp_image_set_component_active</a> (gint32 image_ID,
147
 
                                             <a href="libgimp-gimpenums.html#GimpChannelType">GimpChannelType</a> component,
148
 
                                             gboolean active);
149
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-get-component-visible">gimp_image_get_component_visible</a>
150
 
                                            (gint32 image_ID,
151
 
                                             <a href="libgimp-gimpenums.html#GimpChannelType">GimpChannelType</a> component);
152
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-set-component-visible">gimp_image_set_component_visible</a>
153
 
                                            (gint32 image_ID,
154
 
                                             <a href="libgimp-gimpenums.html#GimpChannelType">GimpChannelType</a> component,
155
 
                                             gboolean visible);
156
 
gchar*      <a href="libgimp-gimpimage.html#gimp-image-get-filename">gimp_image_get_filename</a>         (gint32 image_ID);
157
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-set-filename">gimp_image_set_filename</a>         (gint32 image_ID,
158
 
                                             const gchar *filename);
159
 
gchar*      <a href="libgimp-gimpimage.html#gimp-image-get-name">gimp_image_get_name</a>             (gint32 image_ID);
160
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-get-resolution">gimp_image_get_resolution</a>       (gint32 image_ID,
161
 
                                             gdouble *xresolution,
162
 
                                             gdouble *yresolution);
163
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-set-resolution">gimp_image_set_resolution</a>       (gint32 image_ID,
164
 
                                             gdouble xresolution,
165
 
                                             gdouble yresolution);
 
105
gint32              <a href="libgimp-gimpimage.html#gimp-image-pick-correlate-layer">gimp_image_pick_correlate_layer</a>     (gint32 image_ID,
 
106
                                                         gint x,
 
107
                                                         gint y);
 
108
gboolean            <a href="libgimp-gimpimage.html#gimp-image-add-layer">gimp_image_add_layer</a>                (gint32 image_ID,
 
109
                                                         gint32 layer_ID,
 
110
                                                         gint position);
 
111
gboolean            <a href="libgimp-gimpimage.html#gimp-image-remove-layer">gimp_image_remove_layer</a>             (gint32 image_ID,
 
112
                                                         gint32 layer_ID);
 
113
gboolean            <a href="libgimp-gimpimage.html#gimp-image-raise-layer">gimp_image_raise_layer</a>              (gint32 image_ID,
 
114
                                                         gint32 layer_ID);
 
115
gboolean            <a href="libgimp-gimpimage.html#gimp-image-lower-layer">gimp_image_lower_layer</a>              (gint32 image_ID,
 
116
                                                         gint32 layer_ID);
 
117
gboolean            <a href="libgimp-gimpimage.html#gimp-image-raise-layer-to-top">gimp_image_raise_layer_to_top</a>       (gint32 image_ID,
 
118
                                                         gint32 layer_ID);
 
119
gboolean            <a href="libgimp-gimpimage.html#gimp-image-lower-layer-to-bottom">gimp_image_lower_layer_to_bottom</a>    (gint32 image_ID,
 
120
                                                         gint32 layer_ID);
 
121
gint                <a href="libgimp-gimpimage.html#gimp-image-get-layer-position">gimp_image_get_layer_position</a>       (gint32 image_ID,
 
122
                                                         gint32 layer_ID);
 
123
gboolean            <a href="libgimp-gimpimage.html#gimp-image-add-channel">gimp_image_add_channel</a>              (gint32 image_ID,
 
124
                                                         gint32 channel_ID,
 
125
                                                         gint position);
 
126
gboolean            <a href="libgimp-gimpimage.html#gimp-image-remove-channel">gimp_image_remove_channel</a>           (gint32 image_ID,
 
127
                                                         gint32 channel_ID);
 
128
gboolean            <a href="libgimp-gimpimage.html#gimp-image-raise-channel">gimp_image_raise_channel</a>            (gint32 image_ID,
 
129
                                                         gint32 channel_ID);
 
130
gboolean            <a href="libgimp-gimpimage.html#gimp-image-lower-channel">gimp_image_lower_channel</a>            (gint32 image_ID,
 
131
                                                         gint32 channel_ID);
 
132
gint                <a href="libgimp-gimpimage.html#gimp-image-get-channel-position">gimp_image_get_channel_position</a>     (gint32 image_ID,
 
133
                                                         gint32 channel_ID);
 
134
gint32              <a href="libgimp-gimpimage.html#gimp-image-flatten">gimp_image_flatten</a>                  (gint32 image_ID);
 
135
gint32              <a href="libgimp-gimpimage.html#gimp-image-merge-visible-layers">gimp_image_merge_visible_layers</a>     (gint32 image_ID,
 
136
                                                         <a href="libgimp-gimpenums.html#GimpMergeType">GimpMergeType</a> merge_type);
 
137
gint32              <a href="libgimp-gimpimage.html#gimp-image-merge-down">gimp_image_merge_down</a>               (gint32 image_ID,
 
138
                                                         gint32 merge_layer_ID,
 
139
                                                         <a href="libgimp-gimpenums.html#GimpMergeType">GimpMergeType</a> merge_type);
 
140
gboolean            <a href="libgimp-gimpimage.html#gimp-image-clean-all">gimp_image_clean_all</a>                (gint32 image_ID);
 
141
gboolean            <a href="libgimp-gimpimage.html#gimp-image-is-dirty">gimp_image_is_dirty</a>                 (gint32 image_ID);
 
142
gint32              <a href="libgimp-gimpimage.html#gimp-image-get-active-layer">gimp_image_get_active_layer</a>         (gint32 image_ID);
 
143
gboolean            <a href="libgimp-gimpimage.html#gimp-image-set-active-layer">gimp_image_set_active_layer</a>         (gint32 image_ID,
 
144
                                                         gint32 active_layer_ID);
 
145
gint32              <a href="libgimp-gimpimage.html#gimp-image-get-active-channel">gimp_image_get_active_channel</a>       (gint32 image_ID);
 
146
gboolean            <a href="libgimp-gimpimage.html#gimp-image-set-active-channel">gimp_image_set_active_channel</a>       (gint32 image_ID,
 
147
                                                         gint32 active_channel_ID);
 
148
gboolean            <a href="libgimp-gimpimage.html#gimp-image-unset-active-channel">gimp_image_unset_active_channel</a>     (gint32 image_ID);
 
149
gint32              <a href="libgimp-gimpimage.html#gimp-image-get-selection">gimp_image_get_selection</a>            (gint32 image_ID);
 
150
gboolean            <a href="libgimp-gimpimage.html#gimp-image-get-component-active">gimp_image_get_component_active</a>     (gint32 image_ID,
 
151
                                                         <a
 
152
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelType"
 
153
>GimpChannelType</a> component);
 
154
gboolean            <a href="libgimp-gimpimage.html#gimp-image-set-component-active">gimp_image_set_component_active</a>     (gint32 image_ID,
 
155
                                                         <a
 
156
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelType"
 
157
>GimpChannelType</a> component,
 
158
                                                         gboolean active);
 
159
gboolean            <a href="libgimp-gimpimage.html#gimp-image-get-component-visible">gimp_image_get_component_visible</a>    (gint32 image_ID,
 
160
                                                         <a
 
161
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelType"
 
162
>GimpChannelType</a> component);
 
163
gboolean            <a href="libgimp-gimpimage.html#gimp-image-set-component-visible">gimp_image_set_component_visible</a>    (gint32 image_ID,
 
164
                                                         <a
 
165
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelType"
 
166
>GimpChannelType</a> component,
 
167
                                                         gboolean visible);
 
168
gchar*              <a href="libgimp-gimpimage.html#gimp-image-get-filename">gimp_image_get_filename</a>             (gint32 image_ID);
 
169
gboolean            <a href="libgimp-gimpimage.html#gimp-image-set-filename">gimp_image_set_filename</a>             (gint32 image_ID,
 
170
                                                         const gchar *filename);
 
171
gchar*              <a href="libgimp-gimpimage.html#gimp-image-get-name">gimp_image_get_name</a>                 (gint32 image_ID);
 
172
gboolean            <a href="libgimp-gimpimage.html#gimp-image-get-resolution">gimp_image_get_resolution</a>           (gint32 image_ID,
 
173
                                                         gdouble *xresolution,
 
174
                                                         gdouble *yresolution);
 
175
gboolean            <a href="libgimp-gimpimage.html#gimp-image-set-resolution">gimp_image_set_resolution</a>           (gint32 image_ID,
 
176
                                                         gdouble xresolution,
 
177
                                                         gdouble yresolution);
166
178
<a
167
179
href="../libgimpbase/libgimpbase-gimpunit.html#GimpUnit"
168
 
>GimpUnit</a>    <a href="libgimp-gimpimage.html#gimp-image-get-unit">gimp_image_get_unit</a>             (gint32 image_ID);
169
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-set-unit">gimp_image_set_unit</a>             (gint32 image_ID,
170
 
                                             <a
 
180
>GimpUnit</a>            <a href="libgimp-gimpimage.html#gimp-image-get-unit">gimp_image_get_unit</a>                 (gint32 image_ID);
 
181
gboolean            <a href="libgimp-gimpimage.html#gimp-image-set-unit">gimp_image_set_unit</a>                 (gint32 image_ID,
 
182
                                                         <a
171
183
href="../libgimpbase/libgimpbase-gimpunit.html#GimpUnit"
172
184
>GimpUnit</a> unit);
173
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-set-tattoo-state">gimp_image_set_tattoo_state</a>     (gint32 image_ID,
174
 
                                             gint tattoo_state);
175
 
gint        <a href="libgimp-gimpimage.html#gimp-image-get-tattoo-state">gimp_image_get_tattoo_state</a>     (gint32 image_ID);
176
 
gint32      <a href="libgimp-gimpimage.html#gimp-image-get-layer-by-tattoo">gimp_image_get_layer_by_tattoo</a>  (gint32 image_ID,
177
 
                                             gint tattoo);
178
 
gint32      <a href="libgimp-gimpimage.html#gimp-image-get-channel-by-tattoo">gimp_image_get_channel_by_tattoo</a>
179
 
                                            (gint32 image_ID,
180
 
                                             gint tattoo);
181
 
guchar*     <a href="libgimp-gimpimage.html#gimp-image-get-cmap">gimp_image_get_cmap</a>             (gint32 image_ID,
182
 
                                             gint *num_colors);
183
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-set-cmap">gimp_image_set_cmap</a>             (gint32 image_ID,
184
 
                                             const guchar *cmap,
185
 
                                             gint num_colors);
186
 
guchar*     <a href="libgimp-gimpimage.html#gimp-image-get-colormap">gimp_image_get_colormap</a>         (gint32 image_ID,
187
 
                                             gint *num_colors);
188
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-set-colormap">gimp_image_set_colormap</a>         (gint32 image_ID,
189
 
                                             const guchar *colormap,
190
 
                                             gint num_colors);
191
 
guchar*     <a href="libgimp-gimpimage.html#gimp-image-get-thumbnail-data">gimp_image_get_thumbnail_data</a>   (gint32 image_ID,
192
 
                                             gint *width,
193
 
                                             gint *height,
194
 
                                             gint *bpp);
 
185
gboolean            <a href="libgimp-gimpimage.html#gimp-image-set-tattoo-state">gimp_image_set_tattoo_state</a>         (gint32 image_ID,
 
186
                                                         gint tattoo_state);
 
187
gint                <a href="libgimp-gimpimage.html#gimp-image-get-tattoo-state">gimp_image_get_tattoo_state</a>         (gint32 image_ID);
 
188
gint32              <a href="libgimp-gimpimage.html#gimp-image-get-layer-by-tattoo">gimp_image_get_layer_by_tattoo</a>      (gint32 image_ID,
 
189
                                                         gint tattoo);
 
190
gint32              <a href="libgimp-gimpimage.html#gimp-image-get-channel-by-tattoo">gimp_image_get_channel_by_tattoo</a>    (gint32 image_ID,
 
191
                                                         gint tattoo);
 
192
guchar*             <a href="libgimp-gimpimage.html#gimp-image-get-cmap">gimp_image_get_cmap</a>                 (gint32 image_ID,
 
193
                                                         gint *num_colors);
 
194
gboolean            <a href="libgimp-gimpimage.html#gimp-image-set-cmap">gimp_image_set_cmap</a>                 (gint32 image_ID,
 
195
                                                         const guchar *cmap,
 
196
                                                         gint num_colors);
 
197
guchar*             <a href="libgimp-gimpimage.html#gimp-image-get-colormap">gimp_image_get_colormap</a>             (gint32 image_ID,
 
198
                                                         gint *num_colors);
 
199
gboolean            <a href="libgimp-gimpimage.html#gimp-image-set-colormap">gimp_image_set_colormap</a>             (gint32 image_ID,
 
200
                                                         const guchar *colormap,
 
201
                                                         gint num_colors);
 
202
gint*               <a href="libgimp-gimpimage.html#gimp-image-get-vectors">gimp_image_get_vectors</a>              (gint32 image_ID,
 
203
                                                         gint *num_vectors);
 
204
guchar*             <a href="libgimp-gimpimage.html#gimp-image-get-thumbnail-data">gimp_image_get_thumbnail_data</a>       (gint32 image_ID,
 
205
                                                         gint *width,
 
206
                                                         gint *height,
 
207
                                                         gint *bpp);
195
208
<a
196
209
href="../libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"
197
 
>GimpParasite</a>* <a href="libgimp-gimpimage.html#gimp-image-parasite-find">gimp_image_parasite_find</a>      (gint32 image_ID,
198
 
                                             const gchar *name);
199
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-parasite-list">gimp_image_parasite_list</a>        (gint32 image_ID,
200
 
                                             gint *num_parasites,
201
 
                                             gchar ***parasites);
202
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-parasite-attach">gimp_image_parasite_attach</a>      (gint32 image_ID,
203
 
                                             <a
 
210
>GimpParasite</a>*       <a href="libgimp-gimpimage.html#gimp-image-parasite-find">gimp_image_parasite_find</a>            (gint32 image_ID,
 
211
                                                         const gchar *name);
 
212
gboolean            <a href="libgimp-gimpimage.html#gimp-image-parasite-list">gimp_image_parasite_list</a>            (gint32 image_ID,
 
213
                                                         gint *num_parasites,
 
214
                                                         gchar ***parasites);
 
215
gboolean            <a href="libgimp-gimpimage.html#gimp-image-parasite-attach">gimp_image_parasite_attach</a>          (gint32 image_ID,
 
216
                                                         const <a
204
217
href="../libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"
205
218
>GimpParasite</a> *parasite);
206
 
gboolean    <a href="libgimp-gimpimage.html#gimp-image-parasite-detach">gimp_image_parasite_detach</a>      (gint32 image_ID,
207
 
                                             const gchar *name);
208
 
void        <a href="libgimp-gimpimage.html#gimp-image-attach-new-parasite">gimp_image_attach_new_parasite</a>  (gint32 image_ID,
209
 
                                             const gchar *name,
210
 
                                             gint flags,
211
 
                                             gint size,
212
 
                                             gconstpointer data);
 
219
gboolean            <a href="libgimp-gimpimage.html#gimp-image-parasite-detach">gimp_image_parasite_detach</a>          (gint32 image_ID,
 
220
                                                         const gchar *name);
 
221
gboolean            <a href="libgimp-gimpimage.html#gimp-image-attach-new-parasite">gimp_image_attach_new_parasite</a>      (gint32 image_ID,
 
222
                                                         const gchar *name,
 
223
                                                         gint flags,
 
224
                                                         gint size,
 
225
                                                         gconstpointer data);
 
226
gboolean            <a href="libgimp-gimpimage.html#gimp-image-add-vectors">gimp_image_add_vectors</a>              (gint32 image_ID,
 
227
                                                         gint32 vectors_ID,
 
228
                                                         gint position);
 
229
gboolean            <a href="libgimp-gimpimage.html#gimp-image-remove-vectors">gimp_image_remove_vectors</a>           (gint32 image_ID,
 
230
                                                         gint32 vectors_ID);
 
231
gint32              <a href="libgimp-gimpimage.html#gimp-image-get-active-vectors">gimp_image_get_active_vectors</a>       (gint32 image_ID);
 
232
gboolean            <a href="libgimp-gimpimage.html#gimp-image-set-active-vectors">gimp_image_set_active_vectors</a>       (gint32 image_ID,
 
233
                                                         gint32 active_vectors_ID);
 
234
gboolean            <a href="libgimp-gimpimage.html#gimp-image-lower-vectors">gimp_image_lower_vectors</a>            (gint32 image_ID,
 
235
                                                         gint32 vectors_ID);
 
236
gboolean            <a href="libgimp-gimpimage.html#gimp-image-raise-vectors">gimp_image_raise_vectors</a>            (gint32 image_ID,
 
237
                                                         gint32 vectors_ID);
 
238
gboolean            <a href="libgimp-gimpimage.html#gimp-image-lower-vectors-to-bottom">gimp_image_lower_vectors_to_bottom</a>  (gint32 image_ID,
 
239
                                                         gint32 vectors_ID);
 
240
gboolean            <a href="libgimp-gimpimage.html#gimp-image-raise-vectors-to-top">gimp_image_raise_vectors_to_top</a>     (gint32 image_ID,
 
241
                                                         gint32 vectors_ID);
 
242
gint                <a href="libgimp-gimpimage.html#gimp-image-get-vectors-position">gimp_image_get_vectors_position</a>     (gint32 image_ID,
 
243
                                                         gint32 vectors_ID);
213
244
</pre>
214
245
</div>
215
246
<div class="refsect1" lang="en">
216
 
<a name="id2610072"></a><h2>Description</h2>
 
247
<a name="id2651822"></a><h2>Description</h2>
217
248
<p>
218
249
Operations on complete images: creation, resizing/rescaling,
219
250
and operations involving multiple layers.
221
252
</p>
222
253
</div>
223
254
<div class="refsect1" lang="en">
224
 
<a name="id2610090"></a><h2>Details</h2>
 
255
<a name="id2651838"></a><h2>Details</h2>
225
256
<div class="refsect2" lang="en">
226
 
<a name="id2610100"></a><h3>
 
257
<a name="id2651847"></a><h3>
227
258
<a name="gimp-image-list"></a>gimp_image_list ()</h3>
228
 
<a class="indexterm" name="id2610113"></a><pre class="programlisting">gint*       gimp_image_list                 (gint *num_images);</pre>
 
259
<a class="indexterm" name="id2651858"></a><pre class="programlisting">gint*               gimp_image_list                     (gint *num_images);</pre>
229
260
<p>
230
261
Returns the list of images currently open.
231
262
</p>
239
270
<col align="left" valign="top">
240
271
<tbody>
241
272
<tr>
242
 
<td>
243
 
<span class="term"><em class="parameter"><code>num_images</code></em>&#160;:</span></td>
 
273
<td><span class="term"><em class="parameter"><code>num_images</code></em>&#160;:</span></td>
244
274
<td> The number of images currently open.
245
275
</td>
246
276
</tr>
247
277
<tr>
248
 
<td>
249
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
278
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
250
279
<td> The list of images currently open.
251
280
</td>
252
281
</tr>
255
284
</div>
256
285
<hr>
257
286
<div class="refsect2" lang="en">
258
 
<a name="id2610178"></a><h3>
 
287
<a name="id2651918"></a><h3>
259
288
<a name="gimp-image-new"></a>gimp_image_new ()</h3>
260
 
<a class="indexterm" name="id2610190"></a><pre class="programlisting">gint32      gimp_image_new                  (gint width,
261
 
                                             gint height,
262
 
                                             <a
 
289
<a class="indexterm" name="id2651929"></a><pre class="programlisting">gint32              gimp_image_new                      (gint width,
 
290
                                                         gint height,
 
291
                                                         <a
263
292
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageBaseType"
264
293
>GimpImageBaseType</a> type);</pre>
265
294
<p>
268
297
<p>
269
298
Creates a new image, undisplayed with the specified extents and
270
299
type. A layer should be created and added before this image is
271
 
displayed, or subsequent calls to 'gimp_display_new' with this image
 
300
displayed, or subsequent calls to <a href="libgimp-gimpdisplay.html#gimp-display-new"><code class="function">gimp_display_new()</code></a> with this image
272
301
as an argument will fail. Layers can be created using the
273
 
'gimp_layer_new' commands. They can be added to an image using the
274
 
'gimp_image_add_layer' command.</p>
 
302
<a href="libgimp-gimplayer.html#gimp-layer-new"><code class="function">gimp_layer_new()</code></a> commands. They can be added to an image using the
 
303
<a href="libgimp-gimpimage.html#gimp-image-add-layer"><code class="function">gimp_image_add_layer()</code></a> command.</p>
275
304
<p>
276
305
 
277
306
</p>
279
308
<col align="left" valign="top">
280
309
<tbody>
281
310
<tr>
282
 
<td>
283
 
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
 
311
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
284
312
<td> The width of the image.
285
313
</td>
286
314
</tr>
287
315
<tr>
288
 
<td>
289
 
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
 
316
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
290
317
<td> The height of the image.
291
318
</td>
292
319
</tr>
293
320
<tr>
294
 
<td>
295
 
<span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></td>
 
321
<td><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></td>
296
322
<td> The type of image.
297
323
</td>
298
324
</tr>
299
325
<tr>
300
 
<td>
301
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
326
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
302
327
<td> The ID of the newly created image.
303
328
</td>
304
329
</tr>
307
332
</div>
308
333
<hr>
309
334
<div class="refsect2" lang="en">
310
 
<a name="id2610303"></a><h3>
 
335
<a name="id2652055"></a><h3>
311
336
<a name="gimp-image-duplicate"></a>gimp_image_duplicate ()</h3>
312
 
<a class="indexterm" name="id2610314"></a><pre class="programlisting">gint32      gimp_image_duplicate            (gint32 image_ID);</pre>
 
337
<a class="indexterm" name="id2652066"></a><pre class="programlisting">gint32              gimp_image_duplicate                (gint32 image_ID);</pre>
313
338
<p>
314
339
Duplicate the specified image
315
340
</p>
323
348
<col align="left" valign="top">
324
349
<tbody>
325
350
<tr>
326
 
<td>
327
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
351
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
328
352
<td> The image.
329
353
</td>
330
354
</tr>
331
355
<tr>
332
 
<td>
333
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
356
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
334
357
<td> The new, duplicated image.
335
358
</td>
336
359
</tr>
339
362
</div>
340
363
<hr>
341
364
<div class="refsect2" lang="en">
342
 
<a name="id2610381"></a><h3>
 
365
<a name="id2652126"></a><h3>
343
366
<a name="gimp-image-delete"></a>gimp_image_delete ()</h3>
344
 
<a class="indexterm" name="id2610393"></a><pre class="programlisting">gboolean    gimp_image_delete               (gint32 image_ID);</pre>
 
367
<a class="indexterm" name="id2652136"></a><pre class="programlisting">gboolean            gimp_image_delete                   (gint32 image_ID);</pre>
345
368
<p>
346
369
Delete the specified image.
347
370
</p>
359
382
<col align="left" valign="top">
360
383
<tbody>
361
384
<tr>
362
 
<td>
363
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
385
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
364
386
<td> The image.
365
387
</td>
366
388
</tr>
367
389
<tr>
368
 
<td>
369
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
390
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
370
391
<td> TRUE on success.
371
392
</td>
372
393
</tr>
375
396
</div>
376
397
<hr>
377
398
<div class="refsect2" lang="en">
378
 
<a name="id2610463"></a><h3>
 
399
<a name="id2652199"></a><h3>
 
400
<a name="gimp-image-is-valid"></a>gimp_image_is_valid ()</h3>
 
401
<a class="indexterm" name="id2652212"></a><pre class="programlisting">gboolean            gimp_image_is_valid                 (gint32 image_ID);</pre>
 
402
<p>
 
403
Returns TRUE if the image is valid.
 
404
</p>
 
405
<p>
 
406
This procedure checks if the given image ID is valid and refers to
 
407
an existing image.</p>
 
408
<p>
 
409
 
 
410
</p>
 
411
<div class="variablelist"><table border="0">
 
412
<col align="left" valign="top">
 
413
<tbody>
 
414
<tr>
 
415
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
416
<td> The image to check.
 
417
</td>
 
418
</tr>
 
419
<tr>
 
420
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
421
<td> Whether the image ID is valid.
 
422
 
 
423
</td>
 
424
</tr>
 
425
</tbody>
 
426
</table></div>
 
427
<p class="since">Since  GIMP 2.4
 
428
</p>
 
429
</div>
 
430
<hr>
 
431
<div class="refsect2" lang="en">
 
432
<a name="id2652278"></a><h3>
379
433
<a name="gimp-image-base-type"></a>gimp_image_base_type ()</h3>
380
 
<a class="indexterm" name="id2610474"></a><pre class="programlisting"><a
 
434
<a class="indexterm" name="id2652288"></a><pre class="programlisting"><a
381
435
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageBaseType"
382
 
>GimpImageBaseType</a> gimp_image_base_type      (gint32 image_ID);</pre>
 
436
>GimpImageBaseType</a>   gimp_image_base_type                (gint32 image_ID);</pre>
383
437
<p>
384
438
Get the base type of the image.
385
439
</p>
393
447
<col align="left" valign="top">
394
448
<tbody>
395
449
<tr>
396
 
<td>
397
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
450
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
398
451
<td> The image.
399
452
</td>
400
453
</tr>
401
454
<tr>
402
 
<td>
403
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
455
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
404
456
<td> The image's base type.
405
457
</td>
406
458
</tr>
409
461
</div>
410
462
<hr>
411
463
<div class="refsect2" lang="en">
412
 
<a name="id2610540"></a><h3>
 
464
<a name="id2652348"></a><h3>
413
465
<a name="gimp-image-width"></a>gimp_image_width ()</h3>
414
 
<a class="indexterm" name="id2610553"></a><pre class="programlisting">gint        gimp_image_width                (gint32 image_ID);</pre>
 
466
<a class="indexterm" name="id2652358"></a><pre class="programlisting">gint                gimp_image_width                    (gint32 image_ID);</pre>
415
467
<p>
416
468
Return the width of the image
417
469
</p>
425
477
<col align="left" valign="top">
426
478
<tbody>
427
479
<tr>
428
 
<td>
429
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
480
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
430
481
<td> The image.
431
482
</td>
432
483
</tr>
433
484
<tr>
434
 
<td>
435
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
485
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
436
486
<td> The image's width.
437
487
</td>
438
488
</tr>
441
491
</div>
442
492
<hr>
443
493
<div class="refsect2" lang="en">
444
 
<a name="id2610619"></a><h3>
 
494
<a name="id2652418"></a><h3>
445
495
<a name="gimp-image-height"></a>gimp_image_height ()</h3>
446
 
<a class="indexterm" name="id2610631"></a><pre class="programlisting">gint        gimp_image_height               (gint32 image_ID);</pre>
 
496
<a class="indexterm" name="id2652428"></a><pre class="programlisting">gint                gimp_image_height                   (gint32 image_ID);</pre>
447
497
<p>
448
498
Return the height of the image
449
499
</p>
457
507
<col align="left" valign="top">
458
508
<tbody>
459
509
<tr>
460
 
<td>
461
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
510
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
462
511
<td> The image.
463
512
</td>
464
513
</tr>
465
514
<tr>
466
 
<td>
467
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
515
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
468
516
<td> The image's height.
469
517
</td>
470
518
</tr>
473
521
</div>
474
522
<hr>
475
523
<div class="refsect2" lang="en">
476
 
<a name="id2610697"></a><h3>
 
524
<a name="id2652488"></a><h3>
477
525
<a name="gimp-image-free-shadow"></a>gimp_image_free_shadow ()</h3>
478
 
<a class="indexterm" name="id2610709"></a><pre class="programlisting">gboolean    gimp_image_free_shadow          (gint32 image_ID);</pre>
 
526
<a class="indexterm" name="id2652498"></a><pre class="programlisting">gboolean            gimp_image_free_shadow              (gint32 image_ID);</pre>
479
527
<p>
480
528
Free the specified image's shadow data (if it exists).
481
529
</p>
482
530
<p>
483
531
This procedure is intended as a memory saving device. If any shadow
484
532
memory has been allocated, it will be freed automatically on a call
485
 
to 'gimp_image_delete'.</p>
 
533
to <a href="libgimp-gimpimage.html#gimp-image-delete"><code class="function">gimp_image_delete()</code></a>.</p>
486
534
<p>
487
535
 
488
536
</p>
490
538
<col align="left" valign="top">
491
539
<tbody>
492
540
<tr>
493
 
<td>
494
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
541
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
495
542
<td> The image.
496
543
</td>
497
544
</tr>
498
545
<tr>
499
 
<td>
500
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
546
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
501
547
<td> TRUE on success.
502
548
</td>
503
549
</tr>
506
552
</div>
507
553
<hr>
508
554
<div class="refsect2" lang="en">
509
 
<a name="id2610776"></a><h3>
 
555
<a name="id2652567"></a><h3>
510
556
<a name="gimp-image-flip"></a>gimp_image_flip ()</h3>
511
 
<a class="indexterm" name="id2610788"></a><pre class="programlisting">gboolean    gimp_image_flip                 (gint32 image_ID,
512
 
                                             <a href="libgimp-gimpenums.html#GimpOrientationType">GimpOrientationType</a> flip_type);</pre>
 
557
<a class="indexterm" name="id2652577"></a><pre class="programlisting">gboolean            gimp_image_flip                     (gint32 image_ID,
 
558
                                                         <a href="libgimp-gimpenums.html#GimpOrientationType">GimpOrientationType</a> flip_type);</pre>
513
559
<p>
514
560
Flips the image horizontally or vertically.
515
561
</p>
522
568
<col align="left" valign="top">
523
569
<tbody>
524
570
<tr>
525
 
<td>
526
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
571
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
527
572
<td> The image.
528
573
</td>
529
574
</tr>
530
575
<tr>
531
 
<td>
532
 
<span class="term"><em class="parameter"><code>flip_type</code></em>&#160;:</span></td>
 
576
<td><span class="term"><em class="parameter"><code>flip_type</code></em>&#160;:</span></td>
533
577
<td> Type of flip.
534
578
</td>
535
579
</tr>
536
580
<tr>
537
 
<td>
538
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
581
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
539
582
<td> TRUE on success.
540
583
</td>
541
584
</tr>
544
587
</div>
545
588
<hr>
546
589
<div class="refsect2" lang="en">
547
 
<a name="id2610875"></a><h3>
 
590
<a name="id2652655"></a><h3>
548
591
<a name="gimp-image-rotate"></a>gimp_image_rotate ()</h3>
549
 
<a class="indexterm" name="id2610888"></a><pre class="programlisting">gboolean    gimp_image_rotate               (gint32 image_ID,
550
 
                                             <a href="libgimp-gimpenums.html#GimpRotationType">GimpRotationType</a> rotate_type);</pre>
 
592
<a class="indexterm" name="id2652665"></a><pre class="programlisting">gboolean            gimp_image_rotate                   (gint32 image_ID,
 
593
                                                         <a href="libgimp-gimpenums.html#GimpRotationType">GimpRotationType</a> rotate_type);</pre>
551
594
<p>
552
595
Rotates the image by the specified degrees.
553
596
</p>
560
603
<col align="left" valign="top">
561
604
<tbody>
562
605
<tr>
563
 
<td>
564
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
606
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
565
607
<td> The image.
566
608
</td>
567
609
</tr>
568
610
<tr>
569
 
<td>
570
 
<span class="term"><em class="parameter"><code>rotate_type</code></em>&#160;:</span></td>
 
611
<td><span class="term"><em class="parameter"><code>rotate_type</code></em>&#160;:</span></td>
571
612
<td> Angle of rotation.
572
613
</td>
573
614
</tr>
574
615
<tr>
575
 
<td>
576
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
616
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
577
617
<td> TRUE on success.
578
618
</td>
579
619
</tr>
582
622
</div>
583
623
<hr>
584
624
<div class="refsect2" lang="en">
585
 
<a name="id2610974"></a><h3>
 
625
<a name="id2652743"></a><h3>
586
626
<a name="gimp-image-resize"></a>gimp_image_resize ()</h3>
587
 
<a class="indexterm" name="id2610986"></a><pre class="programlisting">gboolean    gimp_image_resize               (gint32 image_ID,
588
 
                                             gint new_width,
589
 
                                             gint new_height,
590
 
                                             gint offx,
591
 
                                             gint offy);</pre>
 
627
<a class="indexterm" name="id2652753"></a><pre class="programlisting">gboolean            gimp_image_resize                   (gint32 image_ID,
 
628
                                                         gint new_width,
 
629
                                                         gint new_height,
 
630
                                                         gint offx,
 
631
                                                         gint offy);</pre>
592
632
<p>
593
633
Resize the image to the specified extents.
594
634
</p>
608
648
<col align="left" valign="top">
609
649
<tbody>
610
650
<tr>
611
 
<td>
612
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
651
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
613
652
<td> The image.
614
653
</td>
615
654
</tr>
616
655
<tr>
617
 
<td>
618
 
<span class="term"><em class="parameter"><code>new_width</code></em>&#160;:</span></td>
 
656
<td><span class="term"><em class="parameter"><code>new_width</code></em>&#160;:</span></td>
619
657
<td> New image width.
620
658
</td>
621
659
</tr>
622
660
<tr>
623
 
<td>
624
 
<span class="term"><em class="parameter"><code>new_height</code></em>&#160;:</span></td>
 
661
<td><span class="term"><em class="parameter"><code>new_height</code></em>&#160;:</span></td>
625
662
<td> New image height.
626
663
</td>
627
664
</tr>
628
665
<tr>
629
 
<td>
630
 
<span class="term"><em class="parameter"><code>offx</code></em>&#160;:</span></td>
 
666
<td><span class="term"><em class="parameter"><code>offx</code></em>&#160;:</span></td>
631
667
<td> x offset between upper left corner of old and new images: (new - old).
632
668
</td>
633
669
</tr>
634
670
<tr>
635
 
<td>
636
 
<span class="term"><em class="parameter"><code>offy</code></em>&#160;:</span></td>
 
671
<td><span class="term"><em class="parameter"><code>offy</code></em>&#160;:</span></td>
637
672
<td> y offset between upper left corner of old and new images: (new - old).
638
673
</td>
639
674
</tr>
640
675
<tr>
641
 
<td>
642
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
676
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
643
677
<td> TRUE on success.
644
678
</td>
645
679
</tr>
648
682
</div>
649
683
<hr>
650
684
<div class="refsect2" lang="en">
651
 
<a name="id2611116"></a><h3>
 
685
<a name="id2652898"></a><h3>
652
686
<a name="gimp-image-resize-to-layers"></a>gimp_image_resize_to_layers ()</h3>
653
 
<a class="indexterm" name="id2611129"></a><pre class="programlisting">gboolean    gimp_image_resize_to_layers     (gint32 image_ID);</pre>
 
687
<a class="indexterm" name="id2652912"></a><pre class="programlisting">gboolean            gimp_image_resize_to_layers         (gint32 image_ID);</pre>
654
688
<p>
655
689
Resize the image to fit all layers.
656
690
</p>
666
700
<col align="left" valign="top">
667
701
<tbody>
668
702
<tr>
669
 
<td>
670
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
703
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
671
704
<td> The image.
672
705
</td>
673
706
</tr>
674
707
<tr>
675
 
<td>
676
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
708
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
677
709
<td> TRUE on success.
678
710
 
679
711
</td>
680
712
</tr>
681
713
</tbody>
682
714
</table></div>
683
 
<p>Since  GIMP 2.2
 
715
<p class="since">Since  GIMP 2.2
684
716
</p>
685
717
</div>
686
718
<hr>
687
719
<div class="refsect2" lang="en">
688
 
<a name="id2611195"></a><h3>
 
720
<a name="id2652979"></a><h3>
689
721
<a name="gimp-image-scale"></a>gimp_image_scale ()</h3>
690
 
<a class="indexterm" name="id2611205"></a><pre class="programlisting">gboolean    gimp_image_scale                (gint32 image_ID,
691
 
                                             gint new_width,
692
 
                                             gint new_height);</pre>
 
722
<a class="indexterm" name="id2652992"></a><pre class="programlisting">gboolean            gimp_image_scale                    (gint32 image_ID,
 
723
                                                         gint new_width,
 
724
                                                         gint new_height);</pre>
693
725
<p>
694
726
Scale the image to the specified extents.
695
727
</p>
709
741
<col align="left" valign="top">
710
742
<tbody>
711
743
<tr>
712
 
<td>
713
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
744
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
714
745
<td> The image.
715
746
</td>
716
747
</tr>
717
748
<tr>
718
 
<td>
719
 
<span class="term"><em class="parameter"><code>new_width</code></em>&#160;:</span></td>
 
749
<td><span class="term"><em class="parameter"><code>new_width</code></em>&#160;:</span></td>
720
750
<td> New image width.
721
751
</td>
722
752
</tr>
723
753
<tr>
724
 
<td>
725
 
<span class="term"><em class="parameter"><code>new_height</code></em>&#160;:</span></td>
 
754
<td><span class="term"><em class="parameter"><code>new_height</code></em>&#160;:</span></td>
726
755
<td> New image height.
727
756
</td>
728
757
</tr>
729
758
<tr>
730
 
<td>
731
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
759
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
732
760
<td> TRUE on success.
733
761
</td>
734
762
</tr>
737
765
</div>
738
766
<hr>
739
767
<div class="refsect2" lang="en">
740
 
<a name="id2611309"></a><h3>
 
768
<a name="id2653108"></a><h3>
741
769
<a name="gimp-image-crop"></a>gimp_image_crop ()</h3>
742
 
<a class="indexterm" name="id2611319"></a><pre class="programlisting">gboolean    gimp_image_crop                 (gint32 image_ID,
743
 
                                             gint new_width,
744
 
                                             gint new_height,
745
 
                                             gint offx,
746
 
                                             gint offy);</pre>
 
770
<a class="indexterm" name="id2653122"></a><pre class="programlisting">gboolean            gimp_image_crop                     (gint32 image_ID,
 
771
                                                         gint new_width,
 
772
                                                         gint new_height,
 
773
                                                         gint offx,
 
774
                                                         gint offy);</pre>
747
775
<p>
748
776
Crop the image to the specified extents.
749
777
</p>
761
789
<col align="left" valign="top">
762
790
<tbody>
763
791
<tr>
764
 
<td>
765
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
792
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
766
793
<td> The image.
767
794
</td>
768
795
</tr>
769
796
<tr>
770
 
<td>
771
 
<span class="term"><em class="parameter"><code>new_width</code></em>&#160;:</span></td>
 
797
<td><span class="term"><em class="parameter"><code>new_width</code></em>&#160;:</span></td>
772
798
<td> New image width: (0 &lt; new_width &lt;= width).
773
799
</td>
774
800
</tr>
775
801
<tr>
776
 
<td>
777
 
<span class="term"><em class="parameter"><code>new_height</code></em>&#160;:</span></td>
 
802
<td><span class="term"><em class="parameter"><code>new_height</code></em>&#160;:</span></td>
778
803
<td> New image height: (0 &lt; new_height &lt;= height).
779
804
</td>
780
805
</tr>
781
806
<tr>
782
 
<td>
783
 
<span class="term"><em class="parameter"><code>offx</code></em>&#160;:</span></td>
 
807
<td><span class="term"><em class="parameter"><code>offx</code></em>&#160;:</span></td>
784
808
<td> x offset: (0 &lt;= offx &lt;= (width - new_width)).
785
809
</td>
786
810
</tr>
787
811
<tr>
788
 
<td>
789
 
<span class="term"><em class="parameter"><code>offy</code></em>&#160;:</span></td>
 
812
<td><span class="term"><em class="parameter"><code>offy</code></em>&#160;:</span></td>
790
813
<td> y offset: (0 &lt;= offy &lt;= (height - new_height)).
791
814
</td>
792
815
</tr>
793
816
<tr>
794
 
<td>
795
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
817
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
796
818
<td> TRUE on success.
797
819
</td>
798
820
</tr>
801
823
</div>
802
824
<hr>
803
825
<div class="refsect2" lang="en">
804
 
<a name="id2611462"></a><h3>
 
826
<a name="id2653280"></a><h3>
805
827
<a name="gimp-image-get-layers"></a>gimp_image_get_layers ()</h3>
806
 
<a class="indexterm" name="id2611473"></a><pre class="programlisting">gint*       gimp_image_get_layers           (gint32 image_ID,
807
 
                                             gint *num_layers);</pre>
 
828
<a class="indexterm" name="id2653294"></a><pre class="programlisting">gint*               gimp_image_get_layers               (gint32 image_ID,
 
829
                                                         gint *num_layers);</pre>
808
830
<p>
809
831
Returns the list of layers contained in the specified image.
810
832
</p>
818
840
<col align="left" valign="top">
819
841
<tbody>
820
842
<tr>
821
 
<td>
822
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
843
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
823
844
<td> The image.
824
845
</td>
825
846
</tr>
826
847
<tr>
827
 
<td>
828
 
<span class="term"><em class="parameter"><code>num_layers</code></em>&#160;:</span></td>
 
848
<td><span class="term"><em class="parameter"><code>num_layers</code></em>&#160;:</span></td>
829
849
<td> The number of layers contained in the image.
830
850
</td>
831
851
</tr>
832
852
<tr>
833
 
<td>
834
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
853
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
835
854
<td> The list of layers contained in the image.
836
855
</td>
837
856
</tr>
840
859
</div>
841
860
<hr>
842
861
<div class="refsect2" lang="en">
843
 
<a name="id2611554"></a><h3>
 
862
<a name="id2653385"></a><h3>
844
863
<a name="gimp-image-get-channels"></a>gimp_image_get_channels ()</h3>
845
 
<a class="indexterm" name="id2611564"></a><pre class="programlisting">gint*       gimp_image_get_channels         (gint32 image_ID,
846
 
                                             gint *num_channels);</pre>
 
864
<a class="indexterm" name="id2653398"></a><pre class="programlisting">gint*               gimp_image_get_channels             (gint32 image_ID,
 
865
                                                         gint *num_channels);</pre>
847
866
<p>
848
867
Returns the list of channels contained in the specified image.
849
868
</p>
858
877
<col align="left" valign="top">
859
878
<tbody>
860
879
<tr>
861
 
<td>
862
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
880
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
863
881
<td> The image.
864
882
</td>
865
883
</tr>
866
884
<tr>
867
 
<td>
868
 
<span class="term"><em class="parameter"><code>num_channels</code></em>&#160;:</span></td>
 
885
<td><span class="term"><em class="parameter"><code>num_channels</code></em>&#160;:</span></td>
869
886
<td> The number of channels contained in the image.
870
887
</td>
871
888
</tr>
872
889
<tr>
873
 
<td>
874
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
890
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
875
891
<td> The list of channels contained in the image.
876
892
</td>
877
893
</tr>
880
896
</div>
881
897
<hr>
882
898
<div class="refsect2" lang="en">
883
 
<a name="id2611646"></a><h3>
 
899
<a name="id2653490"></a><h3>
884
900
<a name="gimp-image-get-active-drawable"></a>gimp_image_get_active_drawable ()</h3>
885
 
<a class="indexterm" name="id2611658"></a><pre class="programlisting">gint32      gimp_image_get_active_drawable  (gint32 image_ID);</pre>
 
901
<a class="indexterm" name="id2653504"></a><pre class="programlisting">gint32              gimp_image_get_active_drawable      (gint32 image_ID);</pre>
886
902
<p>
887
903
Get the image's active drawable
888
904
</p>
900
916
<col align="left" valign="top">
901
917
<tbody>
902
918
<tr>
903
 
<td>
904
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
919
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
905
920
<td> The image.
906
921
</td>
907
922
</tr>
908
923
<tr>
909
 
<td>
910
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
924
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
911
925
<td> The active drawable.
912
926
</td>
913
927
</tr>
916
930
</div>
917
931
<hr>
918
932
<div class="refsect2" lang="en">
919
 
<a name="id2611722"></a><h3>
920
 
<a name="gimp-image-unset-active-channel"></a>gimp_image_unset_active_channel ()</h3>
921
 
<a class="indexterm" name="id2611734"></a><pre class="programlisting">gboolean    gimp_image_unset_active_channel (gint32 image_ID);</pre>
922
 
<p>
923
 
Unsets the active channel in the specified image.
924
 
</p>
925
 
<p>
926
 
If an active channel exists, it is unset. There then exists no
927
 
active channel, and if desired, one can be set through a call to
928
 
'Set Active Channel'. No error is returned in the case of no
929
 
existing active channel.</p>
930
 
<p>
931
 
 
932
 
</p>
933
 
<div class="variablelist"><table border="0">
934
 
<col align="left" valign="top">
935
 
<tbody>
936
 
<tr>
937
 
<td>
938
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
939
 
<td> The image.
940
 
</td>
941
 
</tr>
942
 
<tr>
943
 
<td>
944
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
945
 
<td> TRUE on success.
946
 
</td>
947
 
</tr>
948
 
</tbody>
949
 
</table></div>
950
 
</div>
951
 
<hr>
952
 
<div class="refsect2" lang="en">
953
 
<a name="id2611796"></a><h3>
 
933
<a name="id2653575"></a><h3>
954
934
<a name="gimp-image-get-floating-sel"></a>gimp_image_get_floating_sel ()</h3>
955
 
<a class="indexterm" name="id2611807"></a><pre class="programlisting">gint32      gimp_image_get_floating_sel     (gint32 image_ID);</pre>
 
935
<a class="indexterm" name="id2653589"></a><pre class="programlisting">gint32              gimp_image_get_floating_sel         (gint32 image_ID);</pre>
956
936
<p>
957
937
Return the floating selection of the image.
958
938
</p>
966
946
<col align="left" valign="top">
967
947
<tbody>
968
948
<tr>
969
 
<td>
970
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
949
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
971
950
<td> The image.
972
951
</td>
973
952
</tr>
974
953
<tr>
975
 
<td>
976
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
954
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
977
955
<td> The image's floating selection.
978
956
</td>
979
957
</tr>
982
960
</div>
983
961
<hr>
984
962
<div class="refsect2" lang="en">
985
 
<a name="id2611867"></a><h3>
 
963
<a name="id2653656"></a><h3>
986
964
<a name="gimp-image-floating-sel-attached-to"></a>gimp_image_floating_sel_attached_to ()</h3>
987
 
<a class="indexterm" name="id2611881"></a><pre class="programlisting">gint32      gimp_image_floating_sel_attached_to
988
 
                                            (gint32 image_ID);</pre>
 
965
<a class="indexterm" name="id2653670"></a><pre class="programlisting">gint32              gimp_image_floating_sel_attached_to (gint32 image_ID);</pre>
989
966
<p>
990
967
Return the drawable the floating selection is attached to.
991
968
</p>
1000
977
<col align="left" valign="top">
1001
978
<tbody>
1002
979
<tr>
1003
 
<td>
1004
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
980
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1005
981
<td> The image.
1006
982
</td>
1007
983
</tr>
1008
984
<tr>
1009
 
<td>
1010
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
985
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1011
986
<td> The drawable the floating selection is attached to.
1012
987
</td>
1013
988
</tr>
1016
991
</div>
1017
992
<hr>
1018
993
<div class="refsect2" lang="en">
1019
 
<a name="id2611943"></a><h3>
 
994
<a name="id2653738"></a><h3>
1020
995
<a name="gimp-image-pick-color"></a>gimp_image_pick_color ()</h3>
1021
 
<a class="indexterm" name="id2611953"></a><pre class="programlisting">gboolean    gimp_image_pick_color           (gint32 image_ID,
1022
 
                                             gint32 drawable_ID,
1023
 
                                             gdouble x,
1024
 
                                             gdouble y,
1025
 
                                             gboolean sample_merged,
1026
 
                                             gboolean sample_average,
1027
 
                                             gdouble average_radius,
1028
 
                                             <a
 
996
<a class="indexterm" name="id2653752"></a><pre class="programlisting">gboolean            gimp_image_pick_color               (gint32 image_ID,
 
997
                                                         gint32 drawable_ID,
 
998
                                                         gdouble x,
 
999
                                                         gdouble y,
 
1000
                                                         gboolean sample_merged,
 
1001
                                                         gboolean sample_average,
 
1002
                                                         gdouble average_radius,
 
1003
                                                         <a
1029
1004
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
1030
1005
>GimpRGB</a> *color);</pre>
1031
1006
<p>
1039
1014
an alpha channel, the algorithm examines the alpha value of the
1040
1015
drawable at the coordinates. If the alpha value is completely
1041
1016
transparent (0), then an error is returned. If the sample_merged
1042
 
parameter is non-zero, the data of the composite image will be used
 
1017
parameter is TRUE, the data of the composite image will be used
1043
1018
instead of that for the specified drawable. This is equivalent to
1044
1019
sampling for colors after merging all visible layers. In the case of
1045
 
a merged sampling, the supplied drawable is ignored except for
1046
 
finding the image it belongs to.</p>
 
1020
a merged sampling, the supplied drawable is ignored.</p>
1047
1021
<p>
1048
1022
 
1049
1023
</p>
1051
1025
<col align="left" valign="top">
1052
1026
<tbody>
1053
1027
<tr>
1054
 
<td>
1055
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1028
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1056
1029
<td> The image.
1057
1030
</td>
1058
1031
</tr>
1059
1032
<tr>
1060
 
<td>
1061
 
<span class="term"><em class="parameter"><code>drawable_ID</code></em>&#160;:</span></td>
 
1033
<td><span class="term"><em class="parameter"><code>drawable_ID</code></em>&#160;:</span></td>
1062
1034
<td> The drawable to pick from.
1063
1035
</td>
1064
1036
</tr>
1065
1037
<tr>
1066
 
<td>
1067
 
<span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
 
1038
<td><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
1068
1039
<td> x coordinate of upper-left corner of rectangle.
1069
1040
</td>
1070
1041
</tr>
1071
1042
<tr>
1072
 
<td>
1073
 
<span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
 
1043
<td><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
1074
1044
<td> y coordinate of upper-left corner of rectangle.
1075
1045
</td>
1076
1046
</tr>
1077
1047
<tr>
1078
 
<td>
1079
 
<span class="term"><em class="parameter"><code>sample_merged</code></em>&#160;:</span></td>
 
1048
<td><span class="term"><em class="parameter"><code>sample_merged</code></em>&#160;:</span></td>
1080
1049
<td> Use the composite image, not the drawable.
1081
1050
</td>
1082
1051
</tr>
1083
1052
<tr>
1084
 
<td>
1085
 
<span class="term"><em class="parameter"><code>sample_average</code></em>&#160;:</span></td>
 
1053
<td><span class="term"><em class="parameter"><code>sample_average</code></em>&#160;:</span></td>
1086
1054
<td> Average the color of all the pixels in a specified radius.
1087
1055
</td>
1088
1056
</tr>
1089
1057
<tr>
1090
 
<td>
1091
 
<span class="term"><em class="parameter"><code>average_radius</code></em>&#160;:</span></td>
 
1058
<td><span class="term"><em class="parameter"><code>average_radius</code></em>&#160;:</span></td>
1092
1059
<td> The radius of pixels to average.
1093
1060
</td>
1094
1061
</tr>
1095
1062
<tr>
1096
 
<td>
1097
 
<span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></td>
 
1063
<td><span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></td>
1098
1064
<td> The return color.
1099
1065
</td>
1100
1066
</tr>
1101
1067
<tr>
1102
 
<td>
1103
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1068
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1104
1069
<td> TRUE on success.
1105
1070
</td>
1106
1071
</tr>
1109
1074
</div>
1110
1075
<hr>
1111
1076
<div class="refsect2" lang="en">
1112
 
<a name="id2612162"></a><h3>
 
1077
<a name="id2653982"></a><h3>
1113
1078
<a name="gimp-image-pick-correlate-layer"></a>gimp_image_pick_correlate_layer ()</h3>
1114
 
<a class="indexterm" name="id2612174"></a><pre class="programlisting">gint32      gimp_image_pick_correlate_layer (gint32 image_ID,
1115
 
                                             gint x,
1116
 
                                             gint y);</pre>
 
1079
<a class="indexterm" name="id2653996"></a><pre class="programlisting">gint32              gimp_image_pick_correlate_layer     (gint32 image_ID,
 
1080
                                                         gint x,
 
1081
                                                         gint y);</pre>
1117
1082
<p>
1118
1083
Find the layer visible at the specified coordinates.
1119
1084
</p>
1130
1095
<col align="left" valign="top">
1131
1096
<tbody>
1132
1097
<tr>
1133
 
<td>
1134
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1098
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1135
1099
<td> The image.
1136
1100
</td>
1137
1101
</tr>
1138
1102
<tr>
1139
 
<td>
1140
 
<span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
 
1103
<td><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
1141
1104
<td> The x coordinate for the pick.
1142
1105
</td>
1143
1106
</tr>
1144
1107
<tr>
1145
 
<td>
1146
 
<span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
 
1108
<td><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
1147
1109
<td> The y coordinate for the pick.
1148
1110
</td>
1149
1111
</tr>
1150
1112
<tr>
1151
 
<td>
1152
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1113
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1153
1114
<td> The layer found at the specified coordinates.
1154
1115
</td>
1155
1116
</tr>
1158
1119
</div>
1159
1120
<hr>
1160
1121
<div class="refsect2" lang="en">
1161
 
<a name="id2612277"></a><h3>
 
1122
<a name="id2654110"></a><h3>
1162
1123
<a name="gimp-image-add-layer"></a>gimp_image_add_layer ()</h3>
1163
 
<a class="indexterm" name="id2612287"></a><pre class="programlisting">gboolean    gimp_image_add_layer            (gint32 image_ID,
1164
 
                                             gint32 layer_ID,
1165
 
                                             gint position);</pre>
 
1124
<a class="indexterm" name="id2654124"></a><pre class="programlisting">gboolean            gimp_image_add_layer                (gint32 image_ID,
 
1125
                                                         gint32 layer_ID,
 
1126
                                                         gint position);</pre>
1166
1127
<p>
1167
1128
Add the specified layer to the image.
1168
1129
</p>
1169
1130
<p>
1170
 
This procedure adds the specified layer to the gimage at the given
 
1131
This procedure adds the specified layer to the image at the given
1171
1132
position. If the position is specified as -1, then the layer is
1172
 
inserted at the top of the layer stack. If the layer to be added has
1173
 
no alpha channel, it must be added at position 0. The layer type
1174
 
must be compatible with the image base type.</p>
 
1133
inserted above the active layer. The layer type must be compatible
 
1134
with the image base type.</p>
1175
1135
<p>
1176
1136
 
1177
1137
</p>
1179
1139
<col align="left" valign="top">
1180
1140
<tbody>
1181
1141
<tr>
1182
 
<td>
1183
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1142
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1184
1143
<td> The image.
1185
1144
</td>
1186
1145
</tr>
1187
1146
<tr>
1188
 
<td>
1189
 
<span class="term"><em class="parameter"><code>layer_ID</code></em>&#160;:</span></td>
 
1147
<td><span class="term"><em class="parameter"><code>layer_ID</code></em>&#160;:</span></td>
1190
1148
<td> The layer.
1191
1149
</td>
1192
1150
</tr>
1193
1151
<tr>
1194
 
<td>
1195
 
<span class="term"><em class="parameter"><code>position</code></em>&#160;:</span></td>
 
1152
<td><span class="term"><em class="parameter"><code>position</code></em>&#160;:</span></td>
1196
1153
<td> The layer position.
1197
1154
</td>
1198
1155
</tr>
1199
1156
<tr>
1200
 
<td>
1201
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1157
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1202
1158
<td> TRUE on success.
1203
1159
</td>
1204
1160
</tr>
1207
1163
</div>
1208
1164
<hr>
1209
1165
<div class="refsect2" lang="en">
1210
 
<a name="id2612388"></a><h3>
 
1166
<a name="id2654236"></a><h3>
1211
1167
<a name="gimp-image-remove-layer"></a>gimp_image_remove_layer ()</h3>
1212
 
<a class="indexterm" name="id2612398"></a><pre class="programlisting">gboolean    gimp_image_remove_layer         (gint32 image_ID,
1213
 
                                             gint32 layer_ID);</pre>
 
1168
<a class="indexterm" name="id2654249"></a><pre class="programlisting">gboolean            gimp_image_remove_layer             (gint32 image_ID,
 
1169
                                                         gint32 layer_ID);</pre>
1214
1170
<p>
1215
1171
Remove the specified layer from the image.
1216
1172
</p>
1227
1183
<col align="left" valign="top">
1228
1184
<tbody>
1229
1185
<tr>
1230
 
<td>
1231
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1186
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1232
1187
<td> The image.
1233
1188
</td>
1234
1189
</tr>
1235
1190
<tr>
1236
 
<td>
1237
 
<span class="term"><em class="parameter"><code>layer_ID</code></em>&#160;:</span></td>
 
1191
<td><span class="term"><em class="parameter"><code>layer_ID</code></em>&#160;:</span></td>
1238
1192
<td> The layer.
1239
1193
</td>
1240
1194
</tr>
1241
1195
<tr>
1242
 
<td>
1243
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1196
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1244
1197
<td> TRUE on success.
1245
1198
</td>
1246
1199
</tr>
1249
1202
</div>
1250
1203
<hr>
1251
1204
<div class="refsect2" lang="en">
1252
 
<a name="id2612479"></a><h3>
 
1205
<a name="id2654340"></a><h3>
1253
1206
<a name="gimp-image-raise-layer"></a>gimp_image_raise_layer ()</h3>
1254
 
<a class="indexterm" name="id2612490"></a><pre class="programlisting">gboolean    gimp_image_raise_layer          (gint32 image_ID,
1255
 
                                             gint32 layer_ID);</pre>
 
1207
<a class="indexterm" name="id2654354"></a><pre class="programlisting">gboolean            gimp_image_raise_layer              (gint32 image_ID,
 
1208
                                                         gint32 layer_ID);</pre>
1256
1209
<p>
1257
1210
Raise the specified layer in the image's layer stack
1258
1211
</p>
1259
1212
<p>
1260
1213
This procedure raises the specified layer one step in the existing
1261
1214
layer stack. It will not move the layer if there is no layer above
1262
 
it, or the layer has no alpha channel.</p>
 
1215
it.</p>
1263
1216
<p>
1264
1217
 
1265
1218
</p>
1267
1220
<col align="left" valign="top">
1268
1221
<tbody>
1269
1222
<tr>
1270
 
<td>
1271
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1223
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1272
1224
<td> The image.
1273
1225
</td>
1274
1226
</tr>
1275
1227
<tr>
1276
 
<td>
1277
 
<span class="term"><em class="parameter"><code>layer_ID</code></em>&#160;:</span></td>
 
1228
<td><span class="term"><em class="parameter"><code>layer_ID</code></em>&#160;:</span></td>
1278
1229
<td> The layer to raise.
1279
1230
</td>
1280
1231
</tr>
1281
1232
<tr>
1282
 
<td>
1283
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1233
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1284
1234
<td> TRUE on success.
1285
1235
</td>
1286
1236
</tr>
1289
1239
</div>
1290
1240
<hr>
1291
1241
<div class="refsect2" lang="en">
1292
 
<a name="id2612569"></a><h3>
 
1242
<a name="id2654443"></a><h3>
1293
1243
<a name="gimp-image-lower-layer"></a>gimp_image_lower_layer ()</h3>
1294
 
<a class="indexterm" name="id2612580"></a><pre class="programlisting">gboolean    gimp_image_lower_layer          (gint32 image_ID,
1295
 
                                             gint32 layer_ID);</pre>
 
1244
<a class="indexterm" name="id2654457"></a><pre class="programlisting">gboolean            gimp_image_lower_layer              (gint32 image_ID,
 
1245
                                                         gint32 layer_ID);</pre>
1296
1246
<p>
1297
1247
Lower the specified layer in the image's layer stack
1298
1248
</p>
1299
1249
<p>
1300
1250
This procedure lowers the specified layer one step in the existing
1301
1251
layer stack. It will not move the layer if there is no layer below
1302
 
it, or the layer has no alpha channel.</p>
 
1252
it.</p>
1303
1253
<p>
1304
1254
 
1305
1255
</p>
1307
1257
<col align="left" valign="top">
1308
1258
<tbody>
1309
1259
<tr>
1310
 
<td>
1311
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1260
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1312
1261
<td> The image.
1313
1262
</td>
1314
1263
</tr>
1315
1264
<tr>
1316
 
<td>
1317
 
<span class="term"><em class="parameter"><code>layer_ID</code></em>&#160;:</span></td>
 
1265
<td><span class="term"><em class="parameter"><code>layer_ID</code></em>&#160;:</span></td>
1318
1266
<td> The layer to lower.
1319
1267
</td>
1320
1268
</tr>
1321
1269
<tr>
1322
 
<td>
1323
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1270
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1324
1271
<td> TRUE on success.
1325
1272
</td>
1326
1273
</tr>
1329
1276
</div>
1330
1277
<hr>
1331
1278
<div class="refsect2" lang="en">
1332
 
<a name="id2612659"></a><h3>
 
1279
<a name="id2654546"></a><h3>
1333
1280
<a name="gimp-image-raise-layer-to-top"></a>gimp_image_raise_layer_to_top ()</h3>
1334
 
<a class="indexterm" name="id2612672"></a><pre class="programlisting">gboolean    gimp_image_raise_layer_to_top   (gint32 image_ID,
1335
 
                                             gint32 layer_ID);</pre>
 
1281
<a class="indexterm" name="id2654561"></a><pre class="programlisting">gboolean            gimp_image_raise_layer_to_top       (gint32 image_ID,
 
1282
                                                         gint32 layer_ID);</pre>
1336
1283
<p>
1337
1284
Raise the specified layer in the image's layer stack to top of stack
1338
1285
</p>
1339
1286
<p>
1340
1287
This procedure raises the specified layer to top of the existing
1341
1288
layer stack. It will not move the layer if there is no layer above
1342
 
it, or the layer has no alpha channel.</p>
 
1289
it.</p>
1343
1290
<p>
1344
1291
 
1345
1292
</p>
1347
1294
<col align="left" valign="top">
1348
1295
<tbody>
1349
1296
<tr>
1350
 
<td>
1351
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1297
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1352
1298
<td> The image.
1353
1299
</td>
1354
1300
</tr>
1355
1301
<tr>
1356
 
<td>
1357
 
<span class="term"><em class="parameter"><code>layer_ID</code></em>&#160;:</span></td>
 
1302
<td><span class="term"><em class="parameter"><code>layer_ID</code></em>&#160;:</span></td>
1358
1303
<td> The layer to raise to top.
1359
1304
</td>
1360
1305
</tr>
1361
1306
<tr>
1362
 
<td>
1363
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1307
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1364
1308
<td> TRUE on success.
1365
1309
</td>
1366
1310
</tr>
1369
1313
</div>
1370
1314
<hr>
1371
1315
<div class="refsect2" lang="en">
1372
 
<a name="id2612753"></a><h3>
 
1316
<a name="id2654650"></a><h3>
1373
1317
<a name="gimp-image-lower-layer-to-bottom"></a>gimp_image_lower_layer_to_bottom ()</h3>
1374
 
<a class="indexterm" name="id2612765"></a><pre class="programlisting">gboolean    gimp_image_lower_layer_to_bottom
1375
 
                                            (gint32 image_ID,
1376
 
                                             gint32 layer_ID);</pre>
 
1318
<a class="indexterm" name="id2654664"></a><pre class="programlisting">gboolean            gimp_image_lower_layer_to_bottom    (gint32 image_ID,
 
1319
                                                         gint32 layer_ID);</pre>
1377
1320
<p>
1378
1321
Lower the specified layer in the image's layer stack to bottom of
1379
1322
stack
1381
1324
<p>
1382
1325
This procedure lowers the specified layer to bottom of the existing
1383
1326
layer stack. It will not move the layer if there is no layer below
1384
 
it, or the layer has no alpha channel.</p>
 
1327
it.</p>
1385
1328
<p>
1386
1329
 
1387
1330
</p>
1389
1332
<col align="left" valign="top">
1390
1333
<tbody>
1391
1334
<tr>
1392
 
<td>
1393
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1335
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1394
1336
<td> The image.
1395
1337
</td>
1396
1338
</tr>
1397
1339
<tr>
1398
 
<td>
1399
 
<span class="term"><em class="parameter"><code>layer_ID</code></em>&#160;:</span></td>
 
1340
<td><span class="term"><em class="parameter"><code>layer_ID</code></em>&#160;:</span></td>
1400
1341
<td> The layer to lower to bottom.
1401
1342
</td>
1402
1343
</tr>
1403
1344
<tr>
1404
 
<td>
1405
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1345
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1406
1346
<td> TRUE on success.
1407
1347
</td>
1408
1348
</tr>
1411
1351
</div>
1412
1352
<hr>
1413
1353
<div class="refsect2" lang="en">
1414
 
<a name="id2612847"></a><h3>
 
1354
<a name="id2654754"></a><h3>
 
1355
<a name="gimp-image-get-layer-position"></a>gimp_image_get_layer_position ()</h3>
 
1356
<a class="indexterm" name="id2654771"></a><pre class="programlisting">gint                gimp_image_get_layer_position       (gint32 image_ID,
 
1357
                                                         gint32 layer_ID);</pre>
 
1358
<p>
 
1359
Returns the position of the layer in the layer stack.
 
1360
</p>
 
1361
<p>
 
1362
This procedure determines the positioin of the specified layer in
 
1363
the images layer stack. If the layer doesn't exist in the image, an
 
1364
error is returned.</p>
 
1365
<p>
 
1366
 
 
1367
</p>
 
1368
<div class="variablelist"><table border="0">
 
1369
<col align="left" valign="top">
 
1370
<tbody>
 
1371
<tr>
 
1372
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1373
<td> The image.
 
1374
</td>
 
1375
</tr>
 
1376
<tr>
 
1377
<td><span class="term"><em class="parameter"><code>layer_ID</code></em>&#160;:</span></td>
 
1378
<td> The layer.
 
1379
</td>
 
1380
</tr>
 
1381
<tr>
 
1382
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1383
<td> The position of the layer in the layer stack.
 
1384
 
 
1385
</td>
 
1386
</tr>
 
1387
</tbody>
 
1388
</table></div>
 
1389
<p class="since">Since  GIMP 2.4
 
1390
</p>
 
1391
</div>
 
1392
<hr>
 
1393
<div class="refsect2" lang="en">
 
1394
<a name="id2654868"></a><h3>
1415
1395
<a name="gimp-image-add-channel"></a>gimp_image_add_channel ()</h3>
1416
 
<a class="indexterm" name="id2612858"></a><pre class="programlisting">gboolean    gimp_image_add_channel          (gint32 image_ID,
1417
 
                                             gint32 channel_ID,
1418
 
                                             gint position);</pre>
 
1396
<a class="indexterm" name="id2654882"></a><pre class="programlisting">gboolean            gimp_image_add_channel              (gint32 image_ID,
 
1397
                                                         gint32 channel_ID,
 
1398
                                                         gint position);</pre>
1419
1399
<p>
1420
1400
Add the specified channel to the image.
1421
1401
</p>
1430
1410
<col align="left" valign="top">
1431
1411
<tbody>
1432
1412
<tr>
1433
 
<td>
1434
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1413
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1435
1414
<td> The image.
1436
1415
</td>
1437
1416
</tr>
1438
1417
<tr>
1439
 
<td>
1440
 
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
 
1418
<td><span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
1441
1419
<td> The channel.
1442
1420
</td>
1443
1421
</tr>
1444
1422
<tr>
1445
 
<td>
1446
 
<span class="term"><em class="parameter"><code>position</code></em>&#160;:</span></td>
 
1423
<td><span class="term"><em class="parameter"><code>position</code></em>&#160;:</span></td>
1447
1424
<td> The channel position.
1448
1425
</td>
1449
1426
</tr>
1450
1427
<tr>
1451
 
<td>
1452
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1428
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1453
1429
<td> TRUE on success.
1454
1430
</td>
1455
1431
</tr>
1458
1434
</div>
1459
1435
<hr>
1460
1436
<div class="refsect2" lang="en">
1461
 
<a name="id2612956"></a><h3>
 
1437
<a name="id2654992"></a><h3>
1462
1438
<a name="gimp-image-remove-channel"></a>gimp_image_remove_channel ()</h3>
1463
 
<a class="indexterm" name="id2612967"></a><pre class="programlisting">gboolean    gimp_image_remove_channel       (gint32 image_ID,
1464
 
                                             gint32 channel_ID);</pre>
 
1439
<a class="indexterm" name="id2655007"></a><pre class="programlisting">gboolean            gimp_image_remove_channel           (gint32 image_ID,
 
1440
                                                         gint32 channel_ID);</pre>
1465
1441
<p>
1466
1442
Remove the specified channel from the image.
1467
1443
</p>
1475
1451
<col align="left" valign="top">
1476
1452
<tbody>
1477
1453
<tr>
1478
 
<td>
1479
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1454
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1480
1455
<td> The image.
1481
1456
</td>
1482
1457
</tr>
1483
1458
<tr>
1484
 
<td>
1485
 
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
 
1459
<td><span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
1486
1460
<td> The channel.
1487
1461
</td>
1488
1462
</tr>
1489
1463
<tr>
1490
 
<td>
1491
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1464
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1492
1465
<td> TRUE on success.
1493
1466
</td>
1494
1467
</tr>
1497
1470
</div>
1498
1471
<hr>
1499
1472
<div class="refsect2" lang="en">
1500
 
<a name="id2613045"></a><h3>
 
1473
<a name="id2655095"></a><h3>
1501
1474
<a name="gimp-image-raise-channel"></a>gimp_image_raise_channel ()</h3>
1502
 
<a class="indexterm" name="id2613056"></a><pre class="programlisting">gboolean    gimp_image_raise_channel        (gint32 image_ID,
1503
 
                                             gint32 channel_ID);</pre>
 
1475
<a class="indexterm" name="id2655109"></a><pre class="programlisting">gboolean            gimp_image_raise_channel            (gint32 image_ID,
 
1476
                                                         gint32 channel_ID);</pre>
1504
1477
<p>
1505
1478
Raise the specified channel in the image's channel stack
1506
1479
</p>
1515
1488
<col align="left" valign="top">
1516
1489
<tbody>
1517
1490
<tr>
1518
 
<td>
1519
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1491
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1520
1492
<td> The image.
1521
1493
</td>
1522
1494
</tr>
1523
1495
<tr>
1524
 
<td>
1525
 
<span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
 
1496
<td><span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
1526
1497
<td> The channel to raise.
1527
1498
</td>
1528
1499
</tr>
1529
1500
<tr>
1530
 
<td>
1531
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1501
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1532
1502
<td> TRUE on success.
1533
1503
</td>
1534
1504
</tr>
1537
1507
</div>
1538
1508
<hr>
1539
1509
<div class="refsect2" lang="en">
1540
 
<a name="id2613135"></a><h3>
 
1510
<a name="id2655198"></a><h3>
1541
1511
<a name="gimp-image-lower-channel"></a>gimp_image_lower_channel ()</h3>
1542
 
<a class="indexterm" name="id2613145"></a><pre class="programlisting">gboolean    gimp_image_lower_channel        (gint32 image_ID,
1543
 
                                             gint32 layer_ID);</pre>
 
1512
<a class="indexterm" name="id2655212"></a><pre class="programlisting">gboolean            gimp_image_lower_channel            (gint32 image_ID,
 
1513
                                                         gint32 channel_ID);</pre>
1544
1514
<p>
1545
 
Lower the specified layer in the image's layer stack
 
1515
Lower the specified channel in the image's channel stack
1546
1516
</p>
1547
1517
<p>
1548
 
This procedure lowers the specified layer one step in the existing
1549
 
layer stack. It will not move the layer if there is no layer below
1550
 
it, or the layer has no alpha channel.</p>
 
1518
This procedure lowers the specified channel one step in the existing
 
1519
channel stack. It will not move the channel if there is no channel
 
1520
below it.</p>
1551
1521
<p>
1552
1522
 
1553
1523
</p>
1555
1525
<col align="left" valign="top">
1556
1526
<tbody>
1557
1527
<tr>
1558
 
<td>
1559
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1528
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1560
1529
<td> The image.
1561
1530
</td>
1562
1531
</tr>
1563
1532
<tr>
1564
 
<td>
1565
 
<span class="term"><em class="parameter"><code>layer_ID</code></em>&#160;:</span></td>
1566
 
<td> The layer to lower.
 
1533
<td><span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
 
1534
<td> The channel to lower.
1567
1535
</td>
1568
1536
</tr>
1569
1537
<tr>
1570
 
<td>
1571
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1538
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1572
1539
<td> TRUE on success.
1573
1540
</td>
1574
1541
</tr>
1577
1544
</div>
1578
1545
<hr>
1579
1546
<div class="refsect2" lang="en">
1580
 
<a name="id2613225"></a><h3>
 
1547
<a name="id2655301"></a><h3>
 
1548
<a name="gimp-image-get-channel-position"></a>gimp_image_get_channel_position ()</h3>
 
1549
<a class="indexterm" name="id2655318"></a><pre class="programlisting">gint                gimp_image_get_channel_position     (gint32 image_ID,
 
1550
                                                         gint32 channel_ID);</pre>
 
1551
<p>
 
1552
Returns the position of the channel in the channel stack.
 
1553
</p>
 
1554
<p>
 
1555
This procedure determines the positioin of the specified channel in
 
1556
the images channel stack. If the channel doesn't exist in the image,
 
1557
an error is returned.</p>
 
1558
<p>
 
1559
 
 
1560
</p>
 
1561
<div class="variablelist"><table border="0">
 
1562
<col align="left" valign="top">
 
1563
<tbody>
 
1564
<tr>
 
1565
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1566
<td> The image.
 
1567
</td>
 
1568
</tr>
 
1569
<tr>
 
1570
<td><span class="term"><em class="parameter"><code>channel_ID</code></em>&#160;:</span></td>
 
1571
<td> The channel.
 
1572
</td>
 
1573
</tr>
 
1574
<tr>
 
1575
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1576
<td> The position of the channel in the channel stack.
 
1577
 
 
1578
</td>
 
1579
</tr>
 
1580
</tbody>
 
1581
</table></div>
 
1582
<p class="since">Since  GIMP 2.4
 
1583
</p>
 
1584
</div>
 
1585
<hr>
 
1586
<div class="refsect2" lang="en">
 
1587
<a name="id2655416"></a><h3>
1581
1588
<a name="gimp-image-flatten"></a>gimp_image_flatten ()</h3>
1582
 
<a class="indexterm" name="id2613235"></a><pre class="programlisting">gint32      gimp_image_flatten              (gint32 image_ID);</pre>
 
1589
<a class="indexterm" name="id2655430"></a><pre class="programlisting">gint32              gimp_image_flatten                  (gint32 image_ID);</pre>
1583
1590
<p>
1584
1591
Flatten all visible layers into a single layer. Discard all
1585
1592
invisible layers.
1595
1602
<col align="left" valign="top">
1596
1603
<tbody>
1597
1604
<tr>
1598
 
<td>
1599
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1605
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1600
1606
<td> The image.
1601
1607
</td>
1602
1608
</tr>
1603
1609
<tr>
1604
 
<td>
1605
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1610
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1606
1611
<td> The resulting layer.
1607
1612
</td>
1608
1613
</tr>
1611
1616
</div>
1612
1617
<hr>
1613
1618
<div class="refsect2" lang="en">
1614
 
<a name="id2613296"></a><h3>
 
1619
<a name="id2655498"></a><h3>
1615
1620
<a name="gimp-image-merge-visible-layers"></a>gimp_image_merge_visible_layers ()</h3>
1616
 
<a class="indexterm" name="id2613309"></a><pre class="programlisting">gint32      gimp_image_merge_visible_layers (gint32 image_ID,
1617
 
                                             <a href="libgimp-gimpenums.html#GimpMergeType">GimpMergeType</a> merge_type);</pre>
 
1621
<a class="indexterm" name="id2655512"></a><pre class="programlisting">gint32              gimp_image_merge_visible_layers     (gint32 image_ID,
 
1622
                                                         <a href="libgimp-gimpenums.html#GimpMergeType">GimpMergeType</a> merge_type);</pre>
1618
1623
<p>
1619
1624
Merge the visible image layers into one.
1620
1625
</p>
1632
1637
<col align="left" valign="top">
1633
1638
<tbody>
1634
1639
<tr>
1635
 
<td>
1636
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1640
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1637
1641
<td> The image.
1638
1642
</td>
1639
1643
</tr>
1640
1644
<tr>
1641
 
<td>
1642
 
<span class="term"><em class="parameter"><code>merge_type</code></em>&#160;:</span></td>
 
1645
<td><span class="term"><em class="parameter"><code>merge_type</code></em>&#160;:</span></td>
1643
1646
<td> The type of merge.
1644
1647
</td>
1645
1648
</tr>
1646
1649
<tr>
1647
 
<td>
1648
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1650
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1649
1651
<td> The resulting layer.
1650
1652
</td>
1651
1653
</tr>
1654
1656
</div>
1655
1657
<hr>
1656
1658
<div class="refsect2" lang="en">
1657
 
<a name="id2613392"></a><h3>
 
1659
<a name="id2655606"></a><h3>
1658
1660
<a name="gimp-image-merge-down"></a>gimp_image_merge_down ()</h3>
1659
 
<a class="indexterm" name="id2613406"></a><pre class="programlisting">gint32      gimp_image_merge_down           (gint32 image_ID,
1660
 
                                             gint32 merge_layer_ID,
1661
 
                                             <a href="libgimp-gimpenums.html#GimpMergeType">GimpMergeType</a> merge_type);</pre>
 
1661
<a class="indexterm" name="id2655620"></a><pre class="programlisting">gint32              gimp_image_merge_down               (gint32 image_ID,
 
1662
                                                         gint32 merge_layer_ID,
 
1663
                                                         <a href="libgimp-gimpenums.html#GimpMergeType">GimpMergeType</a> merge_type);</pre>
1662
1664
<p>
1663
1665
Merge the layer passed and the first visible layer below.
1664
1666
</p>
1677
1679
<col align="left" valign="top">
1678
1680
<tbody>
1679
1681
<tr>
1680
 
<td>
1681
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1682
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1682
1683
<td> The image.
1683
1684
</td>
1684
1685
</tr>
1685
1686
<tr>
1686
 
<td>
1687
 
<span class="term"><em class="parameter"><code>merge_layer_ID</code></em>&#160;:</span></td>
 
1687
<td><span class="term"><em class="parameter"><code>merge_layer_ID</code></em>&#160;:</span></td>
1688
1688
<td> The layer to merge down from.
1689
1689
</td>
1690
1690
</tr>
1691
1691
<tr>
1692
 
<td>
1693
 
<span class="term"><em class="parameter"><code>merge_type</code></em>&#160;:</span></td>
 
1692
<td><span class="term"><em class="parameter"><code>merge_type</code></em>&#160;:</span></td>
1694
1693
<td> The type of merge.
1695
1694
</td>
1696
1695
</tr>
1697
1696
<tr>
1698
 
<td>
1699
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1697
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1700
1698
<td> The resulting layer.
1701
1699
</td>
1702
1700
</tr>
1705
1703
</div>
1706
1704
<hr>
1707
1705
<div class="refsect2" lang="en">
1708
 
<a name="id2613521"></a><h3>
 
1706
<a name="id2655735"></a><h3>
1709
1707
<a name="gimp-image-clean-all"></a>gimp_image_clean_all ()</h3>
1710
 
<a class="indexterm" name="id2613535"></a><pre class="programlisting">gboolean    gimp_image_clean_all            (gint32 image_ID);</pre>
 
1708
<a class="indexterm" name="id2655749"></a><pre class="programlisting">gboolean            gimp_image_clean_all                (gint32 image_ID);</pre>
1711
1709
<p>
1712
1710
Set the image dirty count to 0.
1713
1711
</p>
1716
1714
operations to occur without having a 'dirtied' image. This is
1717
1715
especially useful for creating and loading images which should not
1718
1716
initially be considered dirty, even though layers must be created,
1719
 
filled, and installed in the image.</p>
 
1717
filled, and installed in the image. Note that save plug-ins must NOT
 
1718
call this function themselves after saving the image.</p>
1720
1719
<p>
1721
1720
 
1722
1721
</p>
1724
1723
<col align="left" valign="top">
1725
1724
<tbody>
1726
1725
<tr>
1727
 
<td>
1728
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1726
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1729
1727
<td> The image.
1730
1728
</td>
1731
1729
</tr>
1732
1730
<tr>
1733
 
<td>
1734
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1731
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1735
1732
<td> TRUE on success.
1736
1733
</td>
1737
1734
</tr>
1740
1737
</div>
1741
1738
<hr>
1742
1739
<div class="refsect2" lang="en">
1743
 
<a name="id2613604"></a><h3>
 
1740
<a name="id2655821"></a><h3>
1744
1741
<a name="gimp-image-is-dirty"></a>gimp_image_is_dirty ()</h3>
1745
 
<a class="indexterm" name="id2613618"></a><pre class="programlisting">gboolean    gimp_image_is_dirty             (gint32 image_ID);</pre>
 
1742
<a class="indexterm" name="id2655834"></a><pre class="programlisting">gboolean            gimp_image_is_dirty                 (gint32 image_ID);</pre>
1746
1743
<p>
1747
1744
Checks if the image has unsaved changes.
1748
1745
</p>
1749
1746
<p>
1750
1747
This procedure checks the specified image's dirty count to see if it
1751
 
needs to be saved.</p>
 
1748
needs to be saved. Note that saving the image does not automatically
 
1749
set the dirty count to 0, you need to call <a href="libgimp-gimpimage.html#gimp-image-clean-all"><code class="function">gimp_image_clean_all()</code></a>
 
1750
after calling a save procedure to make the image clean.</p>
1752
1751
<p>
1753
1752
 
1754
1753
</p>
1756
1755
<col align="left" valign="top">
1757
1756
<tbody>
1758
1757
<tr>
1759
 
<td>
1760
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1758
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1761
1759
<td> The image.
1762
1760
</td>
1763
1761
</tr>
1764
1762
<tr>
1765
 
<td>
1766
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1767
 
<td> True if the image has unsaved changes.
 
1763
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1764
<td> TRUE if the image has unsaved changes.
1768
1765
</td>
1769
1766
</tr>
1770
1767
</tbody>
1772
1769
</div>
1773
1770
<hr>
1774
1771
<div class="refsect2" lang="en">
1775
 
<a name="id2613684"></a><h3>
 
1772
<a name="id2655913"></a><h3>
1776
1773
<a name="gimp-image-get-active-layer"></a>gimp_image_get_active_layer ()</h3>
1777
 
<a class="indexterm" name="id2613698"></a><pre class="programlisting">gint32      gimp_image_get_active_layer     (gint32 image_ID);</pre>
 
1774
<a class="indexterm" name="id2655927"></a><pre class="programlisting">gint32              gimp_image_get_active_layer         (gint32 image_ID);</pre>
1778
1775
<p>
1779
1776
Returns the specified image's active layer.
1780
1777
</p>
1789
1786
<col align="left" valign="top">
1790
1787
<tbody>
1791
1788
<tr>
1792
 
<td>
1793
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1789
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1794
1790
<td> The image.
1795
1791
</td>
1796
1792
</tr>
1797
1793
<tr>
1798
 
<td>
1799
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1794
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1800
1795
<td> The active layer.
1801
1796
</td>
1802
1797
</tr>
1805
1800
</div>
1806
1801
<hr>
1807
1802
<div class="refsect2" lang="en">
1808
 
<a name="id2613766"></a><h3>
 
1803
<a name="id2655995"></a><h3>
1809
1804
<a name="gimp-image-set-active-layer"></a>gimp_image_set_active_layer ()</h3>
1810
 
<a class="indexterm" name="id2613781"></a><pre class="programlisting">gboolean    gimp_image_set_active_layer     (gint32 image_ID,
1811
 
                                             gint32 active_layer_ID);</pre>
 
1805
<a class="indexterm" name="id2656010"></a><pre class="programlisting">gboolean            gimp_image_set_active_layer         (gint32 image_ID,
 
1806
                                                         gint32 active_layer_ID);</pre>
1812
1807
<p>
1813
1808
Sets the specified image's active layer.
1814
1809
</p>
1824
1819
<col align="left" valign="top">
1825
1820
<tbody>
1826
1821
<tr>
1827
 
<td>
1828
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1822
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1829
1823
<td> The image.
1830
1824
</td>
1831
1825
</tr>
1832
1826
<tr>
1833
 
<td>
1834
 
<span class="term"><em class="parameter"><code>active_layer_ID</code></em>&#160;:</span></td>
 
1827
<td><span class="term"><em class="parameter"><code>active_layer_ID</code></em>&#160;:</span></td>
1835
1828
<td> The new image active layer.
1836
1829
</td>
1837
1830
</tr>
1838
1831
<tr>
1839
 
<td>
1840
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1832
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1841
1833
<td> TRUE on success.
1842
1834
</td>
1843
1835
</tr>
1846
1838
</div>
1847
1839
<hr>
1848
1840
<div class="refsect2" lang="en">
1849
 
<a name="id2613871"></a><h3>
 
1841
<a name="id2656100"></a><h3>
1850
1842
<a name="gimp-image-get-active-channel"></a>gimp_image_get_active_channel ()</h3>
1851
 
<a class="indexterm" name="id2613884"></a><pre class="programlisting">gint32      gimp_image_get_active_channel   (gint32 image_ID);</pre>
 
1843
<a class="indexterm" name="id2656114"></a><pre class="programlisting">gint32              gimp_image_get_active_channel       (gint32 image_ID);</pre>
1852
1844
<p>
1853
1845
Returns the specified image's active channel.
1854
1846
</p>
1862
1854
<col align="left" valign="top">
1863
1855
<tbody>
1864
1856
<tr>
1865
 
<td>
1866
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1857
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1867
1858
<td> The image.
1868
1859
</td>
1869
1860
</tr>
1870
1861
<tr>
1871
 
<td>
1872
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1862
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1873
1863
<td> The active channel.
1874
1864
</td>
1875
1865
</tr>
1878
1868
</div>
1879
1869
<hr>
1880
1870
<div class="refsect2" lang="en">
1881
 
<a name="id2613951"></a><h3>
 
1871
<a name="id2656180"></a><h3>
1882
1872
<a name="gimp-image-set-active-channel"></a>gimp_image_set_active_channel ()</h3>
1883
 
<a class="indexterm" name="id2613965"></a><pre class="programlisting">gboolean    gimp_image_set_active_channel   (gint32 image_ID,
1884
 
                                             gint32 active_channel_ID);</pre>
 
1873
<a class="indexterm" name="id2656195"></a><pre class="programlisting">gboolean            gimp_image_set_active_channel       (gint32 image_ID,
 
1874
                                                         gint32 active_channel_ID);</pre>
1885
1875
<p>
1886
1876
Sets the specified image's active channel.
1887
1877
</p>
1897
1887
<col align="left" valign="top">
1898
1888
<tbody>
1899
1889
<tr>
1900
 
<td>
1901
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1890
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1902
1891
<td> The image.
1903
1892
</td>
1904
1893
</tr>
1905
1894
<tr>
1906
 
<td>
1907
 
<span class="term"><em class="parameter"><code>active_channel_ID</code></em>&#160;:</span></td>
 
1895
<td><span class="term"><em class="parameter"><code>active_channel_ID</code></em>&#160;:</span></td>
1908
1896
<td> The new image active channel.
1909
1897
</td>
1910
1898
</tr>
1911
1899
<tr>
1912
 
<td>
1913
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1914
 
<td> TRUE on success.
1915
 
</td>
1916
 
</tr>
1917
 
</tbody>
1918
 
</table></div>
1919
 
</div>
1920
 
<hr>
1921
 
<div class="refsect2" lang="en">
1922
 
<a name="id2614056"></a><h3>
 
1900
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1901
<td> TRUE on success.
 
1902
</td>
 
1903
</tr>
 
1904
</tbody>
 
1905
</table></div>
 
1906
</div>
 
1907
<hr>
 
1908
<div class="refsect2" lang="en">
 
1909
<a name="id2656286"></a><h3>
 
1910
<a name="gimp-image-unset-active-channel"></a>gimp_image_unset_active_channel ()</h3>
 
1911
<a class="indexterm" name="id2656300"></a><pre class="programlisting">gboolean            gimp_image_unset_active_channel     (gint32 image_ID);</pre>
 
1912
<p>
 
1913
Unsets the active channel in the specified image.
 
1914
</p>
 
1915
<p>
 
1916
If an active channel exists, it is unset. There then exists no
 
1917
active channel, and if desired, one can be set through a call to
 
1918
'Set Active Channel'. No error is returned in the case of no
 
1919
existing active channel.</p>
 
1920
<p>
 
1921
 
 
1922
</p>
 
1923
<div class="variablelist"><table border="0">
 
1924
<col align="left" valign="top">
 
1925
<tbody>
 
1926
<tr>
 
1927
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1928
<td> The image.
 
1929
</td>
 
1930
</tr>
 
1931
<tr>
 
1932
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1933
<td> TRUE on success.
 
1934
</td>
 
1935
</tr>
 
1936
</tbody>
 
1937
</table></div>
 
1938
</div>
 
1939
<hr>
 
1940
<div class="refsect2" lang="en">
 
1941
<a name="id2656369"></a><h3>
1923
1942
<a name="gimp-image-get-selection"></a>gimp_image_get_selection ()</h3>
1924
 
<a class="indexterm" name="id2614070"></a><pre class="programlisting">gint32      gimp_image_get_selection        (gint32 image_ID);</pre>
 
1943
<a class="indexterm" name="id2656382"></a><pre class="programlisting">gint32              gimp_image_get_selection            (gint32 image_ID);</pre>
1925
1944
<p>
1926
1945
Returns the specified image's selection.
1927
1946
</p>
1935
1954
<col align="left" valign="top">
1936
1955
<tbody>
1937
1956
<tr>
1938
 
<td>
1939
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1957
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1940
1958
<td> The image.
1941
1959
</td>
1942
1960
</tr>
1943
1961
<tr>
1944
 
<td>
1945
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
1962
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1946
1963
<td> The selection channel.
1947
1964
</td>
1948
1965
</tr>
1951
1968
</div>
1952
1969
<hr>
1953
1970
<div class="refsect2" lang="en">
1954
 
<a name="id2614136"></a><h3>
 
1971
<a name="id2656449"></a><h3>
1955
1972
<a name="gimp-image-get-component-active"></a>gimp_image_get_component_active ()</h3>
1956
 
<a class="indexterm" name="id2614150"></a><pre class="programlisting">gboolean    gimp_image_get_component_active (gint32 image_ID,
1957
 
                                             <a href="libgimp-gimpenums.html#GimpChannelType">GimpChannelType</a> component);</pre>
 
1973
<a class="indexterm" name="id2656463"></a><pre class="programlisting">gboolean            gimp_image_get_component_active     (gint32 image_ID,
 
1974
                                                         <a
 
1975
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelType"
 
1976
>GimpChannelType</a> component);</pre>
1958
1977
<p>
1959
1978
Returns if the specified image's image component is active.
1960
1979
</p>
1970
1989
<col align="left" valign="top">
1971
1990
<tbody>
1972
1991
<tr>
1973
 
<td>
1974
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
1992
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
1975
1993
<td> The image.
1976
1994
</td>
1977
1995
</tr>
1978
1996
<tr>
1979
 
<td>
1980
 
<span class="term"><em class="parameter"><code>component</code></em>&#160;:</span></td>
 
1997
<td><span class="term"><em class="parameter"><code>component</code></em>&#160;:</span></td>
1981
1998
<td> The image component.
1982
1999
</td>
1983
2000
</tr>
1984
2001
<tr>
1985
 
<td>
1986
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2002
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
1987
2003
<td> Component is active.
1988
2004
</td>
1989
2005
</tr>
1992
2008
</div>
1993
2009
<hr>
1994
2010
<div class="refsect2" lang="en">
1995
 
<a name="id2614242"></a><h3>
 
2011
<a name="id2656555"></a><h3>
1996
2012
<a name="gimp-image-set-component-active"></a>gimp_image_set_component_active ()</h3>
1997
 
<a class="indexterm" name="id2614255"></a><pre class="programlisting">gboolean    gimp_image_set_component_active (gint32 image_ID,
1998
 
                                             <a href="libgimp-gimpenums.html#GimpChannelType">GimpChannelType</a> component,
1999
 
                                             gboolean active);</pre>
 
2013
<a class="indexterm" name="id2656569"></a><pre class="programlisting">gboolean            gimp_image_set_component_active     (gint32 image_ID,
 
2014
                                                         <a
 
2015
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelType"
 
2016
>GimpChannelType</a> component,
 
2017
                                                         gboolean active);</pre>
2000
2018
<p>
2001
2019
Sets if the specified image's image component is active.
2002
2020
</p>
2012
2030
<col align="left" valign="top">
2013
2031
<tbody>
2014
2032
<tr>
2015
 
<td>
2016
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2033
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2017
2034
<td> The image.
2018
2035
</td>
2019
2036
</tr>
2020
2037
<tr>
2021
 
<td>
2022
 
<span class="term"><em class="parameter"><code>component</code></em>&#160;:</span></td>
 
2038
<td><span class="term"><em class="parameter"><code>component</code></em>&#160;:</span></td>
2023
2039
<td> The image component.
2024
2040
</td>
2025
2041
</tr>
2026
2042
<tr>
2027
 
<td>
2028
 
<span class="term"><em class="parameter"><code>active</code></em>&#160;:</span></td>
 
2043
<td><span class="term"><em class="parameter"><code>active</code></em>&#160;:</span></td>
2029
2044
<td> Component is active.
2030
2045
</td>
2031
2046
</tr>
2032
2047
<tr>
2033
 
<td>
2034
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2048
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2035
2049
<td> TRUE on success.
2036
2050
</td>
2037
2051
</tr>
2040
2054
</div>
2041
2055
<hr>
2042
2056
<div class="refsect2" lang="en">
2043
 
<a name="id2614368"></a><h3>
 
2057
<a name="id2656682"></a><h3>
2044
2058
<a name="gimp-image-get-component-visible"></a>gimp_image_get_component_visible ()</h3>
2045
 
<a class="indexterm" name="id2614382"></a><pre class="programlisting">gboolean    gimp_image_get_component_visible
2046
 
                                            (gint32 image_ID,
2047
 
                                             <a href="libgimp-gimpenums.html#GimpChannelType">GimpChannelType</a> component);</pre>
 
2059
<a class="indexterm" name="id2656696"></a><pre class="programlisting">gboolean            gimp_image_get_component_visible    (gint32 image_ID,
 
2060
                                                         <a
 
2061
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelType"
 
2062
>GimpChannelType</a> component);</pre>
2048
2063
<p>
2049
2064
Returns if the specified image's image component is visible.
2050
2065
</p>
2061
2076
<col align="left" valign="top">
2062
2077
<tbody>
2063
2078
<tr>
2064
 
<td>
2065
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2079
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2066
2080
<td> The image.
2067
2081
</td>
2068
2082
</tr>
2069
2083
<tr>
2070
 
<td>
2071
 
<span class="term"><em class="parameter"><code>component</code></em>&#160;:</span></td>
 
2084
<td><span class="term"><em class="parameter"><code>component</code></em>&#160;:</span></td>
2072
2085
<td> The image component.
2073
2086
</td>
2074
2087
</tr>
2075
2088
<tr>
2076
 
<td>
2077
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2089
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2078
2090
<td> Component is visible.
2079
2091
</td>
2080
2092
</tr>
2083
2095
</div>
2084
2096
<hr>
2085
2097
<div class="refsect2" lang="en">
2086
 
<a name="id2614474"></a><h3>
 
2098
<a name="id2656788"></a><h3>
2087
2099
<a name="gimp-image-set-component-visible"></a>gimp_image_set_component_visible ()</h3>
2088
 
<a class="indexterm" name="id2614488"></a><pre class="programlisting">gboolean    gimp_image_set_component_visible
2089
 
                                            (gint32 image_ID,
2090
 
                                             <a href="libgimp-gimpenums.html#GimpChannelType">GimpChannelType</a> component,
2091
 
                                             gboolean visible);</pre>
 
2100
<a class="indexterm" name="id2656802"></a><pre class="programlisting">gboolean            gimp_image_set_component_visible    (gint32 image_ID,
 
2101
                                                         <a
 
2102
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelType"
 
2103
>GimpChannelType</a> component,
 
2104
                                                         gboolean visible);</pre>
2092
2105
<p>
2093
2106
Sets if the specified image's image component is visible.
2094
2107
</p>
2104
2117
<col align="left" valign="top">
2105
2118
<tbody>
2106
2119
<tr>
2107
 
<td>
2108
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2120
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2109
2121
<td> The image.
2110
2122
</td>
2111
2123
</tr>
2112
2124
<tr>
2113
 
<td>
2114
 
<span class="term"><em class="parameter"><code>component</code></em>&#160;:</span></td>
 
2125
<td><span class="term"><em class="parameter"><code>component</code></em>&#160;:</span></td>
2115
2126
<td> The image component.
2116
2127
</td>
2117
2128
</tr>
2118
2129
<tr>
2119
 
<td>
2120
 
<span class="term"><em class="parameter"><code>visible</code></em>&#160;:</span></td>
 
2130
<td><span class="term"><em class="parameter"><code>visible</code></em>&#160;:</span></td>
2121
2131
<td> Component is visible.
2122
2132
</td>
2123
2133
</tr>
2124
2134
<tr>
2125
 
<td>
2126
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2135
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2127
2136
<td> TRUE on success.
2128
2137
</td>
2129
2138
</tr>
2132
2141
</div>
2133
2142
<hr>
2134
2143
<div class="refsect2" lang="en">
2135
 
<a name="id2614601"></a><h3>
 
2144
<a name="id2656916"></a><h3>
2136
2145
<a name="gimp-image-get-filename"></a>gimp_image_get_filename ()</h3>
2137
 
<a class="indexterm" name="id2614615"></a><pre class="programlisting">gchar*      gimp_image_get_filename         (gint32 image_ID);</pre>
 
2146
<a class="indexterm" name="id2656930"></a><pre class="programlisting">gchar*              gimp_image_get_filename             (gint32 image_ID);</pre>
2138
2147
<p>
2139
2148
Returns the specified image's filename.
2140
2149
</p>
2149
2158
<col align="left" valign="top">
2150
2159
<tbody>
2151
2160
<tr>
2152
 
<td>
2153
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2161
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2154
2162
<td> The image.
2155
2163
</td>
2156
2164
</tr>
2157
2165
<tr>
2158
 
<td>
2159
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2166
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2160
2167
<td> The filename.
2161
2168
</td>
2162
2169
</tr>
2165
2172
</div>
2166
2173
<hr>
2167
2174
<div class="refsect2" lang="en">
2168
 
<a name="id2614693"></a><h3>
 
2175
<a name="id2657007"></a><h3>
2169
2176
<a name="gimp-image-set-filename"></a>gimp_image_set_filename ()</h3>
2170
 
<a class="indexterm" name="id2614706"></a><pre class="programlisting">gboolean    gimp_image_set_filename         (gint32 image_ID,
2171
 
                                             const gchar *filename);</pre>
 
2177
<a class="indexterm" name="id2657021"></a><pre class="programlisting">gboolean            gimp_image_set_filename             (gint32 image_ID,
 
2178
                                                         const gchar *filename);</pre>
2172
2179
<p>
2173
2180
Sets the specified image's filename.
2174
2181
</p>
2182
2189
<col align="left" valign="top">
2183
2190
<tbody>
2184
2191
<tr>
2185
 
<td>
2186
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2192
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2187
2193
<td> The image.
2188
2194
</td>
2189
2195
</tr>
2190
2196
<tr>
2191
 
<td>
2192
 
<span class="term"><em class="parameter"><code>filename</code></em>&#160;:</span></td>
 
2197
<td><span class="term"><em class="parameter"><code>filename</code></em>&#160;:</span></td>
2193
2198
<td> The new image filename.
2194
2199
</td>
2195
2200
</tr>
2196
2201
<tr>
2197
 
<td>
2198
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2202
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2199
2203
<td> TRUE on success.
2200
2204
</td>
2201
2205
</tr>
2204
2208
</div>
2205
2209
<hr>
2206
2210
<div class="refsect2" lang="en">
2207
 
<a name="id2614795"></a><h3>
 
2211
<a name="id2657109"></a><h3>
2208
2212
<a name="gimp-image-get-name"></a>gimp_image_get_name ()</h3>
2209
 
<a class="indexterm" name="id2614809"></a><pre class="programlisting">gchar*      gimp_image_get_name             (gint32 image_ID);</pre>
 
2213
<a class="indexterm" name="id2657123"></a><pre class="programlisting">gchar*              gimp_image_get_name                 (gint32 image_ID);</pre>
2210
2214
<p>
2211
2215
Returns the specified image's name.
2212
2216
</p>
2219
2223
<col align="left" valign="top">
2220
2224
<tbody>
2221
2225
<tr>
2222
 
<td>
2223
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2226
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2224
2227
<td> The image.
2225
2228
</td>
2226
2229
</tr>
2227
2230
<tr>
2228
 
<td>
2229
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2231
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2230
2232
<td> The name.
2231
2233
</td>
2232
2234
</tr>
2235
2237
</div>
2236
2238
<hr>
2237
2239
<div class="refsect2" lang="en">
2238
 
<a name="id2614874"></a><h3>
 
2240
<a name="id2657189"></a><h3>
2239
2241
<a name="gimp-image-get-resolution"></a>gimp_image_get_resolution ()</h3>
2240
 
<a class="indexterm" name="id2614888"></a><pre class="programlisting">gboolean    gimp_image_get_resolution       (gint32 image_ID,
2241
 
                                             gdouble *xresolution,
2242
 
                                             gdouble *yresolution);</pre>
 
2242
<a class="indexterm" name="id2657203"></a><pre class="programlisting">gboolean            gimp_image_get_resolution           (gint32 image_ID,
 
2243
                                                         gdouble *xresolution,
 
2244
                                                         gdouble *yresolution);</pre>
2243
2245
<p>
2244
2246
Returns the specified image's resolution.
2245
2247
</p>
2253
2255
<col align="left" valign="top">
2254
2256
<tbody>
2255
2257
<tr>
2256
 
<td>
2257
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2258
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2258
2259
<td> The image.
2259
2260
</td>
2260
2261
</tr>
2261
2262
<tr>
2262
 
<td>
2263
 
<span class="term"><em class="parameter"><code>xresolution</code></em>&#160;:</span></td>
2264
 
<td> The resolutionin the x-axis, in dots per inch.
2265
 
</td>
2266
 
</tr>
2267
 
<tr>
2268
 
<td>
2269
 
<span class="term"><em class="parameter"><code>yresolution</code></em>&#160;:</span></td>
2270
 
<td> The resolutionin the y-axis, in dots per inch.
2271
 
</td>
2272
 
</tr>
2273
 
<tr>
2274
 
<td>
2275
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2263
<td><span class="term"><em class="parameter"><code>xresolution</code></em>&#160;:</span></td>
 
2264
<td> The resolution in the x-axis, in dots per inch.
 
2265
</td>
 
2266
</tr>
 
2267
<tr>
 
2268
<td><span class="term"><em class="parameter"><code>yresolution</code></em>&#160;:</span></td>
 
2269
<td> The resolution in the y-axis, in dots per inch.
 
2270
</td>
 
2271
</tr>
 
2272
<tr>
 
2273
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2276
2274
<td> TRUE on success.
2277
2275
</td>
2278
2276
</tr>
2281
2279
</div>
2282
2280
<hr>
2283
2281
<div class="refsect2" lang="en">
2284
 
<a name="id2614998"></a><h3>
 
2282
<a name="id2657314"></a><h3>
2285
2283
<a name="gimp-image-set-resolution"></a>gimp_image_set_resolution ()</h3>
2286
 
<a class="indexterm" name="id2615013"></a><pre class="programlisting">gboolean    gimp_image_set_resolution       (gint32 image_ID,
2287
 
                                             gdouble xresolution,
2288
 
                                             gdouble yresolution);</pre>
 
2284
<a class="indexterm" name="id2657328"></a><pre class="programlisting">gboolean            gimp_image_set_resolution           (gint32 image_ID,
 
2285
                                                         gdouble xresolution,
 
2286
                                                         gdouble yresolution);</pre>
2289
2287
<p>
2290
2288
Sets the specified image's resolution.
2291
2289
</p>
2300
2298
<col align="left" valign="top">
2301
2299
<tbody>
2302
2300
<tr>
2303
 
<td>
2304
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2301
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2305
2302
<td> The image.
2306
2303
</td>
2307
2304
</tr>
2308
2305
<tr>
2309
 
<td>
2310
 
<span class="term"><em class="parameter"><code>xresolution</code></em>&#160;:</span></td>
 
2306
<td><span class="term"><em class="parameter"><code>xresolution</code></em>&#160;:</span></td>
2311
2307
<td> The new image resolution in the x-axis, in dots per inch.
2312
2308
</td>
2313
2309
</tr>
2314
2310
<tr>
2315
 
<td>
2316
 
<span class="term"><em class="parameter"><code>yresolution</code></em>&#160;:</span></td>
 
2311
<td><span class="term"><em class="parameter"><code>yresolution</code></em>&#160;:</span></td>
2317
2312
<td> The new image resolution in the y-axis, in dots per inch.
2318
2313
</td>
2319
2314
</tr>
2320
2315
<tr>
2321
 
<td>
2322
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2316
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2323
2317
<td> TRUE on success.
2324
2318
</td>
2325
2319
</tr>
2328
2322
</div>
2329
2323
<hr>
2330
2324
<div class="refsect2" lang="en">
2331
 
<a name="id2615124"></a><h3>
 
2325
<a name="id2657440"></a><h3>
2332
2326
<a name="gimp-image-get-unit"></a>gimp_image_get_unit ()</h3>
2333
 
<a class="indexterm" name="id2615138"></a><pre class="programlisting"><a
 
2327
<a class="indexterm" name="id2657454"></a><pre class="programlisting"><a
2334
2328
href="../libgimpbase/libgimpbase-gimpunit.html#GimpUnit"
2335
 
>GimpUnit</a>    gimp_image_get_unit             (gint32 image_ID);</pre>
 
2329
>GimpUnit</a>            gimp_image_get_unit                 (gint32 image_ID);</pre>
2336
2330
<p>
2337
2331
Returns the specified image's unit.
2338
2332
</p>
2339
2333
<p>
2340
2334
This procedure returns the specified image's unit. This value is
2341
 
independent of any of the layers in this image. See the gimp_unit_*
2342
 
procedure definitions for the valid range of unit IDs and a
2343
 
description of the unit system.</p>
 
2335
independent of any of the layers in this image. See the
 
2336
gimp_unit_*() procedure definitions for the valid range of unit IDs
 
2337
and a description of the unit system.</p>
2344
2338
<p>
2345
2339
 
2346
2340
</p>
2348
2342
<col align="left" valign="top">
2349
2343
<tbody>
2350
2344
<tr>
2351
 
<td>
2352
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2345
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2353
2346
<td> The image.
2354
2347
</td>
2355
2348
</tr>
2356
2349
<tr>
2357
 
<td>
2358
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2350
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2359
2351
<td> The unit.
2360
2352
</td>
2361
2353
</tr>
2364
2356
</div>
2365
2357
<hr>
2366
2358
<div class="refsect2" lang="en">
2367
 
<a name="id2615206"></a><h3>
 
2359
<a name="id2657522"></a><h3>
2368
2360
<a name="gimp-image-set-unit"></a>gimp_image_set_unit ()</h3>
2369
 
<a class="indexterm" name="id2615220"></a><pre class="programlisting">gboolean    gimp_image_set_unit             (gint32 image_ID,
2370
 
                                             <a
 
2361
<a class="indexterm" name="id2657536"></a><pre class="programlisting">gboolean            gimp_image_set_unit                 (gint32 image_ID,
 
2362
                                                         <a
2371
2363
href="../libgimpbase/libgimpbase-gimpunit.html#GimpUnit"
2372
2364
>GimpUnit</a> unit);</pre>
2373
2365
<p>
2376
2368
<p>
2377
2369
This procedure sets the specified image's unit. No scaling or
2378
2370
resizing is performed. This value is independent of any of the
2379
 
layers in this image. See the gimp_unit_* procedure definitions for
2380
 
the valid range of unit IDs and a description of the unit system.</p>
 
2371
layers in this image. See the gimp_unit_*() procedure definitions
 
2372
for the valid range of unit IDs and a description of the unit
 
2373
system.</p>
2381
2374
<p>
2382
2375
 
2383
2376
</p>
2385
2378
<col align="left" valign="top">
2386
2379
<tbody>
2387
2380
<tr>
2388
 
<td>
2389
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2381
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2390
2382
<td> The image.
2391
2383
</td>
2392
2384
</tr>
2393
2385
<tr>
2394
 
<td>
2395
 
<span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
 
2386
<td><span class="term"><em class="parameter"><code>unit</code></em>&#160;:</span></td>
2396
2387
<td> The new image unit.
2397
2388
</td>
2398
2389
</tr>
2399
2390
<tr>
2400
 
<td>
2401
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2391
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2402
2392
<td> TRUE on success.
2403
2393
</td>
2404
2394
</tr>
2407
2397
</div>
2408
2398
<hr>
2409
2399
<div class="refsect2" lang="en">
2410
 
<a name="id2615309"></a><h3>
 
2400
<a name="id2657626"></a><h3>
2411
2401
<a name="gimp-image-set-tattoo-state"></a>gimp_image_set_tattoo_state ()</h3>
2412
 
<a class="indexterm" name="id2615323"></a><pre class="programlisting">gboolean    gimp_image_set_tattoo_state     (gint32 image_ID,
2413
 
                                             gint tattoo_state);</pre>
 
2402
<a class="indexterm" name="id2657640"></a><pre class="programlisting">gboolean            gimp_image_set_tattoo_state         (gint32 image_ID,
 
2403
                                                         gint tattoo_state);</pre>
2414
2404
<p>
2415
2405
Set the tattoo state associated with the image.
2416
2406
</p>
2434
2424
<col align="left" valign="top">
2435
2425
<tbody>
2436
2426
<tr>
2437
 
<td>
2438
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2427
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2439
2428
<td> The image.
2440
2429
</td>
2441
2430
</tr>
2442
2431
<tr>
2443
 
<td>
2444
 
<span class="term"><em class="parameter"><code>tattoo_state</code></em>&#160;:</span></td>
2445
 
<td> The new image tattoo_state.
 
2432
<td><span class="term"><em class="parameter"><code>tattoo_state</code></em>&#160;:</span></td>
 
2433
<td> The new image tattoo state.
2446
2434
</td>
2447
2435
</tr>
2448
2436
<tr>
2449
 
<td>
2450
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2437
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2451
2438
<td> TRUE on success.
2452
2439
</td>
2453
2440
</tr>
2456
2443
</div>
2457
2444
<hr>
2458
2445
<div class="refsect2" lang="en">
2459
 
<a name="id2615422"></a><h3>
 
2446
<a name="id2657739"></a><h3>
2460
2447
<a name="gimp-image-get-tattoo-state"></a>gimp_image_get_tattoo_state ()</h3>
2461
 
<a class="indexterm" name="id2615436"></a><pre class="programlisting">gint        gimp_image_get_tattoo_state     (gint32 image_ID);</pre>
 
2448
<a class="indexterm" name="id2657754"></a><pre class="programlisting">gint                gimp_image_get_tattoo_state         (gint32 image_ID);</pre>
2462
2449
<p>
2463
2450
Returns the tattoo state associated with the image.
2464
2451
</p>
2473
2460
<col align="left" valign="top">
2474
2461
<tbody>
2475
2462
<tr>
2476
 
<td>
2477
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2463
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2478
2464
<td> The image.
2479
2465
</td>
2480
2466
</tr>
2481
2467
<tr>
2482
 
<td>
2483
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2484
 
<td> The tattoo_state.
 
2468
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2469
<td> The tattoo state.
2485
2470
</td>
2486
2471
</tr>
2487
2472
</tbody>
2489
2474
</div>
2490
2475
<hr>
2491
2476
<div class="refsect2" lang="en">
2492
 
<a name="id2615504"></a><h3>
 
2477
<a name="id2657822"></a><h3>
2493
2478
<a name="gimp-image-get-layer-by-tattoo"></a>gimp_image_get_layer_by_tattoo ()</h3>
2494
 
<a class="indexterm" name="id2615518"></a><pre class="programlisting">gint32      gimp_image_get_layer_by_tattoo  (gint32 image_ID,
2495
 
                                             gint tattoo);</pre>
 
2479
<a class="indexterm" name="id2657836"></a><pre class="programlisting">gint32              gimp_image_get_layer_by_tattoo      (gint32 image_ID,
 
2480
                                                         gint tattoo);</pre>
2496
2481
<p>
2497
2482
Find a layer with a given tattoo in an image.
2498
2483
</p>
2506
2491
<col align="left" valign="top">
2507
2492
<tbody>
2508
2493
<tr>
2509
 
<td>
2510
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2494
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2511
2495
<td> The image.
2512
2496
</td>
2513
2497
</tr>
2514
2498
<tr>
2515
 
<td>
2516
 
<span class="term"><em class="parameter"><code>tattoo</code></em>&#160;:</span></td>
 
2499
<td><span class="term"><em class="parameter"><code>tattoo</code></em>&#160;:</span></td>
2517
2500
<td> The tattoo of the layer to find.
2518
2501
</td>
2519
2502
</tr>
2520
2503
<tr>
2521
 
<td>
2522
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2504
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2523
2505
<td> The layer with the specified tattoo.
2524
2506
</td>
2525
2507
</tr>
2528
2510
</div>
2529
2511
<hr>
2530
2512
<div class="refsect2" lang="en">
2531
 
<a name="id2615606"></a><h3>
 
2513
<a name="id2657924"></a><h3>
2532
2514
<a name="gimp-image-get-channel-by-tattoo"></a>gimp_image_get_channel_by_tattoo ()</h3>
2533
 
<a class="indexterm" name="id2615621"></a><pre class="programlisting">gint32      gimp_image_get_channel_by_tattoo
2534
 
                                            (gint32 image_ID,
2535
 
                                             gint tattoo);</pre>
 
2515
<a class="indexterm" name="id2657939"></a><pre class="programlisting">gint32              gimp_image_get_channel_by_tattoo    (gint32 image_ID,
 
2516
                                                         gint tattoo);</pre>
2536
2517
<p>
2537
2518
Find a channel with a given tattoo in an image.
2538
2519
</p>
2546
2527
<col align="left" valign="top">
2547
2528
<tbody>
2548
2529
<tr>
2549
 
<td>
2550
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2530
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2551
2531
<td> The image.
2552
2532
</td>
2553
2533
</tr>
2554
2534
<tr>
2555
 
<td>
2556
 
<span class="term"><em class="parameter"><code>tattoo</code></em>&#160;:</span></td>
 
2535
<td><span class="term"><em class="parameter"><code>tattoo</code></em>&#160;:</span></td>
2557
2536
<td> The tattoo of the channel to find.
2558
2537
</td>
2559
2538
</tr>
2560
2539
<tr>
2561
 
<td>
2562
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2540
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2563
2541
<td> The channel with the specified tattoo.
2564
2542
</td>
2565
2543
</tr>
2568
2546
</div>
2569
2547
<hr>
2570
2548
<div class="refsect2" lang="en">
2571
 
<a name="id2615710"></a><h3>
 
2549
<a name="id2658027"></a><h3>
2572
2550
<a name="gimp-image-get-cmap"></a>gimp_image_get_cmap ()</h3>
2573
 
<a class="indexterm" name="id2615726"></a><pre class="programlisting">guchar*     gimp_image_get_cmap             (gint32 image_ID,
2574
 
                                             gint *num_colors);</pre>
 
2551
<a class="indexterm" name="id2658044"></a><pre class="programlisting">guchar*             gimp_image_get_cmap                 (gint32 image_ID,
 
2552
                                                         gint *num_colors);</pre>
2575
2553
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2576
2554
<h3 class="title">Warning</h3>
2577
2555
<p><code class="literal">gimp_image_get_cmap</code> is deprecated and should not be used in newly-written code.</p>
2585
2563
<col align="left" valign="top">
2586
2564
<tbody>
2587
2565
<tr>
2588
 
<td>
2589
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2566
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2590
2567
<td>   The image.
2591
2568
</td>
2592
2569
</tr>
2593
2570
<tr>
2594
 
<td>
2595
 
<span class="term"><em class="parameter"><code>num_colors</code></em>&#160;:</span></td>
 
2571
<td><span class="term"><em class="parameter"><code>num_colors</code></em>&#160;:</span></td>
2596
2572
<td> Number of colors in the colormap array.
2597
2573
</td>
2598
2574
</tr>
2599
2575
<tr>
2600
 
<td>
2601
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2576
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2602
2577
<td> The image's colormap.
2603
2578
</td>
2604
2579
</tr>
2607
2582
</div>
2608
2583
<hr>
2609
2584
<div class="refsect2" lang="en">
2610
 
<a name="id2615831"></a><h3>
 
2585
<a name="id2658149"></a><h3>
2611
2586
<a name="gimp-image-set-cmap"></a>gimp_image_set_cmap ()</h3>
2612
 
<a class="indexterm" name="id2615847"></a><pre class="programlisting">gboolean    gimp_image_set_cmap             (gint32 image_ID,
2613
 
                                             const guchar *cmap,
2614
 
                                             gint num_colors);</pre>
 
2587
<a class="indexterm" name="id2658165"></a><pre class="programlisting">gboolean            gimp_image_set_cmap                 (gint32 image_ID,
 
2588
                                                         const guchar *cmap,
 
2589
                                                         gint num_colors);</pre>
2615
2590
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2616
2591
<h3 class="title">Warning</h3>
2617
2592
<p><code class="literal">gimp_image_set_cmap</code> is deprecated and should not be used in newly-written code.</p>
2625
2600
<col align="left" valign="top">
2626
2601
<tbody>
2627
2602
<tr>
2628
 
<td>
2629
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2603
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2630
2604
<td>   The image.
2631
2605
</td>
2632
2606
</tr>
2633
2607
<tr>
2634
 
<td>
2635
 
<span class="term"><em class="parameter"><code>cmap</code></em>&#160;:</span></td>
 
2608
<td><span class="term"><em class="parameter"><code>cmap</code></em>&#160;:</span></td>
2636
2609
<td>       The new colormap values.
2637
2610
</td>
2638
2611
</tr>
2639
2612
<tr>
2640
 
<td>
2641
 
<span class="term"><em class="parameter"><code>num_colors</code></em>&#160;:</span></td>
 
2613
<td><span class="term"><em class="parameter"><code>num_colors</code></em>&#160;:</span></td>
2642
2614
<td> Number of colors in the colormap array.
2643
2615
</td>
2644
2616
</tr>
2645
2617
<tr>
2646
 
<td>
2647
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2618
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2648
2619
<td> TRUE on success.
2649
2620
</td>
2650
2621
</tr>
2653
2624
</div>
2654
2625
<hr>
2655
2626
<div class="refsect2" lang="en">
2656
 
<a name="id2615974"></a><h3>
 
2627
<a name="id2658292"></a><h3>
2657
2628
<a name="gimp-image-get-colormap"></a>gimp_image_get_colormap ()</h3>
2658
 
<a class="indexterm" name="id2615987"></a><pre class="programlisting">guchar*     gimp_image_get_colormap         (gint32 image_ID,
2659
 
                                             gint *num_colors);</pre>
 
2629
<a class="indexterm" name="id2658306"></a><pre class="programlisting">guchar*             gimp_image_get_colormap             (gint32 image_ID,
 
2630
                                                         gint *num_colors);</pre>
2660
2631
<p>
2661
2632
Returns the image's colormap
2662
2633
</p>
2671
2642
<col align="left" valign="top">
2672
2643
<tbody>
2673
2644
<tr>
2674
 
<td>
2675
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2645
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2676
2646
<td>   The image.
2677
2647
</td>
2678
2648
</tr>
2679
2649
<tr>
2680
 
<td>
2681
 
<span class="term"><em class="parameter"><code>num_colors</code></em>&#160;:</span></td>
 
2650
<td><span class="term"><em class="parameter"><code>num_colors</code></em>&#160;:</span></td>
2682
2651
<td> Number of colors in the colormap array.
2683
2652
</td>
2684
2653
</tr>
2685
2654
<tr>
2686
 
<td>
2687
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2655
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2688
2656
<td> The image's colormap.
2689
2657
</td>
2690
2658
</tr>
2693
2661
</div>
2694
2662
<hr>
2695
2663
<div class="refsect2" lang="en">
2696
 
<a name="id2616077"></a><h3>
 
2664
<a name="id2658396"></a><h3>
2697
2665
<a name="gimp-image-set-colormap"></a>gimp_image_set_colormap ()</h3>
2698
 
<a class="indexterm" name="id2616091"></a><pre class="programlisting">gboolean    gimp_image_set_colormap         (gint32 image_ID,
2699
 
                                             const guchar *colormap,
2700
 
                                             gint num_colors);</pre>
 
2666
<a class="indexterm" name="id2658410"></a><pre class="programlisting">gboolean            gimp_image_set_colormap             (gint32 image_ID,
 
2667
                                                         const guchar *colormap,
 
2668
                                                         gint num_colors);</pre>
2701
2669
<p>
2702
2670
Sets the entries in the image's colormap.
2703
2671
</p>
2713
2681
<col align="left" valign="top">
2714
2682
<tbody>
2715
2683
<tr>
2716
 
<td>
2717
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2684
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2718
2685
<td>   The image.
2719
2686
</td>
2720
2687
</tr>
2721
2688
<tr>
2722
 
<td>
2723
 
<span class="term"><em class="parameter"><code>colormap</code></em>&#160;:</span></td>
 
2689
<td><span class="term"><em class="parameter"><code>colormap</code></em>&#160;:</span></td>
2724
2690
<td>   The new colormap values.
2725
2691
</td>
2726
2692
</tr>
2727
2693
<tr>
2728
 
<td>
2729
 
<span class="term"><em class="parameter"><code>num_colors</code></em>&#160;:</span></td>
 
2694
<td><span class="term"><em class="parameter"><code>num_colors</code></em>&#160;:</span></td>
2730
2695
<td> Number of colors in the colormap array.
2731
2696
</td>
2732
2697
</tr>
2733
2698
<tr>
2734
 
<td>
2735
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2699
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2736
2700
<td> TRUE on success.
2737
2701
</td>
2738
2702
</tr>
2741
2705
</div>
2742
2706
<hr>
2743
2707
<div class="refsect2" lang="en">
2744
 
<a name="id2616203"></a><h3>
 
2708
<a name="id2658523"></a><h3>
 
2709
<a name="gimp-image-get-vectors"></a>gimp_image_get_vectors ()</h3>
 
2710
<a class="indexterm" name="id2658539"></a><pre class="programlisting">gint*               gimp_image_get_vectors              (gint32 image_ID,
 
2711
                                                         gint *num_vectors);</pre>
 
2712
<p>
 
2713
Returns the list of vectors contained in the specified image.
 
2714
</p>
 
2715
<p>
 
2716
This procedure returns the list of vectors contained in the
 
2717
specified image.</p>
 
2718
<p>
 
2719
 
 
2720
</p>
 
2721
<div class="variablelist"><table border="0">
 
2722
<col align="left" valign="top">
 
2723
<tbody>
 
2724
<tr>
 
2725
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2726
<td> The image.
 
2727
</td>
 
2728
</tr>
 
2729
<tr>
 
2730
<td><span class="term"><em class="parameter"><code>num_vectors</code></em>&#160;:</span></td>
 
2731
<td> The number of vectors contained in the image.
 
2732
</td>
 
2733
</tr>
 
2734
<tr>
 
2735
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2736
<td> The list of vectors contained in the image.
 
2737
 
 
2738
</td>
 
2739
</tr>
 
2740
</tbody>
 
2741
</table></div>
 
2742
<p class="since">Since  GIMP 2.4
 
2743
</p>
 
2744
</div>
 
2745
<hr>
 
2746
<div class="refsect2" lang="en">
 
2747
<a name="id2658635"></a><h3>
2745
2748
<a name="gimp-image-get-thumbnail-data"></a>gimp_image_get_thumbnail_data ()</h3>
2746
 
<a class="indexterm" name="id2616217"></a><pre class="programlisting">guchar*     gimp_image_get_thumbnail_data   (gint32 image_ID,
2747
 
                                             gint *width,
2748
 
                                             gint *height,
2749
 
                                             gint *bpp);</pre>
 
2749
<a class="indexterm" name="id2658650"></a><pre class="programlisting">guchar*             gimp_image_get_thumbnail_data       (gint32 image_ID,
 
2750
                                                         gint *width,
 
2751
                                                         gint *height,
 
2752
                                                         gint *bpp);</pre>
2750
2753
<p>
2751
2754
 
2752
2755
</p>
2754
2757
<col align="left" valign="top">
2755
2758
<tbody>
2756
2759
<tr>
2757
 
<td>
2758
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2759
 
<td>
2760
 
</td>
2761
 
</tr>
2762
 
<tr>
2763
 
<td>
2764
 
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
2765
 
<td>
2766
 
</td>
2767
 
</tr>
2768
 
<tr>
2769
 
<td>
2770
 
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
2771
 
<td>
2772
 
</td>
2773
 
</tr>
2774
 
<tr>
2775
 
<td>
2776
 
<span class="term"><em class="parameter"><code>bpp</code></em>&#160;:</span></td>
2777
 
<td>
2778
 
</td>
2779
 
</tr>
2780
 
<tr>
2781
 
<td>
2782
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2760
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2761
<td>
 
2762
</td>
 
2763
</tr>
 
2764
<tr>
 
2765
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
 
2766
<td>
 
2767
</td>
 
2768
</tr>
 
2769
<tr>
 
2770
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
 
2771
<td>
 
2772
</td>
 
2773
</tr>
 
2774
<tr>
 
2775
<td><span class="term"><em class="parameter"><code>bpp</code></em>&#160;:</span></td>
 
2776
<td>
 
2777
</td>
 
2778
</tr>
 
2779
<tr>
 
2780
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2783
2781
<td>
2784
2782
 
2785
2783
 
2790
2788
</div>
2791
2789
<hr>
2792
2790
<div class="refsect2" lang="en">
2793
 
<a name="id2616337"></a><h3>
 
2791
<a name="id2658770"></a><h3>
2794
2792
<a name="gimp-image-parasite-find"></a>gimp_image_parasite_find ()</h3>
2795
 
<a class="indexterm" name="id2616351"></a><pre class="programlisting"><a
 
2793
<a class="indexterm" name="id2658784"></a><pre class="programlisting"><a
2796
2794
href="../libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"
2797
 
>GimpParasite</a>* gimp_image_parasite_find      (gint32 image_ID,
2798
 
                                             const gchar *name);</pre>
 
2795
>GimpParasite</a>*       gimp_image_parasite_find            (gint32 image_ID,
 
2796
                                                         const gchar *name);</pre>
2799
2797
<p>
2800
 
Finds the named parasite in an image
 
2798
Look up a parasite in an image
2801
2799
</p>
2802
2800
<p>
2803
 
Finds and returns the named parasite that was previously attached to
2804
 
an image.</p>
 
2801
Finds and returns the parasite that was previously attached to an
 
2802
image.</p>
2805
2803
<p>
2806
2804
 
2807
2805
</p>
2809
2807
<col align="left" valign="top">
2810
2808
<tbody>
2811
2809
<tr>
2812
 
<td>
2813
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2810
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2814
2811
<td> The image.
2815
2812
</td>
2816
2813
</tr>
2817
2814
<tr>
2818
 
<td>
2819
 
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
2815
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
2820
2816
<td> The name of the parasite to find.
2821
2817
</td>
2822
2818
</tr>
2823
2819
<tr>
2824
 
<td>
2825
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2820
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2826
2821
<td> The found parasite.
2827
2822
</td>
2828
2823
</tr>
2831
2826
</div>
2832
2827
<hr>
2833
2828
<div class="refsect2" lang="en">
2834
 
<a name="id2616439"></a><h3>
 
2829
<a name="id2658872"></a><h3>
2835
2830
<a name="gimp-image-parasite-list"></a>gimp_image_parasite_list ()</h3>
2836
 
<a class="indexterm" name="id2616453"></a><pre class="programlisting">gboolean    gimp_image_parasite_list        (gint32 image_ID,
2837
 
                                             gint *num_parasites,
2838
 
                                             gchar ***parasites);</pre>
 
2831
<a class="indexterm" name="id2658886"></a><pre class="programlisting">gboolean            gimp_image_parasite_list            (gint32 image_ID,
 
2832
                                                         gint *num_parasites,
 
2833
                                                         gchar ***parasites);</pre>
2839
2834
<p>
2840
2835
List all parasites.
2841
2836
</p>
2848
2843
<col align="left" valign="top">
2849
2844
<tbody>
2850
2845
<tr>
2851
 
<td>
2852
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2846
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2853
2847
<td> The image.
2854
2848
</td>
2855
2849
</tr>
2856
2850
<tr>
2857
 
<td>
2858
 
<span class="term"><em class="parameter"><code>num_parasites</code></em>&#160;:</span></td>
 
2851
<td><span class="term"><em class="parameter"><code>num_parasites</code></em>&#160;:</span></td>
2859
2852
<td> The number of attached parasites.
2860
2853
</td>
2861
2854
</tr>
2862
2855
<tr>
2863
 
<td>
2864
 
<span class="term"><em class="parameter"><code>parasites</code></em>&#160;:</span></td>
 
2856
<td><span class="term"><em class="parameter"><code>parasites</code></em>&#160;:</span></td>
2865
2857
<td> The names of currently attached parasites.
2866
2858
</td>
2867
2859
</tr>
2868
2860
<tr>
2869
 
<td>
2870
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2861
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2871
2862
<td> TRUE on success.
2872
2863
</td>
2873
2864
</tr>
2876
2867
</div>
2877
2868
<hr>
2878
2869
<div class="refsect2" lang="en">
2879
 
<a name="id2616562"></a><h3>
 
2870
<a name="id2658996"></a><h3>
2880
2871
<a name="gimp-image-parasite-attach"></a>gimp_image_parasite_attach ()</h3>
2881
 
<a class="indexterm" name="id2616576"></a><pre class="programlisting">gboolean    gimp_image_parasite_attach      (gint32 image_ID,
2882
 
                                             <a
 
2872
<a class="indexterm" name="id2659010"></a><pre class="programlisting">gboolean            gimp_image_parasite_attach          (gint32 image_ID,
 
2873
                                                         const <a
2883
2874
href="../libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"
2884
2875
>GimpParasite</a> *parasite);</pre>
2885
2876
<p>
2895
2886
<col align="left" valign="top">
2896
2887
<tbody>
2897
2888
<tr>
2898
 
<td>
2899
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2889
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2900
2890
<td> The image.
2901
2891
</td>
2902
2892
</tr>
2903
2893
<tr>
2904
 
<td>
2905
 
<span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
 
2894
<td><span class="term"><em class="parameter"><code>parasite</code></em>&#160;:</span></td>
2906
2895
<td> The parasite to attach to an image.
2907
2896
</td>
2908
2897
</tr>
2909
2898
<tr>
2910
 
<td>
2911
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2899
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2912
2900
<td> TRUE on success.
2913
2901
</td>
2914
2902
</tr>
2917
2905
</div>
2918
2906
<hr>
2919
2907
<div class="refsect2" lang="en">
2920
 
<a name="id2616664"></a><h3>
 
2908
<a name="id2659098"></a><h3>
2921
2909
<a name="gimp-image-parasite-detach"></a>gimp_image_parasite_detach ()</h3>
2922
 
<a class="indexterm" name="id2616678"></a><pre class="programlisting">gboolean    gimp_image_parasite_detach      (gint32 image_ID,
2923
 
                                             const gchar *name);</pre>
 
2910
<a class="indexterm" name="id2659113"></a><pre class="programlisting">gboolean            gimp_image_parasite_detach          (gint32 image_ID,
 
2911
                                                         const gchar *name);</pre>
2924
2912
<p>
2925
2913
Removes a parasite from an image.
2926
2914
</p>
2934
2922
<col align="left" valign="top">
2935
2923
<tbody>
2936
2924
<tr>
2937
 
<td>
2938
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2925
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2939
2926
<td> The image.
2940
2927
</td>
2941
2928
</tr>
2942
2929
<tr>
2943
 
<td>
2944
 
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
2930
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
2945
2931
<td> The name of the parasite to detach from an image.
2946
2932
</td>
2947
2933
</tr>
2948
2934
<tr>
2949
 
<td>
2950
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2935
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
2951
2936
<td> TRUE on success.
2952
2937
</td>
2953
2938
</tr>
2956
2941
</div>
2957
2942
<hr>
2958
2943
<div class="refsect2" lang="en">
2959
 
<a name="id2616765"></a><h3>
 
2944
<a name="id2659200"></a><h3>
2960
2945
<a name="gimp-image-attach-new-parasite"></a>gimp_image_attach_new_parasite ()</h3>
2961
 
<a class="indexterm" name="id2616780"></a><pre class="programlisting">void        gimp_image_attach_new_parasite  (gint32 image_ID,
2962
 
                                             const gchar *name,
2963
 
                                             gint flags,
2964
 
                                             gint size,
2965
 
                                             gconstpointer data);</pre>
 
2946
<a class="indexterm" name="id2659214"></a><pre class="programlisting">gboolean            gimp_image_attach_new_parasite      (gint32 image_ID,
 
2947
                                                         const gchar *name,
 
2948
                                                         gint flags,
 
2949
                                                         gint size,
 
2950
                                                         gconstpointer data);</pre>
2966
2951
<p>
2967
2952
Convenience function that creates a parasite and attaches it
2968
 
to the GIMP.
2969
 
</p>
2970
 
<p>
2971
 
See Also: <a href="libgimp-gimpimage.html#gimp-image-parasite-attach"><code class="function">gimp_image_parasite_attach()</code></a></p>
 
2953
to the GIMP.</p>
2972
2954
<p>
2973
2955
 
2974
2956
</p>
2976
2958
<col align="left" valign="top">
2977
2959
<tbody>
2978
2960
<tr>
2979
 
<td>
2980
 
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
2961
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
2981
2962
<td> the ID of the image to attach the <a
2982
2963
href="../libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"
2983
2964
><span class="type">GimpParasite</span></a> to.
2984
2965
</td>
2985
2966
</tr>
2986
2967
<tr>
2987
 
<td>
2988
 
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
2968
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
2989
2969
<td> the name of the <a
2990
2970
href="../libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"
2991
2971
><span class="type">GimpParasite</span></a> to create and attach.
2992
2972
</td>
2993
2973
</tr>
2994
2974
<tr>
2995
 
<td>
2996
 
<span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
 
2975
<td><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
2997
2976
<td> the flags set on the <a
2998
2977
href="../libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"
2999
2978
><span class="type">GimpParasite</span></a>.
3000
2979
</td>
3001
2980
</tr>
3002
2981
<tr>
3003
 
<td>
3004
 
<span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
 
2982
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
3005
2983
<td> the size of the parasite data in bytes.
3006
2984
</td>
3007
2985
</tr>
3008
2986
<tr>
3009
 
<td>
3010
 
<span class="term"><em class="parameter"><code>data</code></em>&#160;:</span></td>
 
2987
<td><span class="term"><em class="parameter"><code>data</code></em>&#160;:</span></td>
3011
2988
<td> a pointer to the data attached with the <a
3012
2989
href="../libgimpbase/libgimpbase-gimpparasite.html#GimpParasite"
3013
2990
><span class="type">GimpParasite</span></a>.
3014
2991
</td>
3015
2992
</tr>
3016
 
</tbody>
3017
 
</table></div>
 
2993
<tr>
 
2994
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
2995
<td> TRUE on successful creation and attachment of
 
2996
the new parasite.
 
2997
 
 
2998
See Also: <a href="libgimp-gimpimage.html#gimp-image-parasite-attach"><code class="function">gimp_image_parasite_attach()</code></a>
 
2999
</td>
 
3000
</tr>
 
3001
</tbody>
 
3002
</table></div>
 
3003
</div>
 
3004
<hr>
 
3005
<div class="refsect2" lang="en">
 
3006
<a name="id2659404"></a><h3>
 
3007
<a name="gimp-image-add-vectors"></a>gimp_image_add_vectors ()</h3>
 
3008
<a class="indexterm" name="id2659417"></a><pre class="programlisting">gboolean            gimp_image_add_vectors              (gint32 image_ID,
 
3009
                                                         gint32 vectors_ID,
 
3010
                                                         gint position);</pre>
 
3011
<p>
 
3012
Add the specified vectors object to the image.
 
3013
</p>
 
3014
<p>
 
3015
This procedure adds the specified vectors object to the image at the
 
3016
given position. If the position is specified as -1, then the vectors
 
3017
object is inserted at the top of the vectors stack.</p>
 
3018
<p>
 
3019
 
 
3020
</p>
 
3021
<div class="variablelist"><table border="0">
 
3022
<col align="left" valign="top">
 
3023
<tbody>
 
3024
<tr>
 
3025
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
3026
<td> The image.
 
3027
</td>
 
3028
</tr>
 
3029
<tr>
 
3030
<td><span class="term"><em class="parameter"><code>vectors_ID</code></em>&#160;:</span></td>
 
3031
<td> The vectors object.
 
3032
</td>
 
3033
</tr>
 
3034
<tr>
 
3035
<td><span class="term"><em class="parameter"><code>position</code></em>&#160;:</span></td>
 
3036
<td> The vectors objects position.
 
3037
</td>
 
3038
</tr>
 
3039
<tr>
 
3040
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
3041
<td> TRUE on success.
 
3042
</td>
 
3043
</tr>
 
3044
</tbody>
 
3045
</table></div>
 
3046
</div>
 
3047
<hr>
 
3048
<div class="refsect2" lang="en">
 
3049
<a name="id2659529"></a><h3>
 
3050
<a name="gimp-image-remove-vectors"></a>gimp_image_remove_vectors ()</h3>
 
3051
<a class="indexterm" name="id2659546"></a><pre class="programlisting">gboolean            gimp_image_remove_vectors           (gint32 image_ID,
 
3052
                                                         gint32 vectors_ID);</pre>
 
3053
<p>
 
3054
Remove the specified path from the image.
 
3055
</p>
 
3056
<p>
 
3057
This procedure removes the specified path from the image. If the
 
3058
path doesn't exist, an error is returned.</p>
 
3059
<p>
 
3060
 
 
3061
</p>
 
3062
<div class="variablelist"><table border="0">
 
3063
<col align="left" valign="top">
 
3064
<tbody>
 
3065
<tr>
 
3066
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
3067
<td> The image.
 
3068
</td>
 
3069
</tr>
 
3070
<tr>
 
3071
<td><span class="term"><em class="parameter"><code>vectors_ID</code></em>&#160;:</span></td>
 
3072
<td> The vectors object.
 
3073
</td>
 
3074
</tr>
 
3075
<tr>
 
3076
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
3077
<td> TRUE on success.
 
3078
 
 
3079
</td>
 
3080
</tr>
 
3081
</tbody>
 
3082
</table></div>
 
3083
<p class="since">Since  GIMP 2.4
 
3084
</p>
 
3085
</div>
 
3086
<hr>
 
3087
<div class="refsect2" lang="en">
 
3088
<a name="id2659641"></a><h3>
 
3089
<a name="gimp-image-get-active-vectors"></a>gimp_image_get_active_vectors ()</h3>
 
3090
<a class="indexterm" name="id2659655"></a><pre class="programlisting">gint32              gimp_image_get_active_vectors       (gint32 image_ID);</pre>
 
3091
<p>
 
3092
Returns the specified image's active vectors.
 
3093
</p>
 
3094
<p>
 
3095
If there is an active path, its ID will be returned, otherwise, -1.</p>
 
3096
<p>
 
3097
 
 
3098
</p>
 
3099
<div class="variablelist"><table border="0">
 
3100
<col align="left" valign="top">
 
3101
<tbody>
 
3102
<tr>
 
3103
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
3104
<td> The image.
 
3105
</td>
 
3106
</tr>
 
3107
<tr>
 
3108
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
3109
<td> The active vectors.
 
3110
</td>
 
3111
</tr>
 
3112
</tbody>
 
3113
</table></div>
 
3114
</div>
 
3115
<hr>
 
3116
<div class="refsect2" lang="en">
 
3117
<a name="id2659722"></a><h3>
 
3118
<a name="gimp-image-set-active-vectors"></a>gimp_image_set_active_vectors ()</h3>
 
3119
<a class="indexterm" name="id2659736"></a><pre class="programlisting">gboolean            gimp_image_set_active_vectors       (gint32 image_ID,
 
3120
                                                         gint32 active_vectors_ID);</pre>
 
3121
<p>
 
3122
Sets the specified image's active vectors.
 
3123
</p>
 
3124
<p>
 
3125
If the path exists, it is set as the active path in the image.</p>
 
3126
<p>
 
3127
 
 
3128
</p>
 
3129
<div class="variablelist"><table border="0">
 
3130
<col align="left" valign="top">
 
3131
<tbody>
 
3132
<tr>
 
3133
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
3134
<td> The image.
 
3135
</td>
 
3136
</tr>
 
3137
<tr>
 
3138
<td><span class="term"><em class="parameter"><code>active_vectors_ID</code></em>&#160;:</span></td>
 
3139
<td> The new image active vectors.
 
3140
</td>
 
3141
</tr>
 
3142
<tr>
 
3143
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
3144
<td> TRUE on success.
 
3145
</td>
 
3146
</tr>
 
3147
</tbody>
 
3148
</table></div>
 
3149
</div>
 
3150
<hr>
 
3151
<div class="refsect2" lang="en">
 
3152
<a name="id2659824"></a><h3>
 
3153
<a name="gimp-image-lower-vectors"></a>gimp_image_lower_vectors ()</h3>
 
3154
<a class="indexterm" name="id2659840"></a><pre class="programlisting">gboolean            gimp_image_lower_vectors            (gint32 image_ID,
 
3155
                                                         gint32 vectors_ID);</pre>
 
3156
<p>
 
3157
Lower the specified vectors in the image's vectors stack
 
3158
</p>
 
3159
<p>
 
3160
This procedure lowers the specified vectors one step in the existing
 
3161
vectors stack. It will not move the vectors if there is no vectors
 
3162
below it.</p>
 
3163
<p>
 
3164
 
 
3165
</p>
 
3166
<div class="variablelist"><table border="0">
 
3167
<col align="left" valign="top">
 
3168
<tbody>
 
3169
<tr>
 
3170
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
3171
<td> The image.
 
3172
</td>
 
3173
</tr>
 
3174
<tr>
 
3175
<td><span class="term"><em class="parameter"><code>vectors_ID</code></em>&#160;:</span></td>
 
3176
<td> The vectors object to lower.
 
3177
</td>
 
3178
</tr>
 
3179
<tr>
 
3180
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
3181
<td> TRUE on success.
 
3182
 
 
3183
</td>
 
3184
</tr>
 
3185
</tbody>
 
3186
</table></div>
 
3187
<p class="since">Since  GIMP 2.4
 
3188
</p>
 
3189
</div>
 
3190
<hr>
 
3191
<div class="refsect2" lang="en">
 
3192
<a name="id2659937"></a><h3>
 
3193
<a name="gimp-image-raise-vectors"></a>gimp_image_raise_vectors ()</h3>
 
3194
<a class="indexterm" name="id2659953"></a><pre class="programlisting">gboolean            gimp_image_raise_vectors            (gint32 image_ID,
 
3195
                                                         gint32 vectors_ID);</pre>
 
3196
<p>
 
3197
Raise the specified vectors in the image's vectors stack
 
3198
</p>
 
3199
<p>
 
3200
This procedure raises the specified vectors one step in the existing
 
3201
vectors stack. It will not move the vectors if there is no vectors
 
3202
above it.</p>
 
3203
<p>
 
3204
 
 
3205
</p>
 
3206
<div class="variablelist"><table border="0">
 
3207
<col align="left" valign="top">
 
3208
<tbody>
 
3209
<tr>
 
3210
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
3211
<td> The image.
 
3212
</td>
 
3213
</tr>
 
3214
<tr>
 
3215
<td><span class="term"><em class="parameter"><code>vectors_ID</code></em>&#160;:</span></td>
 
3216
<td> The vectors object to raise.
 
3217
</td>
 
3218
</tr>
 
3219
<tr>
 
3220
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
3221
<td> TRUE on success.
 
3222
 
 
3223
</td>
 
3224
</tr>
 
3225
</tbody>
 
3226
</table></div>
 
3227
<p class="since">Since  GIMP 2.4
 
3228
</p>
 
3229
</div>
 
3230
<hr>
 
3231
<div class="refsect2" lang="en">
 
3232
<a name="id2660050"></a><h3>
 
3233
<a name="gimp-image-lower-vectors-to-bottom"></a>gimp_image_lower_vectors_to_bottom ()</h3>
 
3234
<a class="indexterm" name="id2660067"></a><pre class="programlisting">gboolean            gimp_image_lower_vectors_to_bottom  (gint32 image_ID,
 
3235
                                                         gint32 vectors_ID);</pre>
 
3236
<p>
 
3237
Lower the specified vectors in the image's vectors stack to bottom
 
3238
of stack
 
3239
</p>
 
3240
<p>
 
3241
This procedure lowers the specified vectors to bottom of the
 
3242
existing vectors stack. It will not move the vectors if there is no
 
3243
vectors below it.</p>
 
3244
<p>
 
3245
 
 
3246
</p>
 
3247
<div class="variablelist"><table border="0">
 
3248
<col align="left" valign="top">
 
3249
<tbody>
 
3250
<tr>
 
3251
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
3252
<td> The image.
 
3253
</td>
 
3254
</tr>
 
3255
<tr>
 
3256
<td><span class="term"><em class="parameter"><code>vectors_ID</code></em>&#160;:</span></td>
 
3257
<td> The vectors object to lower to bottom.
 
3258
</td>
 
3259
</tr>
 
3260
<tr>
 
3261
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
3262
<td> TRUE on success.
 
3263
 
 
3264
</td>
 
3265
</tr>
 
3266
</tbody>
 
3267
</table></div>
 
3268
<p class="since">Since  GIMP 2.4
 
3269
</p>
 
3270
</div>
 
3271
<hr>
 
3272
<div class="refsect2" lang="en">
 
3273
<a name="id2660164"></a><h3>
 
3274
<a name="gimp-image-raise-vectors-to-top"></a>gimp_image_raise_vectors_to_top ()</h3>
 
3275
<a class="indexterm" name="id2660180"></a><pre class="programlisting">gboolean            gimp_image_raise_vectors_to_top     (gint32 image_ID,
 
3276
                                                         gint32 vectors_ID);</pre>
 
3277
<p>
 
3278
Raise the specified vectors in the image's vectors stack to top of
 
3279
stack
 
3280
</p>
 
3281
<p>
 
3282
This procedure raises the specified vectors to top of the existing
 
3283
vectors stack. It will not move the vectors if there is no vectors
 
3284
above it.</p>
 
3285
<p>
 
3286
 
 
3287
</p>
 
3288
<div class="variablelist"><table border="0">
 
3289
<col align="left" valign="top">
 
3290
<tbody>
 
3291
<tr>
 
3292
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
3293
<td> The image.
 
3294
</td>
 
3295
</tr>
 
3296
<tr>
 
3297
<td><span class="term"><em class="parameter"><code>vectors_ID</code></em>&#160;:</span></td>
 
3298
<td> The vectors object to raise to top.
 
3299
</td>
 
3300
</tr>
 
3301
<tr>
 
3302
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
3303
<td> TRUE on success.
 
3304
 
 
3305
</td>
 
3306
</tr>
 
3307
</tbody>
 
3308
</table></div>
 
3309
<p class="since">Since  GIMP 2.4
 
3310
</p>
 
3311
</div>
 
3312
<hr>
 
3313
<div class="refsect2" lang="en">
 
3314
<a name="id2660278"></a><h3>
 
3315
<a name="gimp-image-get-vectors-position"></a>gimp_image_get_vectors_position ()</h3>
 
3316
<a class="indexterm" name="id2660294"></a><pre class="programlisting">gint                gimp_image_get_vectors_position     (gint32 image_ID,
 
3317
                                                         gint32 vectors_ID);</pre>
 
3318
<p>
 
3319
Returns the position of the vectors object in the vectors objects
 
3320
stack.
 
3321
</p>
 
3322
<p>
 
3323
This procedure determines the positioin of the specified vectors
 
3324
object in the images vectors object stack. If the vectors object
 
3325
doesn't exist in the image, an error is returned.</p>
 
3326
<p>
 
3327
 
 
3328
</p>
 
3329
<div class="variablelist"><table border="0">
 
3330
<col align="left" valign="top">
 
3331
<tbody>
 
3332
<tr>
 
3333
<td><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
 
3334
<td> The image.
 
3335
</td>
 
3336
</tr>
 
3337
<tr>
 
3338
<td><span class="term"><em class="parameter"><code>vectors_ID</code></em>&#160;:</span></td>
 
3339
<td> The vectors object.
 
3340
</td>
 
3341
</tr>
 
3342
<tr>
 
3343
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
3344
<td> The position of the vectors object in the vectors stack.
 
3345
 
 
3346
</td>
 
3347
</tr>
 
3348
</tbody>
 
3349
</table></div>
 
3350
<p class="since">Since  GIMP 2.4
 
3351
</p>
3018
3352
</div>
3019
3353
</div>
3020
3354
</div>