← Back to branch summary

~ubuntu-branches/ubuntu/maverick/gimp/maverick-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/xml/gimpchannel.xml

  • Committer: Package Import Robot
  • Author(s): Ari Pollak
  • Date: 2010-07-08 21:31:29 UTC
  • mto: (0.4.6 sid) (1.1.23)
  • mto: This revision was merged to the branch mainline in revision 53.
  • Revision ID: package-import@ubuntu.com-20100708213129-eq09128jclwhu07x
Import upstream version 2.6.10

Show diffs side-by-side

added added

removed removed

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