1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libgimp-gimpchannel">
<refmeta>
<refentrytitle role="top_of_page">gimpchannel</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpchannel</refname>
<refpurpose>Functions for manipulating channels.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="gint32">gint32</link> <link linkend="gimp-channel-new">gimp_channel_new</link> (<link linkend="gint32">gint32</link> image_ID,
const <link linkend="gchar">gchar</link> *name,
<link linkend="guint">guint</link> width,
<link linkend="guint">guint</link> height,
<link linkend="gdouble">gdouble</link> opacity,
const <link linkend="GimpRGB">GimpRGB</link> *color);
<link linkend="gint32">gint32</link> <link linkend="gimp-channel-copy">gimp_channel_copy</link> (<link linkend="gint32">gint32</link> channel_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-channel-get-show-masked">gimp_channel_get_show_masked</link> (<link linkend="gint32">gint32</link> channel_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-channel-set-show-masked">gimp_channel_set_show_masked</link> (<link linkend="gint32">gint32</link> channel_ID,
<link linkend="gboolean">gboolean</link> show_masked);
<link linkend="gdouble">gdouble</link> <link linkend="gimp-channel-get-opacity">gimp_channel_get_opacity</link> (<link linkend="gint32">gint32</link> channel_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-channel-set-opacity">gimp_channel_set_opacity</link> (<link linkend="gint32">gint32</link> channel_ID,
<link linkend="gdouble">gdouble</link> opacity);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-channel-get-color">gimp_channel_get_color</link> (<link linkend="gint32">gint32</link> channel_ID,
<link linkend="GimpRGB">GimpRGB</link> *color);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-channel-set-color">gimp_channel_set_color</link> (<link linkend="gint32">gint32</link> channel_ID,
const <link linkend="GimpRGB">GimpRGB</link> *color);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-channel-combine-masks">gimp_channel_combine_masks</link> (<link linkend="gint32">gint32</link> channel1_ID,
<link linkend="gint32">gint32</link> channel2_ID,
<link linkend="GimpChannelOps">GimpChannelOps</link> operation,
<link linkend="gint">gint</link> offx,
<link linkend="gint">gint</link> offy);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Functions for manipulating channels.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-channel-new" role="function"/>gimp_channel_new ()</title>
<indexterm><primary>gimp_channel_new</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_channel_new (<link linkend="gint32">gint32</link> image_ID,
const <link linkend="gchar">gchar</link> *name,
<link linkend="guint">guint</link> width,
<link linkend="guint">guint</link> height,
<link linkend="gdouble">gdouble</link> opacity,
const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
<para>
Create a new channel.
</para>
<para>
This procedure creates a new channel with the specified width and
height. Name, opacity, and color are also supplied parameters. The
new channel still needs to be added to the image, as this is not
automatic. Add the new channel with the 'gimp_image_add_channel'
command. Other attributes such as channel show masked, should be set
with explicit procedure calls. The channel's contents are undefined
initially.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image to which to add the channel.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The channel name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter> :</term>
<listitem><simpara> The channel width.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter> :</term>
<listitem><simpara> The channel height.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opacity</parameter> :</term>
<listitem><simpara> The channel opacity.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> The channel compositing color.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created channel.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-channel-copy" role="function"/>gimp_channel_copy ()</title>
<indexterm><primary>gimp_channel_copy</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_channel_copy (<link linkend="gint32">gint32</link> channel_ID);</programlisting>
<para>
Copy a channel.
</para>
<para>
This procedure copies the specified channel and returns the copy.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>channel_ID</parameter> :</term>
<listitem><simpara> The channel to copy.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly copied channel.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-channel-get-show-masked" role="function"/>gimp_channel_get_show_masked ()</title>
<indexterm><primary>gimp_channel_get_show_masked</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_channel_get_show_masked (<link linkend="gint32">gint32</link> channel_ID);</programlisting>
<para>
Get the composite method of the specified channel.
</para>
<para>
This procedure returns the specified channel's composite method. If
it is non-zero, then the channel is composited with the image so
that masked regions are shown. Otherwise, selected regions are
shown.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>channel_ID</parameter> :</term>
<listitem><simpara> The channel.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The channel composite method.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-channel-set-show-masked" role="function"/>gimp_channel_set_show_masked ()</title>
<indexterm><primary>gimp_channel_set_show_masked</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_channel_set_show_masked (<link linkend="gint32">gint32</link> channel_ID,
<link linkend="gboolean">gboolean</link> show_masked);</programlisting>
<para>
Set the composite method of the specified channel.
</para>
<para>
This procedure sets the specified channel's composite method. If it
is non-zero, then the channel is composited with the image so that
masked regions are shown. Otherwise, selected regions are shown.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>channel_ID</parameter> :</term>
<listitem><simpara> The channel.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>show_masked</parameter> :</term>
<listitem><simpara> The new channel composite method.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-channel-get-opacity" role="function"/>gimp_channel_get_opacity ()</title>
<indexterm><primary>gimp_channel_get_opacity</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gimp_channel_get_opacity (<link linkend="gint32">gint32</link> channel_ID);</programlisting>
<para>
Get the opacity of the specified channel.
</para>
<para>
This procedure returns the specified channel's opacity.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>channel_ID</parameter> :</term>
<listitem><simpara> The channel.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The channel opacity.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-channel-set-opacity" role="function"/>gimp_channel_set_opacity ()</title>
<indexterm><primary>gimp_channel_set_opacity</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_channel_set_opacity (<link linkend="gint32">gint32</link> channel_ID,
<link linkend="gdouble">gdouble</link> opacity);</programlisting>
<para>
Set the opacity of the specified channel.
</para>
<para>
This procedure sets the specified channel's opacity.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>channel_ID</parameter> :</term>
<listitem><simpara> The channel.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opacity</parameter> :</term>
<listitem><simpara> The new channel opacity.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-channel-get-color" role="function"/>gimp_channel_get_color ()</title>
<indexterm><primary>gimp_channel_get_color</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_channel_get_color (<link linkend="gint32">gint32</link> channel_ID,
<link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
<para>
Get the compositing color of the specified channel.
</para>
<para>
This procedure returns the specified channel's compositing color.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>channel_ID</parameter> :</term>
<listitem><simpara> The channel.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> The channel compositing color.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-channel-set-color" role="function"/>gimp_channel_set_color ()</title>
<indexterm><primary>gimp_channel_set_color</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_channel_set_color (<link linkend="gint32">gint32</link> channel_ID,
const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
<para>
Set the compositing color of the specified channel.
</para>
<para>
This procedure sets the specified channel's compositing color.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>channel_ID</parameter> :</term>
<listitem><simpara> The channel.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color</parameter> :</term>
<listitem><simpara> The new channel compositing color.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-channel-combine-masks" role="function"/>gimp_channel_combine_masks ()</title>
<indexterm><primary>gimp_channel_combine_masks</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_channel_combine_masks (<link linkend="gint32">gint32</link> channel1_ID,
<link linkend="gint32">gint32</link> channel2_ID,
<link linkend="GimpChannelOps">GimpChannelOps</link> operation,
<link linkend="gint">gint</link> offx,
<link linkend="gint">gint</link> offy);</programlisting>
<para>
Combine two channel masks.
</para>
<para>
This procedure combines two channel masks. The result is stored in
the first channel.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>channel1_ID</parameter> :</term>
<listitem><simpara> The channel1.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>channel2_ID</parameter> :</term>
<listitem><simpara> The channel2.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>operation</parameter> :</term>
<listitem><simpara> The selection operation.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offx</parameter> :</term>
<listitem><simpara> x offset between upper left corner of channels: (second - first).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>offy</parameter> :</term>
<listitem><simpara> y offset between upper left corner of channels: (second - first).
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
