1
<?xml version="1.0" encoding="UTF-8" ?>
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
5
<refentry id="libgimp-gimpdrawable">
7
<refentrytitle>gimpdrawable</refentrytitle>
8
<manvolnum>3</manvolnum>
9
<refmiscinfo>LIBGIMP Library</refmiscinfo>
13
<refname>gimpdrawable</refname><refpurpose>Functions to manipulate drawables.</refpurpose>
16
<refsynopsisdiv><title>Synopsis</title>
22
<link linkend="GimpDrawable">GimpDrawable</link>;
23
<link linkend="GimpDrawable">GimpDrawable</link>* <link linkend="gimp-drawable-get">gimp_drawable_get</link> (<link linkend="gint32">gint32</link> drawable_ID);
24
<link linkend="void">void</link> <link linkend="gimp-drawable-detach">gimp_drawable_detach</link> (<link linkend="GimpDrawable">GimpDrawable</link> *drawable);
25
<link linkend="void">void</link> <link linkend="gimp-drawable-flush">gimp_drawable_flush</link> (<link linkend="GimpDrawable">GimpDrawable</link> *drawable);
26
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-delete">gimp_drawable_delete</link> (<link linkend="gint32">gint32</link> drawable_ID);
27
<link linkend="gchar">gchar</link>* <link linkend="gimp-drawable-get-name">gimp_drawable_get_name</link> (<link linkend="gint32">gint32</link> drawable_ID);
28
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-set-name">gimp_drawable_set_name</link> (<link linkend="gint32">gint32</link> drawable_ID,
29
const <link linkend="gchar">gchar</link> *name);
30
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-get-visible">gimp_drawable_get_visible</link> (<link linkend="gint32">gint32</link> drawable_ID);
31
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-set-visible">gimp_drawable_set_visible</link> (<link linkend="gint32">gint32</link> drawable_ID,
32
<link linkend="gboolean">gboolean</link> visible);
33
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-get-linked">gimp_drawable_get_linked</link> (<link linkend="gint32">gint32</link> drawable_ID);
34
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-set-linked">gimp_drawable_set_linked</link> (<link linkend="gint32">gint32</link> drawable_ID,
35
<link linkend="gboolean">gboolean</link> linked);
36
<link linkend="gint">gint</link> <link linkend="gimp-drawable-get-tattoo">gimp_drawable_get_tattoo</link> (<link linkend="gint32">gint32</link> drawable_ID);
37
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-set-tattoo">gimp_drawable_set_tattoo</link> (<link linkend="gint32">gint32</link> drawable_ID,
38
<link linkend="gint">gint</link> tattoo);
39
<link linkend="guint8">guint8</link>* <link linkend="gimp-drawable-get-pixel">gimp_drawable_get_pixel</link> (<link linkend="gint32">gint32</link> drawable_ID,
40
<link linkend="gint">gint</link> x_coord,
41
<link linkend="gint">gint</link> y_coord,
42
<link linkend="gint">gint</link> *num_channels);
43
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-set-pixel">gimp_drawable_set_pixel</link> (<link linkend="gint32">gint32</link> drawable_ID,
44
<link linkend="gint">gint</link> x_coord,
45
<link linkend="gint">gint</link> y_coord,
46
<link linkend="gint">gint</link> num_channels,
47
const <link linkend="guint8">guint8</link> *pixel);
48
<link linkend="GimpTile">GimpTile</link>* <link linkend="gimp-drawable-get-tile">gimp_drawable_get_tile</link> (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
49
<link linkend="gboolean">gboolean</link> shadow,
50
<link linkend="gint">gint</link> row,
51
<link linkend="gint">gint</link> col);
52
<link linkend="GimpTile">GimpTile</link>* <link linkend="gimp-drawable-get-tile2">gimp_drawable_get_tile2</link> (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
53
<link linkend="gboolean">gboolean</link> shadow,
54
<link linkend="gint">gint</link> x,
55
<link linkend="gint">gint</link> y);
56
<link linkend="guchar">guchar</link>* <link linkend="gimp-drawable-get-thumbnail-data">gimp_drawable_get_thumbnail_data</link>
57
(<link linkend="gint32">gint32</link> drawable_ID,
58
<link linkend="gint">gint</link> *width,
59
<link linkend="gint">gint</link> *height,
60
<link linkend="gint">gint</link> *bpp);
61
<link linkend="guchar">guchar</link>* <link linkend="gimp-drawable-get-sub-thumbnail-data">gimp_drawable_get_sub_thumbnail_data</link>
62
(<link linkend="gint32">gint32</link> drawable_ID,
63
<link linkend="gint">gint</link> src_x,
64
<link linkend="gint">gint</link> src_y,
65
<link linkend="gint">gint</link> src_width,
66
<link linkend="gint">gint</link> src_height,
67
<link linkend="gint">gint</link> *dest_width,
68
<link linkend="gint">gint</link> *dest_height,
69
<link linkend="gint">gint</link> *bpp);
70
<link linkend="void">void</link> <link linkend="gimp-drawable-get-color-uchar">gimp_drawable_get_color_uchar</link> (<link linkend="gint32">gint32</link> drawable_ID,
71
const <link linkend="GimpRGB">GimpRGB</link> *color,
72
<link linkend="guchar">guchar</link> *color_uchar);
73
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-merge-shadow">gimp_drawable_merge_shadow</link> (<link linkend="gint32">gint32</link> drawable_ID,
74
<link linkend="gboolean">gboolean</link> undo);
75
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-fill">gimp_drawable_fill</link> (<link linkend="gint32">gint32</link> drawable_ID,
76
<link linkend="GimpFillType">GimpFillType</link> fill_type);
77
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-update">gimp_drawable_update</link> (<link linkend="gint32">gint32</link> drawable_ID,
78
<link linkend="gint">gint</link> x,
79
<link linkend="gint">gint</link> y,
80
<link linkend="gint">gint</link> width,
81
<link linkend="gint">gint</link> height);
82
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-mask-bounds">gimp_drawable_mask_bounds</link> (<link linkend="gint32">gint32</link> drawable_ID,
83
<link linkend="gint">gint</link> *x1,
84
<link linkend="gint">gint</link> *y1,
85
<link linkend="gint">gint</link> *x2,
86
<link linkend="gint">gint</link> *y2);
87
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-mask-intersect">gimp_drawable_mask_intersect</link> (<link linkend="gint32">gint32</link> drawable_ID,
88
<link linkend="gint">gint</link> *x,
89
<link linkend="gint">gint</link> *y,
90
<link linkend="gint">gint</link> *width,
91
<link linkend="gint">gint</link> *height);
92
<link linkend="gint32">gint32</link> <link linkend="gimp-drawable-get-image">gimp_drawable_get_image</link> (<link linkend="gint32">gint32</link> drawable_ID);
93
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-set-image">gimp_drawable_set_image</link> (<link linkend="gint32">gint32</link> drawable_ID,
94
<link linkend="gint32">gint32</link> image_ID);
95
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-has-alpha">gimp_drawable_has_alpha</link> (<link linkend="gint32">gint32</link> drawable_ID);
96
<link linkend="GimpImageType">GimpImageType</link> <link linkend="gimp-drawable-type-with-alpha">gimp_drawable_type_with_alpha</link> (<link linkend="gint32">gint32</link> drawable_ID);
97
<link linkend="GimpImageType">GimpImageType</link> <link linkend="gimp-drawable-type">gimp_drawable_type</link> (<link linkend="gint32">gint32</link> drawable_ID);
98
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-is-rgb">gimp_drawable_is_rgb</link> (<link linkend="gint32">gint32</link> drawable_ID);
99
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-is-gray">gimp_drawable_is_gray</link> (<link linkend="gint32">gint32</link> drawable_ID);
100
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-is-indexed">gimp_drawable_is_indexed</link> (<link linkend="gint32">gint32</link> drawable_ID);
101
<link linkend="gint">gint</link> <link linkend="gimp-drawable-bpp">gimp_drawable_bpp</link> (<link linkend="gint32">gint32</link> drawable_ID);
102
<link linkend="gint">gint</link> <link linkend="gimp-drawable-width">gimp_drawable_width</link> (<link linkend="gint32">gint32</link> drawable_ID);
103
<link linkend="gint">gint</link> <link linkend="gimp-drawable-height">gimp_drawable_height</link> (<link linkend="gint32">gint32</link> drawable_ID);
104
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-offsets">gimp_drawable_offsets</link> (<link linkend="gint32">gint32</link> drawable_ID,
105
<link linkend="gint">gint</link> *offset_x,
106
<link linkend="gint">gint</link> *offset_y);
107
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-is-layer">gimp_drawable_is_layer</link> (<link linkend="gint32">gint32</link> drawable_ID);
108
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-is-layer-mask">gimp_drawable_is_layer_mask</link> (<link linkend="gint32">gint32</link> drawable_ID);
109
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-is-channel">gimp_drawable_is_channel</link> (<link linkend="gint32">gint32</link> drawable_ID);
110
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-offset">gimp_drawable_offset</link> (<link linkend="gint32">gint32</link> drawable_ID,
111
<link linkend="gboolean">gboolean</link> wrap_around,
112
<link linkend="GimpOffsetType">GimpOffsetType</link> fill_type,
113
<link linkend="gint">gint</link> offset_x,
114
<link linkend="gint">gint</link> offset_y);
115
<link linkend="GimpParasite">GimpParasite</link>* <link linkend="gimp-drawable-parasite-find">gimp_drawable_parasite_find</link> (<link linkend="gint32">gint32</link> drawable_ID,
116
const <link linkend="gchar">gchar</link> *name);
117
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-parasite-list">gimp_drawable_parasite_list</link> (<link linkend="gint32">gint32</link> drawable_ID,
118
<link linkend="gint">gint</link> *num_parasites,
119
<link linkend="gchar">gchar</link> ***parasites);
120
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-parasite-attach">gimp_drawable_parasite_attach</link> (<link linkend="gint32">gint32</link> drawable_ID,
121
<link linkend="GimpParasite">GimpParasite</link> *parasite);
122
<link linkend="gboolean">gboolean</link> <link linkend="gimp-drawable-parasite-detach">gimp_drawable_parasite_detach</link> (<link linkend="gint32">gint32</link> drawable_ID,
123
const <link linkend="gchar">gchar</link> *name);
124
<link linkend="void">void</link> <link linkend="gimp-drawable-attach-new-parasite">gimp_drawable_attach_new_parasite</link>
125
(<link linkend="gint32">gint32</link> drawable_ID,
126
const <link linkend="gchar">gchar</link> *name,
127
<link linkend="gint">gint</link> flags,
128
<link linkend="gint">gint</link> size,
129
<link linkend="gconstpointer">gconstpointer</link> data);
142
<title>Description</title>
144
Functions to manipulate drawables.
150
<title>Details</title>
152
<title><anchor id="GimpDrawable"/>GimpDrawable</title>
153
<indexterm><primary>GimpDrawable</primary></indexterm><programlisting>typedef struct {
154
gint32 drawable_id; /* drawable ID */
155
guint width; /* width of drawble */
156
guint height; /* height of drawble */
157
guint bpp; /* bytes per pixel of drawable */
158
guint ntile_rows; /* # of tile rows */
159
guint ntile_cols; /* # of tile columns */
160
GimpTile *tiles; /* the normal tiles */
161
GimpTile *shadow_tiles; /* the shadow tiles */
168
<title><anchor id="gimp-drawable-get"/>gimp_drawable_get ()</title>
169
<indexterm><primary>gimp_drawable_get</primary></indexterm><programlisting><link linkend="GimpDrawable">GimpDrawable</link>* gimp_drawable_get (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
171
This function creates a <link linkend="GimpDrawable"><type>GimpDrawable</type></link> structure for the core
172
drawable identified by <parameter>drawable_ID</parameter>. The returned structure
173
contains some basic information about the drawable and can also
174
hold tile data for transfer to and from the core.
177
Note that the name of this function is somewhat misleading, because
178
it suggests that it simply returns a handle. This is not the case:
179
if the function is called multiple times, it creates separate tile
180
lists each time, which will usually produce undesired results.
183
When a plug-in has finished working with a drawable, before exiting
184
it should call <link linkend="gimp-drawable-detach"><function>gimp_drawable_detach()</function></link> to make sure that all tile data is
185
transferred back to the core.</para>
188
</para><variablelist role="params">
189
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
190
<listitem><simpara> the ID of the drawable
191
</simpara></listitem></varlistentry>
192
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpDrawable"><type>GimpDrawable</type></link> wrapper
193
</simpara></listitem></varlistentry>
194
</variablelist></refsect2>
196
<title><anchor id="gimp-drawable-detach"/>gimp_drawable_detach ()</title>
197
<indexterm><primary>gimp_drawable_detach</primary></indexterm><programlisting><link linkend="void">void</link> gimp_drawable_detach (<link linkend="GimpDrawable">GimpDrawable</link> *drawable);</programlisting>
199
This function is called when a plug-in is finished working
200
with a drawable. It forces all tile data held in the tile
201
list of the <link linkend="GimpDrawable"><type>GimpDrawable</type></link> to be transferred to the core, and
202
then frees all associated memory. You must not access the
203
<parameter>drawable</parameter> after having called <link linkend="gimp-drawable-detach"><function>gimp_drawable_detach()</function></link>.</para>
206
</para><variablelist role="params">
207
<varlistentry><term><parameter>drawable</parameter> :</term>
208
<listitem><simpara> The <link linkend="GimpDrawable"><type>GimpDrawable</type></link> to detach from the core
209
</simpara></listitem></varlistentry>
210
</variablelist></refsect2>
212
<title><anchor id="gimp-drawable-flush"/>gimp_drawable_flush ()</title>
213
<indexterm><primary>gimp_drawable_flush</primary></indexterm><programlisting><link linkend="void">void</link> gimp_drawable_flush (<link linkend="GimpDrawable">GimpDrawable</link> *drawable);</programlisting>
215
This function causes all tile data in the tile list of <parameter>drawable</parameter> to be
216
transferred to the core. It is usually called in situations where a
217
plug-in acts on a drawable, and then needs to read the results of its
218
actions. Data transferred back from the core will not generally be valid
219
unless <link linkend="gimp-drawable-flush"><function>gimp_drawable_flush()</function></link> has been called beforehand.</para>
222
</para><variablelist role="params">
223
<varlistentry><term><parameter>drawable</parameter> :</term>
224
<listitem><simpara> The <link linkend="GimpDrawable"><type>GimpDrawable</type></link> whose tile data is to be transferred
226
</simpara></listitem></varlistentry>
227
</variablelist></refsect2>
229
<title><anchor id="gimp-drawable-delete"/>gimp_drawable_delete ()</title>
230
<indexterm><primary>gimp_drawable_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_delete (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
235
This procedure deletes the specified drawable. This must not be done
236
if the gimage containing this drawable was already deleted or if the
237
drawable was already removed from the image. The only case in which
238
this procedure is useful is if you want to get rid of a drawable
239
which has not yet been added to an image.</para>
242
</para><variablelist role="params">
243
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
244
<listitem><simpara> The drawable to delete.
245
</simpara></listitem></varlistentry>
246
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
247
</simpara></listitem></varlistentry>
248
</variablelist></refsect2>
250
<title><anchor id="gimp-drawable-get-name"/>gimp_drawable_get_name ()</title>
251
<indexterm><primary>gimp_drawable_get_name</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_drawable_get_name (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
253
Get the name of the specified drawable.
256
This procedure returns the specified drawable's name.</para>
259
</para><variablelist role="params">
260
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
261
<listitem><simpara> The drawable.
262
</simpara></listitem></varlistentry>
263
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The drawable name.
264
</simpara></listitem></varlistentry>
265
</variablelist></refsect2>
267
<title><anchor id="gimp-drawable-set-name"/>gimp_drawable_set_name ()</title>
268
<indexterm><primary>gimp_drawable_set_name</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_set_name (<link linkend="gint32">gint32</link> drawable_ID,
269
const <link linkend="gchar">gchar</link> *name);</programlisting>
271
Set the name of the specified drawable.
274
This procedure sets the specified drawable's name.</para>
277
</para><variablelist role="params">
278
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
279
<listitem><simpara> The drawable.
280
</simpara></listitem></varlistentry>
281
<varlistentry><term><parameter>name</parameter> :</term>
282
<listitem><simpara> The new drawable name.
283
</simpara></listitem></varlistentry>
284
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
285
</simpara></listitem></varlistentry>
286
</variablelist></refsect2>
288
<title><anchor id="gimp-drawable-get-visible"/>gimp_drawable_get_visible ()</title>
289
<indexterm><primary>gimp_drawable_get_visible</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_get_visible (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
291
Get the visibility of the specified drawable.
294
This procedure returns the specified drawable's visibility.</para>
297
</para><variablelist role="params">
298
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
299
<listitem><simpara> The drawable.
300
</simpara></listitem></varlistentry>
301
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The drawable visibility.
302
</simpara></listitem></varlistentry>
303
</variablelist></refsect2>
305
<title><anchor id="gimp-drawable-set-visible"/>gimp_drawable_set_visible ()</title>
306
<indexterm><primary>gimp_drawable_set_visible</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_set_visible (<link linkend="gint32">gint32</link> drawable_ID,
307
<link linkend="gboolean">gboolean</link> visible);</programlisting>
309
Set the visibility of the specified drawable.
312
This procedure sets the specified drawable's visibility.</para>
315
</para><variablelist role="params">
316
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
317
<listitem><simpara> The drawable.
318
</simpara></listitem></varlistentry>
319
<varlistentry><term><parameter>visible</parameter> :</term>
320
<listitem><simpara> The new drawable visibility.
321
</simpara></listitem></varlistentry>
322
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
323
</simpara></listitem></varlistentry>
324
</variablelist></refsect2>
326
<title><anchor id="gimp-drawable-get-linked"/>gimp_drawable_get_linked ()</title>
327
<indexterm><primary>gimp_drawable_get_linked</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_get_linked (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
329
Get the linked state of the specified drawable.
332
This procedure returns the specified drawable's linked state.</para>
335
</para><variablelist role="params">
336
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
337
<listitem><simpara> The drawable.
338
</simpara></listitem></varlistentry>
339
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The drawable linked state (for moves).
340
</simpara></listitem></varlistentry>
341
</variablelist></refsect2>
343
<title><anchor id="gimp-drawable-set-linked"/>gimp_drawable_set_linked ()</title>
344
<indexterm><primary>gimp_drawable_set_linked</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_set_linked (<link linkend="gint32">gint32</link> drawable_ID,
345
<link linkend="gboolean">gboolean</link> linked);</programlisting>
347
Set the linked state of the specified drawable.
350
This procedure sets the specified drawable's linked state.</para>
353
</para><variablelist role="params">
354
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
355
<listitem><simpara> The drawable.
356
</simpara></listitem></varlistentry>
357
<varlistentry><term><parameter>linked</parameter> :</term>
358
<listitem><simpara> The new drawable linked state.
359
</simpara></listitem></varlistentry>
360
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
361
</simpara></listitem></varlistentry>
362
</variablelist></refsect2>
364
<title><anchor id="gimp-drawable-get-tattoo"/>gimp_drawable_get_tattoo ()</title>
365
<indexterm><primary>gimp_drawable_get_tattoo</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_drawable_get_tattoo (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
367
Get the tattoo of the specified drawable.
370
This procedure returns the specified drawable's tattoo. A tattoo is
371
a unique and permanent identifier attached to a drawable that can be
372
used to uniquely identify a drawable within an image even between
376
</para><variablelist role="params">
377
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
378
<listitem><simpara> The drawable.
379
</simpara></listitem></varlistentry>
380
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The drawable tattoo.
381
</simpara></listitem></varlistentry>
382
</variablelist></refsect2>
384
<title><anchor id="gimp-drawable-set-tattoo"/>gimp_drawable_set_tattoo ()</title>
385
<indexterm><primary>gimp_drawable_set_tattoo</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_set_tattoo (<link linkend="gint32">gint32</link> drawable_ID,
386
<link linkend="gint">gint</link> tattoo);</programlisting>
388
Set the tattoo of the specified drawable.
391
This procedure sets the specified drawable's tattoo. A tattoo is a
392
unique and permanent identifier attached to a drawable that can be
393
used to uniquely identify a drawable within an image even between
397
</para><variablelist role="params">
398
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
399
<listitem><simpara> The drawable.
400
</simpara></listitem></varlistentry>
401
<varlistentry><term><parameter>tattoo</parameter> :</term>
402
<listitem><simpara> The new drawable tattoo.
403
</simpara></listitem></varlistentry>
404
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
405
</simpara></listitem></varlistentry>
406
</variablelist></refsect2>
408
<title><anchor id="gimp-drawable-get-pixel"/>gimp_drawable_get_pixel ()</title>
409
<indexterm><primary>gimp_drawable_get_pixel</primary></indexterm><programlisting><link linkend="guint8">guint8</link>* gimp_drawable_get_pixel (<link linkend="gint32">gint32</link> drawable_ID,
410
<link linkend="gint">gint</link> x_coord,
411
<link linkend="gint">gint</link> y_coord,
412
<link linkend="gint">gint</link> *num_channels);</programlisting>
414
Gets the value of the pixel at the specified coordinates.
417
This procedure gets the pixel value at the specified coordinates.
418
The 'num_channels' argument must always be equal to the
419
bytes-per-pixel value for the specified drawable.</para>
422
</para><variablelist role="params">
423
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
424
<listitem><simpara> The drawable.
425
</simpara></listitem></varlistentry>
426
<varlistentry><term><parameter>x_coord</parameter> :</term>
427
<listitem><simpara> The x coordinate.
428
</simpara></listitem></varlistentry>
429
<varlistentry><term><parameter>y_coord</parameter> :</term>
430
<listitem><simpara> The y coordinate.
431
</simpara></listitem></varlistentry>
432
<varlistentry><term><parameter>num_channels</parameter> :</term>
433
<listitem><simpara> The number of channels for the pixel.
434
</simpara></listitem></varlistentry>
435
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The pixel value.
436
</simpara></listitem></varlistentry>
437
</variablelist></refsect2>
439
<title><anchor id="gimp-drawable-set-pixel"/>gimp_drawable_set_pixel ()</title>
440
<indexterm><primary>gimp_drawable_set_pixel</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_set_pixel (<link linkend="gint32">gint32</link> drawable_ID,
441
<link linkend="gint">gint</link> x_coord,
442
<link linkend="gint">gint</link> y_coord,
443
<link linkend="gint">gint</link> num_channels,
444
const <link linkend="guint8">guint8</link> *pixel);</programlisting>
446
Sets the value of the pixel at the specified coordinates.
449
This procedure sets the pixel value at the specified coordinates.
450
The 'num_channels' argument must always be equal to the
451
bytes-per-pixel value for the spec ified drawable. Note that this
452
function is not undoable, you should use it only on drawables you
453
just created yourself.</para>
456
</para><variablelist role="params">
457
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
458
<listitem><simpara> The drawable.
459
</simpara></listitem></varlistentry>
460
<varlistentry><term><parameter>x_coord</parameter> :</term>
461
<listitem><simpara> The x coordinate.
462
</simpara></listitem></varlistentry>
463
<varlistentry><term><parameter>y_coord</parameter> :</term>
464
<listitem><simpara> The y coordinate.
465
</simpara></listitem></varlistentry>
466
<varlistentry><term><parameter>num_channels</parameter> :</term>
467
<listitem><simpara> The number of channels for the pixel.
468
</simpara></listitem></varlistentry>
469
<varlistentry><term><parameter>pixel</parameter> :</term>
470
<listitem><simpara> The pixel value.
471
</simpara></listitem></varlistentry>
472
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
473
</simpara></listitem></varlistentry>
474
</variablelist></refsect2>
476
<title><anchor id="gimp-drawable-get-tile"/>gimp_drawable_get_tile ()</title>
477
<indexterm><primary>gimp_drawable_get_tile</primary></indexterm><programlisting><link linkend="GimpTile">GimpTile</link>* gimp_drawable_get_tile (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
478
<link linkend="gboolean">gboolean</link> shadow,
479
<link linkend="gint">gint</link> row,
480
<link linkend="gint">gint</link> col);</programlisting>
483
</para><variablelist role="params">
484
<varlistentry><term><parameter>drawable</parameter> :</term>
486
</simpara></listitem></varlistentry>
487
<varlistentry><term><parameter>shadow</parameter> :</term>
489
</simpara></listitem></varlistentry>
490
<varlistentry><term><parameter>row</parameter> :</term>
492
</simpara></listitem></varlistentry>
493
<varlistentry><term><parameter>col</parameter> :</term>
495
</simpara></listitem></varlistentry>
496
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
499
</simpara></listitem></varlistentry>
500
</variablelist></refsect2>
502
<title><anchor id="gimp-drawable-get-tile2"/>gimp_drawable_get_tile2 ()</title>
503
<indexterm><primary>gimp_drawable_get_tile2</primary></indexterm><programlisting><link linkend="GimpTile">GimpTile</link>* gimp_drawable_get_tile2 (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
504
<link linkend="gboolean">gboolean</link> shadow,
505
<link linkend="gint">gint</link> x,
506
<link linkend="gint">gint</link> y);</programlisting>
509
</para><variablelist role="params">
510
<varlistentry><term><parameter>drawable</parameter> :</term>
512
</simpara></listitem></varlistentry>
513
<varlistentry><term><parameter>shadow</parameter> :</term>
515
</simpara></listitem></varlistentry>
516
<varlistentry><term><parameter>x</parameter> :</term>
518
</simpara></listitem></varlistentry>
519
<varlistentry><term><parameter>y</parameter> :</term>
521
</simpara></listitem></varlistentry>
522
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
525
</simpara></listitem></varlistentry>
526
</variablelist></refsect2>
528
<title><anchor id="gimp-drawable-get-thumbnail-data"/>gimp_drawable_get_thumbnail_data ()</title>
529
<indexterm><primary>gimp_drawable_get_thumbnail_data</primary></indexterm><programlisting><link linkend="guchar">guchar</link>* gimp_drawable_get_thumbnail_data
530
(<link linkend="gint32">gint32</link> drawable_ID,
531
<link linkend="gint">gint</link> *width,
532
<link linkend="gint">gint</link> *height,
533
<link linkend="gint">gint</link> *bpp);</programlisting>
536
</para><variablelist role="params">
537
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
539
</simpara></listitem></varlistentry>
540
<varlistentry><term><parameter>width</parameter> :</term>
542
</simpara></listitem></varlistentry>
543
<varlistentry><term><parameter>height</parameter> :</term>
545
</simpara></listitem></varlistentry>
546
<varlistentry><term><parameter>bpp</parameter> :</term>
548
</simpara></listitem></varlistentry>
549
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
552
</simpara></listitem></varlistentry>
553
</variablelist></refsect2>
555
<title><anchor id="gimp-drawable-get-sub-thumbnail-data"/>gimp_drawable_get_sub_thumbnail_data ()</title>
556
<indexterm><primary>gimp_drawable_get_sub_thumbnail_data</primary></indexterm><programlisting><link linkend="guchar">guchar</link>* gimp_drawable_get_sub_thumbnail_data
557
(<link linkend="gint32">gint32</link> drawable_ID,
558
<link linkend="gint">gint</link> src_x,
559
<link linkend="gint">gint</link> src_y,
560
<link linkend="gint">gint</link> src_width,
561
<link linkend="gint">gint</link> src_height,
562
<link linkend="gint">gint</link> *dest_width,
563
<link linkend="gint">gint</link> *dest_height,
564
<link linkend="gint">gint</link> *bpp);</programlisting>
567
</para><variablelist role="params">
568
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
570
</simpara></listitem></varlistentry>
571
<varlistentry><term><parameter>src_x</parameter> :</term>
573
</simpara></listitem></varlistentry>
574
<varlistentry><term><parameter>src_y</parameter> :</term>
576
</simpara></listitem></varlistentry>
577
<varlistentry><term><parameter>src_width</parameter> :</term>
579
</simpara></listitem></varlistentry>
580
<varlistentry><term><parameter>src_height</parameter> :</term>
582
</simpara></listitem></varlistentry>
583
<varlistentry><term><parameter>dest_width</parameter> :</term>
585
</simpara></listitem></varlistentry>
586
<varlistentry><term><parameter>dest_height</parameter> :</term>
588
</simpara></listitem></varlistentry>
589
<varlistentry><term><parameter>bpp</parameter> :</term>
591
</simpara></listitem></varlistentry>
592
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
595
</simpara></listitem></varlistentry>
596
</variablelist></refsect2>
598
<title><anchor id="gimp-drawable-get-color-uchar"/>gimp_drawable_get_color_uchar ()</title>
599
<indexterm><primary>gimp_drawable_get_color_uchar</primary></indexterm><programlisting><link linkend="void">void</link> gimp_drawable_get_color_uchar (<link linkend="gint32">gint32</link> drawable_ID,
600
const <link linkend="GimpRGB">GimpRGB</link> *color,
601
<link linkend="guchar">guchar</link> *color_uchar);</programlisting>
604
</para><variablelist role="params">
605
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
607
</simpara></listitem></varlistentry>
608
<varlistentry><term><parameter>color</parameter> :</term>
610
</simpara></listitem></varlistentry>
611
<varlistentry><term><parameter>color_uchar</parameter> :</term>
615
</simpara></listitem></varlistentry>
616
</variablelist></refsect2>
618
<title><anchor id="gimp-drawable-merge-shadow"/>gimp_drawable_merge_shadow ()</title>
619
<indexterm><primary>gimp_drawable_merge_shadow</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_merge_shadow (<link linkend="gint32">gint32</link> drawable_ID,
620
<link linkend="gboolean">gboolean</link> undo);</programlisting>
622
Merge the shadow buffer with the specified drawable.
625
This procedure combines the contents of the image's shadow buffer
626
(for temporary processing) with the specified drawable. The \"undo\"
627
parameter specifies whether to add an undo step for the operation.
628
Requesting no undo is useful for such applications as 'auto-apply'.</para>
631
</para><variablelist role="params">
632
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
633
<listitem><simpara> The drawable.
634
</simpara></listitem></varlistentry>
635
<varlistentry><term><parameter>undo</parameter> :</term>
636
<listitem><simpara> Push merge to undo stack?
637
</simpara></listitem></varlistentry>
638
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
639
</simpara></listitem></varlistentry>
640
</variablelist></refsect2>
642
<title><anchor id="gimp-drawable-fill"/>gimp_drawable_fill ()</title>
643
<indexterm><primary>gimp_drawable_fill</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_fill (<link linkend="gint32">gint32</link> drawable_ID,
644
<link linkend="GimpFillType">GimpFillType</link> fill_type);</programlisting>
646
Fill the drawable with the specified fill mode.
649
This procedure fills the drawable with the fill mode. If the fill
650
mode is foreground the current foreground color is used. If the fill
651
mode is background, the current background color is used. If the
652
fill type is white, then white is used. Transparent fill only
653
affects layers with an alpha channel, in which case the alpha
654
channel is set to transparent. If the drawable has no alpha channel,
655
it is filled to white. No fill leaves the drawable's contents
656
undefined. This procedure is unlike the bucket fill tool because it
657
fills regardless of a selection</para>
660
</para><variablelist role="params">
661
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
662
<listitem><simpara> The drawable.
663
</simpara></listitem></varlistentry>
664
<varlistentry><term><parameter>fill_type</parameter> :</term>
665
<listitem><simpara> The type of fill.
666
</simpara></listitem></varlistentry>
667
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
668
</simpara></listitem></varlistentry>
669
</variablelist></refsect2>
671
<title><anchor id="gimp-drawable-update"/>gimp_drawable_update ()</title>
672
<indexterm><primary>gimp_drawable_update</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_update (<link linkend="gint32">gint32</link> drawable_ID,
673
<link linkend="gint">gint</link> x,
674
<link linkend="gint">gint</link> y,
675
<link linkend="gint">gint</link> width,
676
<link linkend="gint">gint</link> height);</programlisting>
678
Update the specified region of the drawable.
681
This procedure updates the specified region of the drawable. The (x,
682
y) coordinate pair is relative to the drawable's origin, not to the
683
image origin. Therefore, the entire drawable can be updated using
684
(0, 0, width, height).</para>
687
</para><variablelist role="params">
688
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
689
<listitem><simpara> The drawable.
690
</simpara></listitem></varlistentry>
691
<varlistentry><term><parameter>x</parameter> :</term>
692
<listitem><simpara> x coordinate of upper left corner of update region.
693
</simpara></listitem></varlistentry>
694
<varlistentry><term><parameter>y</parameter> :</term>
695
<listitem><simpara> y coordinate of upper left corner of update region.
696
</simpara></listitem></varlistentry>
697
<varlistentry><term><parameter>width</parameter> :</term>
698
<listitem><simpara> Width of update region.
699
</simpara></listitem></varlistentry>
700
<varlistentry><term><parameter>height</parameter> :</term>
701
<listitem><simpara> Height of update region.
702
</simpara></listitem></varlistentry>
703
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
704
</simpara></listitem></varlistentry>
705
</variablelist></refsect2>
707
<title><anchor id="gimp-drawable-mask-bounds"/>gimp_drawable_mask_bounds ()</title>
708
<indexterm><primary>gimp_drawable_mask_bounds</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_mask_bounds (<link linkend="gint32">gint32</link> drawable_ID,
709
<link linkend="gint">gint</link> *x1,
710
<link linkend="gint">gint</link> *y1,
711
<link linkend="gint">gint</link> *x2,
712
<link linkend="gint">gint</link> *y2);</programlisting>
714
Find the bounding box of the current selection in relation to the
718
This procedure returns whether there is a selection. If there is
719
one, the upper left and lower righthand corners of its bounding box
720
are returned. These coordinates are specified relative to the
721
drawable's origin, and bounded by the drawable's extents. Please
722
note that the pixel specified by the lower righthand coordinate of
723
the bounding box is not part of the selection. The selection ends at
724
the upper left corner of this pixel. This means the width of the
725
selection can be calculated as (x2 - x1), its height as (y2 - y1).
726
Note that the returned boolean does NOT correspond with the returned
727
region being empty or not, it always returns whether the selection
728
is non_empty. See <link linkend="gimp-drawable-mask-intersect"><function>gimp_drawable_mask_intersect()</function></link> for a boolean
729
return value which is more useful in most cases.</para>
732
</para><variablelist role="params">
733
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
734
<listitem><simpara> The drawable.
735
</simpara></listitem></varlistentry>
736
<varlistentry><term><parameter>x1</parameter> :</term>
737
<listitem><simpara> x coordinate of the upper left corner of selection bounds.
738
</simpara></listitem></varlistentry>
739
<varlistentry><term><parameter>y1</parameter> :</term>
740
<listitem><simpara> y coordinate of the upper left corner of selection bounds.
741
</simpara></listitem></varlistentry>
742
<varlistentry><term><parameter>x2</parameter> :</term>
743
<listitem><simpara> x coordinate of the lower right corner of selection bounds.
744
</simpara></listitem></varlistentry>
745
<varlistentry><term><parameter>y2</parameter> :</term>
746
<listitem><simpara> y coordinate of the lower right corner of selection bounds.
747
</simpara></listitem></varlistentry>
748
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if there is a selection.
749
</simpara></listitem></varlistentry>
750
</variablelist></refsect2>
752
<title><anchor id="gimp-drawable-mask-intersect"/>gimp_drawable_mask_intersect ()</title>
753
<indexterm role="GIMP 2.2"><primary>gimp_drawable_mask_intersect</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_mask_intersect (<link linkend="gint32">gint32</link> drawable_ID,
754
<link linkend="gint">gint</link> *x,
755
<link linkend="gint">gint</link> *y,
756
<link linkend="gint">gint</link> *width,
757
<link linkend="gint">gint</link> *height);</programlisting>
759
Find the bounding box of the current selection in relation to the
763
This procedure returns whether there is an intersection between the
764
drawable and the selection. Unlike <link linkend="gimp-drawable-mask-bounds"><function>gimp_drawable_mask_bounds()</function></link>, the
765
intersection's bounds are returned as x, y, width, height. If there
766
is no selection this function returns TRUE and the returned bounds
767
are the extents of the whole drawable.</para>
770
</para><variablelist role="params">
771
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
772
<listitem><simpara> The drawable.
773
</simpara></listitem></varlistentry>
774
<varlistentry><term><parameter>x</parameter> :</term>
775
<listitem><simpara> x coordinate of the upper left corner of the intersection.
776
</simpara></listitem></varlistentry>
777
<varlistentry><term><parameter>y</parameter> :</term>
778
<listitem><simpara> y coordinate of the upper left corner of the intersection.
779
</simpara></listitem></varlistentry>
780
<varlistentry><term><parameter>width</parameter> :</term>
781
<listitem><simpara> width of the intersection.
782
</simpara></listitem></varlistentry>
783
<varlistentry><term><parameter>height</parameter> :</term>
784
<listitem><simpara> height of the intersection.
785
</simpara></listitem></varlistentry>
786
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the returned area is not empty.
788
</simpara></listitem></varlistentry>
789
</variablelist><para>Since GIMP 2.2
792
<title><anchor id="gimp-drawable-get-image"/>gimp_drawable_get_image ()</title>
793
<indexterm><primary>gimp_drawable_get_image</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_drawable_get_image (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
795
Returns the drawable's image.
798
This procedure returns the drawable's image.</para>
801
</para><variablelist role="params">
802
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
803
<listitem><simpara> The drawable.
804
</simpara></listitem></varlistentry>
805
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The drawable's image.
806
</simpara></listitem></varlistentry>
807
</variablelist></refsect2>
809
<title><anchor id="gimp-drawable-set-image"/>gimp_drawable_set_image ()</title>
810
<indexterm role="deprecated"><primary>gimp_drawable_set_image</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_set_image (<link linkend="gint32">gint32</link> drawable_ID,
811
<link linkend="gint32">gint32</link> image_ID);</programlisting>
812
<warning><para><literal>gimp_drawable_set_image</literal> is deprecated and should not be used in newly-written code.</para></warning>
814
This procedure is deprecated!</para>
817
</para><variablelist role="params">
818
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
819
<listitem><simpara> The drawable.
820
</simpara></listitem></varlistentry>
821
<varlistentry><term><parameter>image_ID</parameter> :</term>
822
<listitem><simpara> The image.
823
</simpara></listitem></varlistentry>
824
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
825
</simpara></listitem></varlistentry>
826
</variablelist></refsect2>
828
<title><anchor id="gimp-drawable-has-alpha"/>gimp_drawable_has_alpha ()</title>
829
<indexterm><primary>gimp_drawable_has_alpha</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_has_alpha (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
831
Returns non-zero if the drawable has an alpha channel.
834
This procedure returns whether the specified drawable has an alpha
835
channel. This can only be true for layers, and the associated type
836
will be one of: { RGBA , GRAYA, INDEXEDA }.</para>
839
</para><variablelist role="params">
840
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
841
<listitem><simpara> The drawable.
842
</simpara></listitem></varlistentry>
843
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Does the drawable have an alpha channel?
844
</simpara></listitem></varlistentry>
845
</variablelist></refsect2>
847
<title><anchor id="gimp-drawable-type-with-alpha"/>gimp_drawable_type_with_alpha ()</title>
848
<indexterm><primary>gimp_drawable_type_with_alpha</primary></indexterm><programlisting><link linkend="GimpImageType">GimpImageType</link> gimp_drawable_type_with_alpha (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
850
Returns the drawable's type with alpha.
853
This procedure returns the drawable's type as if had an alpha
854
channel. If the type is currently Gray, for instance, the returned
855
type would be GrayA. If the drawable already has an alpha channel,
856
the drawable's type is simply returned.</para>
859
</para><variablelist role="params">
860
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
861
<listitem><simpara> The drawable.
862
</simpara></listitem></varlistentry>
863
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The drawable's type with alpha.
864
</simpara></listitem></varlistentry>
865
</variablelist></refsect2>
867
<title><anchor id="gimp-drawable-type"/>gimp_drawable_type ()</title>
868
<indexterm><primary>gimp_drawable_type</primary></indexterm><programlisting><link linkend="GimpImageType">GimpImageType</link> gimp_drawable_type (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
870
Returns the drawable's type.
873
This procedure returns the drawable's type.</para>
876
</para><variablelist role="params">
877
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
878
<listitem><simpara> The drawable.
879
</simpara></listitem></varlistentry>
880
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The drawable's type.
881
</simpara></listitem></varlistentry>
882
</variablelist></refsect2>
884
<title><anchor id="gimp-drawable-is-rgb"/>gimp_drawable_is_rgb ()</title>
885
<indexterm><primary>gimp_drawable_is_rgb</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_is_rgb (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
887
Returns whether the drawable is an RGB type.
890
This procedure returns non-zero if the specified drawable is of type
891
{ RGB, RGBA }.</para>
894
</para><variablelist role="params">
895
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
896
<listitem><simpara> The drawable.
897
</simpara></listitem></varlistentry>
898
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-zero if the drawable is an RGB type.
899
</simpara></listitem></varlistentry>
900
</variablelist></refsect2>
902
<title><anchor id="gimp-drawable-is-gray"/>gimp_drawable_is_gray ()</title>
903
<indexterm><primary>gimp_drawable_is_gray</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_is_gray (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
905
Returns whether the drawable is a grayscale type.
908
This procedure returns non-zero if the specified drawable is of type
909
{ Gray, GrayA }.</para>
912
</para><variablelist role="params">
913
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
914
<listitem><simpara> The drawable.
915
</simpara></listitem></varlistentry>
916
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-zero if the drawable is a grayscale type.
917
</simpara></listitem></varlistentry>
918
</variablelist></refsect2>
920
<title><anchor id="gimp-drawable-is-indexed"/>gimp_drawable_is_indexed ()</title>
921
<indexterm><primary>gimp_drawable_is_indexed</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_is_indexed (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
923
Returns whether the drawable is an indexed type.
926
This procedure returns non-zero if the specified drawable is of type
927
{ Indexed, IndexedA }.</para>
930
</para><variablelist role="params">
931
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
932
<listitem><simpara> The drawable.
933
</simpara></listitem></varlistentry>
934
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-zero if the drawable is an indexed type.
935
</simpara></listitem></varlistentry>
936
</variablelist></refsect2>
938
<title><anchor id="gimp-drawable-bpp"/>gimp_drawable_bpp ()</title>
939
<indexterm><primary>gimp_drawable_bpp</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_drawable_bpp (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
941
Returns the bytes per pixel.
944
This procedure returns the number of bytes per pixel (or the number
945
of channels) for the specified drawable.</para>
948
</para><variablelist role="params">
949
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
950
<listitem><simpara> The drawable.
951
</simpara></listitem></varlistentry>
952
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Bytes per pixel.
953
</simpara></listitem></varlistentry>
954
</variablelist></refsect2>
956
<title><anchor id="gimp-drawable-width"/>gimp_drawable_width ()</title>
957
<indexterm><primary>gimp_drawable_width</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_drawable_width (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
959
Returns the width of the drawable.
962
This procedure returns the specified drawable's width in pixels.</para>
965
</para><variablelist role="params">
966
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
967
<listitem><simpara> The drawable.
968
</simpara></listitem></varlistentry>
969
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Width of drawable.
970
</simpara></listitem></varlistentry>
971
</variablelist></refsect2>
973
<title><anchor id="gimp-drawable-height"/>gimp_drawable_height ()</title>
974
<indexterm><primary>gimp_drawable_height</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_drawable_height (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
976
Returns the height of the drawable.
979
This procedure returns the specified drawable's height in pixels.</para>
982
</para><variablelist role="params">
983
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
984
<listitem><simpara> The drawable.
985
</simpara></listitem></varlistentry>
986
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Height of drawable.
987
</simpara></listitem></varlistentry>
988
</variablelist></refsect2>
990
<title><anchor id="gimp-drawable-offsets"/>gimp_drawable_offsets ()</title>
991
<indexterm><primary>gimp_drawable_offsets</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_offsets (<link linkend="gint32">gint32</link> drawable_ID,
992
<link linkend="gint">gint</link> *offset_x,
993
<link linkend="gint">gint</link> *offset_y);</programlisting>
995
Returns the offsets for the drawable.
998
This procedure returns the specified drawable's offsets. This only
999
makes sense if the drawable is a layer since channels are anchored.
1000
The offsets of a channel will be returned as 0.</para>
1003
</para><variablelist role="params">
1004
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
1005
<listitem><simpara> The drawable.
1006
</simpara></listitem></varlistentry>
1007
<varlistentry><term><parameter>offset_x</parameter> :</term>
1008
<listitem><simpara> x offset of drawable.
1009
</simpara></listitem></varlistentry>
1010
<varlistentry><term><parameter>offset_y</parameter> :</term>
1011
<listitem><simpara> y offset of drawable.
1012
</simpara></listitem></varlistentry>
1013
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
1014
</simpara></listitem></varlistentry>
1015
</variablelist></refsect2>
1017
<title><anchor id="gimp-drawable-is-layer"/>gimp_drawable_is_layer ()</title>
1018
<indexterm><primary>gimp_drawable_is_layer</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_is_layer (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
1020
Returns whether the drawable is a layer.
1023
This procedure returns non-zero if the specified drawable is a
1027
</para><variablelist role="params">
1028
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
1029
<listitem><simpara> The drawable.
1030
</simpara></listitem></varlistentry>
1031
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Non-zero if the drawable is a layer.
1032
</simpara></listitem></varlistentry>
1033
</variablelist></refsect2>
1035
<title><anchor id="gimp-drawable-is-layer-mask"/>gimp_drawable_is_layer_mask ()</title>
1036
<indexterm><primary>gimp_drawable_is_layer_mask</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_is_layer_mask (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
1038
Returns whether the drawable is a layer mask.
1041
This procedure returns non-zero if the specified drawable is a layer
1045
</para><variablelist role="params">
1046
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
1047
<listitem><simpara> The drawable.
1048
</simpara></listitem></varlistentry>
1049
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Non-zero if the drawable is a layer mask.
1050
</simpara></listitem></varlistentry>
1051
</variablelist></refsect2>
1053
<title><anchor id="gimp-drawable-is-channel"/>gimp_drawable_is_channel ()</title>
1054
<indexterm><primary>gimp_drawable_is_channel</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_is_channel (<link linkend="gint32">gint32</link> drawable_ID);</programlisting>
1056
Returns whether the drawable is a channel.
1059
This procedure returns non-zero if the specified drawable is a
1063
</para><variablelist role="params">
1064
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
1065
<listitem><simpara> The drawable.
1066
</simpara></listitem></varlistentry>
1067
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Non-zero if the drawable is a channel.
1068
</simpara></listitem></varlistentry>
1069
</variablelist></refsect2>
1071
<title><anchor id="gimp-drawable-offset"/>gimp_drawable_offset ()</title>
1072
<indexterm><primary>gimp_drawable_offset</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_offset (<link linkend="gint32">gint32</link> drawable_ID,
1073
<link linkend="gboolean">gboolean</link> wrap_around,
1074
<link linkend="GimpOffsetType">GimpOffsetType</link> fill_type,
1075
<link linkend="gint">gint</link> offset_x,
1076
<link linkend="gint">gint</link> offset_y);</programlisting>
1078
Offset the drawable by the specified amounts in the X and Y
1082
This procedure offsets the specified drawable by the amounts
1083
specified by 'offset_x' and 'offset_y'. If 'wrap_around' is set to
1084
TRUE, then portions of the drawable which are offset out of bounds
1085
are wrapped around. Alternatively, the undefined regions of the
1086
drawable can be filled with transparency or the background color, as
1087
specified by the 'fill_type' parameter.</para>
1090
</para><variablelist role="params">
1091
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
1092
<listitem><simpara> The drawable to offset.
1093
</simpara></listitem></varlistentry>
1094
<varlistentry><term><parameter>wrap_around</parameter> :</term>
1095
<listitem><simpara> wrap image around or fill vacated regions.
1096
</simpara></listitem></varlistentry>
1097
<varlistentry><term><parameter>fill_type</parameter> :</term>
1098
<listitem><simpara> fill vacated regions of drawable with background or transparent.
1099
</simpara></listitem></varlistentry>
1100
<varlistentry><term><parameter>offset_x</parameter> :</term>
1101
<listitem><simpara> offset by this amount in X direction.
1102
</simpara></listitem></varlistentry>
1103
<varlistentry><term><parameter>offset_y</parameter> :</term>
1104
<listitem><simpara> offset by this amount in Y direction.
1105
</simpara></listitem></varlistentry>
1106
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
1107
</simpara></listitem></varlistentry>
1108
</variablelist></refsect2>
1110
<title><anchor id="gimp-drawable-parasite-find"/>gimp_drawable_parasite_find ()</title>
1111
<indexterm><primary>gimp_drawable_parasite_find</primary></indexterm><programlisting><link linkend="GimpParasite">GimpParasite</link>* gimp_drawable_parasite_find (<link linkend="gint32">gint32</link> drawable_ID,
1112
const <link linkend="gchar">gchar</link> *name);</programlisting>
1114
Finds the named parasite in a drawable
1117
Finds and returns the named parasite that was previously attached to
1121
</para><variablelist role="params">
1122
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
1123
<listitem><simpara> The drawable.
1124
</simpara></listitem></varlistentry>
1125
<varlistentry><term><parameter>name</parameter> :</term>
1126
<listitem><simpara> The name of the parasite to find.
1127
</simpara></listitem></varlistentry>
1128
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The found parasite.
1129
</simpara></listitem></varlistentry>
1130
</variablelist></refsect2>
1132
<title><anchor id="gimp-drawable-parasite-list"/>gimp_drawable_parasite_list ()</title>
1133
<indexterm><primary>gimp_drawable_parasite_list</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_parasite_list (<link linkend="gint32">gint32</link> drawable_ID,
1134
<link linkend="gint">gint</link> *num_parasites,
1135
<link linkend="gchar">gchar</link> ***parasites);</programlisting>
1140
Returns a list of all currently attached parasites.</para>
1143
</para><variablelist role="params">
1144
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
1145
<listitem><simpara> The drawable.
1146
</simpara></listitem></varlistentry>
1147
<varlistentry><term><parameter>num_parasites</parameter> :</term>
1148
<listitem><simpara> The number of attached parasites.
1149
</simpara></listitem></varlistentry>
1150
<varlistentry><term><parameter>parasites</parameter> :</term>
1151
<listitem><simpara> The names of currently attached parasites.
1152
</simpara></listitem></varlistentry>
1153
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
1154
</simpara></listitem></varlistentry>
1155
</variablelist></refsect2>
1157
<title><anchor id="gimp-drawable-parasite-attach"/>gimp_drawable_parasite_attach ()</title>
1158
<indexterm><primary>gimp_drawable_parasite_attach</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_parasite_attach (<link linkend="gint32">gint32</link> drawable_ID,
1159
<link linkend="GimpParasite">GimpParasite</link> *parasite);</programlisting>
1161
Add a parasite to a drawable.
1164
This procedure attaches a parasite to a drawable. It has no return
1168
</para><variablelist role="params">
1169
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
1170
<listitem><simpara> The drawable.
1171
</simpara></listitem></varlistentry>
1172
<varlistentry><term><parameter>parasite</parameter> :</term>
1173
<listitem><simpara> The parasite to attach to a drawable.
1174
</simpara></listitem></varlistentry>
1175
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
1176
</simpara></listitem></varlistentry>
1177
</variablelist></refsect2>
1179
<title><anchor id="gimp-drawable-parasite-detach"/>gimp_drawable_parasite_detach ()</title>
1180
<indexterm><primary>gimp_drawable_parasite_detach</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_drawable_parasite_detach (<link linkend="gint32">gint32</link> drawable_ID,
1181
const <link linkend="gchar">gchar</link> *name);</programlisting>
1183
Removes a parasite from a drawable.
1186
This procedure detaches a parasite from a drawable. It has no return
1190
</para><variablelist role="params">
1191
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
1192
<listitem><simpara> The drawable.
1193
</simpara></listitem></varlistentry>
1194
<varlistentry><term><parameter>name</parameter> :</term>
1195
<listitem><simpara> The name of the parasite to detach from a drawable.
1196
</simpara></listitem></varlistentry>
1197
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
1198
</simpara></listitem></varlistentry>
1199
</variablelist></refsect2>
1201
<title><anchor id="gimp-drawable-attach-new-parasite"/>gimp_drawable_attach_new_parasite ()</title>
1202
<indexterm><primary>gimp_drawable_attach_new_parasite</primary></indexterm><programlisting><link linkend="void">void</link> gimp_drawable_attach_new_parasite
1203
(<link linkend="gint32">gint32</link> drawable_ID,
1204
const <link linkend="gchar">gchar</link> *name,
1205
<link linkend="gint">gint</link> flags,
1206
<link linkend="gint">gint</link> size,
1207
<link linkend="gconstpointer">gconstpointer</link> data);</programlisting>
1209
Convenience function that creates a parasite and attaches it
1213
See Also: <link linkend="gimp-drawable-parasite-attach"><function>gimp_drawable_parasite_attach()</function></link></para>
1216
</para><variablelist role="params">
1217
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
1218
<listitem><simpara> the ID of the <link linkend="GimpDrawable"><type>GimpDrawable</type></link> to attach the <link linkend="GimpParasite"><type>GimpParasite</type></link> to.
1219
</simpara></listitem></varlistentry>
1220
<varlistentry><term><parameter>name</parameter> :</term>
1221
<listitem><simpara> the name of the <link linkend="GimpParasite"><type>GimpParasite</type></link> to create and attach.
1222
</simpara></listitem></varlistentry>
1223
<varlistentry><term><parameter>flags</parameter> :</term>
1224
<listitem><simpara> the flags set on the <link linkend="GimpParasite"><type>GimpParasite</type></link>.
1225
</simpara></listitem></varlistentry>
1226
<varlistentry><term><parameter>size</parameter> :</term>
1227
<listitem><simpara> the size of the parasite data in bytes.
1228
</simpara></listitem></varlistentry>
1229
<varlistentry><term><parameter>data</parameter> :</term>
1230
<listitem><simpara> a pointer to the data attached with the <link linkend="GimpParasite"><type>GimpParasite</type></link>.
1231
</simpara></listitem></varlistentry>
1232
</variablelist></refsect2>
added
removed
devel-docs/libgimp/xml/gimpdrawable.xml
