← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gimp/oneiric-security

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2010-07-12 15:08:08 UTC
  • mfrom: (1.1.23) (0.4.6 sid)
  • Revision ID: package-import@ubuntu.com-20100712150808-db9xqgtxrvpyl3g2
Tags: 2.6.10-1ubuntu1
Resync on Debian, dropping changes which are in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimpgradient.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-gimpgradient">
6
 
<refmeta>
7
 
<refentrytitle role="top_of_page" id="libgimp-gimpgradient.top_of_page">gimpgradient</refentrytitle>
8
 
<manvolnum>3</manvolnum>
9
 
<refmiscinfo>LIBGIMP Library</refmiscinfo>
10
 
</refmeta>
11
 
 
12
 
<refnamediv>
13
 
<refname>gimpgradient</refname>
14
 
<refpurpose>Functions operating on a single gradient.</refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="libgimp-gimpgradient.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>
21
 
<link linkend="gchar">gchar</link>*              <link linkend="gimp-gradient-new">gimp_gradient_new</link>                   (const <link linkend="gchar">gchar</link> *name);
22
 
<link linkend="gchar">gchar</link>*              <link linkend="gimp-gradient-duplicate">gimp_gradient_duplicate</link>             (const <link linkend="gchar">gchar</link> *name);
23
 
<link linkend="gchar">gchar</link>*              <link linkend="gimp-gradient-rename">gimp_gradient_rename</link>                (const <link linkend="gchar">gchar</link> *name,
24
 
                                                         const <link linkend="gchar">gchar</link> *new_name);
25
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-delete">gimp_gradient_delete</link>                (const <link linkend="gchar">gchar</link> *name);
26
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-is-editable">gimp_gradient_is_editable</link>           (const <link linkend="gchar">gchar</link> *name);
27
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-get-uniform-samples">gimp_gradient_get_uniform_samples</link>   (const <link linkend="gchar">gchar</link> *name,
28
 
                                                         <link linkend="gint">gint</link> num_samples,
29
 
                                                         <link linkend="gboolean">gboolean</link> reverse,
30
 
                                                         <link linkend="gint">gint</link> *num_color_samples,
31
 
                                                         <link linkend="gdouble">gdouble</link> **color_samples);
32
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-get-custom-samples">gimp_gradient_get_custom_samples</link>    (const <link linkend="gchar">gchar</link> *name,
33
 
                                                         <link linkend="gint">gint</link> num_samples,
34
 
                                                         const <link linkend="gdouble">gdouble</link> *positions,
35
 
                                                         <link linkend="gboolean">gboolean</link> reverse,
36
 
                                                         <link linkend="gint">gint</link> *num_color_samples,
37
 
                                                         <link linkend="gdouble">gdouble</link> **color_samples);
38
 
<link linkend="gint">gint</link>                <link linkend="gimp-gradient-get-number-of-segments">gimp_gradient_get_number_of_segments</link>
39
 
                                                        (const <link linkend="gchar">gchar</link> *name);
40
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-get-left-color">gimp_gradient_segment_get_left_color</link>
41
 
                                                        (const <link linkend="gchar">gchar</link> *name,
42
 
                                                         <link linkend="gint">gint</link> segment,
43
 
                                                         <link linkend="GimpRGB">GimpRGB</link> *color,
44
 
                                                         <link linkend="gdouble">gdouble</link> *opacity);
45
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-set-left-color">gimp_gradient_segment_set_left_color</link>
46
 
                                                        (const <link linkend="gchar">gchar</link> *name,
47
 
                                                         <link linkend="gint">gint</link> segment,
48
 
                                                         const <link linkend="GimpRGB">GimpRGB</link> *color,
49
 
                                                         <link linkend="gdouble">gdouble</link> opacity);
50
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-get-right-color">gimp_gradient_segment_get_right_color</link>
51
 
                                                        (const <link linkend="gchar">gchar</link> *name,
52
 
                                                         <link linkend="gint">gint</link> segment,
53
 
                                                         <link linkend="GimpRGB">GimpRGB</link> *color,
54
 
                                                         <link linkend="gdouble">gdouble</link> *opacity);
55
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-set-right-color">gimp_gradient_segment_set_right_color</link>
56
 
                                                        (const <link linkend="gchar">gchar</link> *name,
57
 
                                                         <link linkend="gint">gint</link> segment,
58
 
                                                         const <link linkend="GimpRGB">GimpRGB</link> *color,
59
 
                                                         <link linkend="gdouble">gdouble</link> opacity);
60
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-get-left-pos">gimp_gradient_segment_get_left_pos</link>  (const <link linkend="gchar">gchar</link> *name,
61
 
                                                         <link linkend="gint">gint</link> segment,
62
 
                                                         <link linkend="gdouble">gdouble</link> *pos);
63
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-set-left-pos">gimp_gradient_segment_set_left_pos</link>  (const <link linkend="gchar">gchar</link> *name,
64
 
                                                         <link linkend="gint">gint</link> segment,
65
 
                                                         <link linkend="gdouble">gdouble</link> pos,
66
 
                                                         <link linkend="gdouble">gdouble</link> *final_pos);
67
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-get-middle-pos">gimp_gradient_segment_get_middle_pos</link>
68
 
                                                        (const <link linkend="gchar">gchar</link> *name,
69
 
                                                         <link linkend="gint">gint</link> segment,
70
 
                                                         <link linkend="gdouble">gdouble</link> *pos);
71
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-set-middle-pos">gimp_gradient_segment_set_middle_pos</link>
72
 
                                                        (const <link linkend="gchar">gchar</link> *name,
73
 
                                                         <link linkend="gint">gint</link> segment,
74
 
                                                         <link linkend="gdouble">gdouble</link> pos,
75
 
                                                         <link linkend="gdouble">gdouble</link> *final_pos);
76
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-get-right-pos">gimp_gradient_segment_get_right_pos</link> (const <link linkend="gchar">gchar</link> *name,
77
 
                                                         <link linkend="gint">gint</link> segment,
78
 
                                                         <link linkend="gdouble">gdouble</link> *pos);
79
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-set-right-pos">gimp_gradient_segment_set_right_pos</link> (const <link linkend="gchar">gchar</link> *name,
80
 
                                                         <link linkend="gint">gint</link> segment,
81
 
                                                         <link linkend="gdouble">gdouble</link> pos,
82
 
                                                         <link linkend="gdouble">gdouble</link> *final_pos);
83
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-get-blending-function">gimp_gradient_segment_get_blending_function</link>
84
 
                                                        (const <link linkend="gchar">gchar</link> *name,
85
 
                                                         <link linkend="gint">gint</link> segment,
86
 
                                                         <link linkend="GimpGradientSegmentType">GimpGradientSegmentType</link> *blend_func);
87
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-get-coloring-type">gimp_gradient_segment_get_coloring_type</link>
88
 
                                                        (const <link linkend="gchar">gchar</link> *name,
89
 
                                                         <link linkend="gint">gint</link> segment,
90
 
                                                         <link linkend="GimpGradientSegmentColor">GimpGradientSegmentColor</link> *coloring_type);
91
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-range-set-blending-function">gimp_gradient_segment_range_set_blending_function</link>
92
 
                                                        (const <link linkend="gchar">gchar</link> *name,
93
 
                                                         <link linkend="gint">gint</link> start_segment,
94
 
                                                         <link linkend="gint">gint</link> end_segment,
95
 
                                                         <link linkend="GimpGradientSegmentType">GimpGradientSegmentType</link> blending_function);
96
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-range-set-coloring-type">gimp_gradient_segment_range_set_coloring_type</link>
97
 
                                                        (const <link linkend="gchar">gchar</link> *name,
98
 
                                                         <link linkend="gint">gint</link> start_segment,
99
 
                                                         <link linkend="gint">gint</link> end_segment,
100
 
                                                         <link linkend="GimpGradientSegmentColor">GimpGradientSegmentColor</link> coloring_type);
101
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-range-flip">gimp_gradient_segment_range_flip</link>    (const <link linkend="gchar">gchar</link> *name,
102
 
                                                         <link linkend="gint">gint</link> start_segment,
103
 
                                                         <link linkend="gint">gint</link> end_segment);
104
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-range-replicate">gimp_gradient_segment_range_replicate</link>
105
 
                                                        (const <link linkend="gchar">gchar</link> *name,
106
 
                                                         <link linkend="gint">gint</link> start_segment,
107
 
                                                         <link linkend="gint">gint</link> end_segment,
108
 
                                                         <link linkend="gint">gint</link> replicate_times);
109
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-range-split-midpoint">gimp_gradient_segment_range_split_midpoint</link>
110
 
                                                        (const <link linkend="gchar">gchar</link> *name,
111
 
                                                         <link linkend="gint">gint</link> start_segment,
112
 
                                                         <link linkend="gint">gint</link> end_segment);
113
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-range-split-uniform">gimp_gradient_segment_range_split_uniform</link>
114
 
                                                        (const <link linkend="gchar">gchar</link> *name,
115
 
                                                         <link linkend="gint">gint</link> start_segment,
116
 
                                                         <link linkend="gint">gint</link> end_segment,
117
 
                                                         <link linkend="gint">gint</link> split_parts);
118
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-range-delete">gimp_gradient_segment_range_delete</link>  (const <link linkend="gchar">gchar</link> *name,
119
 
                                                         <link linkend="gint">gint</link> start_segment,
120
 
                                                         <link linkend="gint">gint</link> end_segment);
121
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-range-redistribute-handles">gimp_gradient_segment_range_redistribute_handles</link>
122
 
                                                        (const <link linkend="gchar">gchar</link> *name,
123
 
                                                         <link linkend="gint">gint</link> start_segment,
124
 
                                                         <link linkend="gint">gint</link> end_segment);
125
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-range-blend-colors">gimp_gradient_segment_range_blend_colors</link>
126
 
                                                        (const <link linkend="gchar">gchar</link> *name,
127
 
                                                         <link linkend="gint">gint</link> start_segment,
128
 
                                                         <link linkend="gint">gint</link> end_segment);
129
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-gradient-segment-range-blend-opacity">gimp_gradient_segment_range_blend_opacity</link>
130
 
                                                        (const <link linkend="gchar">gchar</link> *name,
131
 
                                                         <link linkend="gint">gint</link> start_segment,
132
 
                                                         <link linkend="gint">gint</link> end_segment);
133
 
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-gradient-segment-range-move">gimp_gradient_segment_range_move</link>    (const <link linkend="gchar">gchar</link> *name,
134
 
                                                         <link linkend="gint">gint</link> start_segment,
135
 
                                                         <link linkend="gint">gint</link> end_segment,
136
 
                                                         <link linkend="gdouble">gdouble</link> delta,
137
 
                                                         <link linkend="gboolean">gboolean</link> control_compress);
138
 
</synopsis>
139
 
</refsynopsisdiv>
140
 
 
141
 
 
142
 
 
143
 
 
144
 
 
145
 
 
146
 
 
147
 
 
148
 
 
149
 
<refsect1 id="libgimp-gimpgradient.description" role="desc">
150
 
<title role="desc.title">Description</title>
151
 
<para>
152
 
Functions operating on a single gradient.
153
 
</para>
154
 
</refsect1>
155
 
 
156
 
<refsect1 id="libgimp-gimpgradient.details" role="details">
157
 
<title role="details.title">Details</title>
158
 
<refsect2 id="gimp-gradient-new" role="function" condition="since:GIMP 2.2">
159
 
<title>gimp_gradient_new ()</title>
160
 
<indexterm zone="gimp-gradient-new" role="GIMP 2.2"><primary sortas="gimp_gradient_new">gimp_gradient_new</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_gradient_new                   (const <link linkend="gchar">gchar</link> *name);</programlisting>
161
 
<para>
162
 
Creates a new gradient
163
 
</para>
164
 
<para>
165
 
This procedure creates a new, uninitialized gradient</para>
166
 
<para>
167
 
</para><variablelist role="params">
168
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
169
 
<listitem><simpara> The requested name of the new gradient.
170
 
</simpara></listitem></varlistentry>
171
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The actual new gradient name.
172
 
 
173
 
</simpara></listitem></varlistentry>
174
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
175
 
<refsect2 id="gimp-gradient-duplicate" role="function" condition="since:GIMP 2.2">
176
 
<title>gimp_gradient_duplicate ()</title>
177
 
<indexterm zone="gimp-gradient-duplicate" role="GIMP 2.2"><primary sortas="gimp_gradient_duplicate">gimp_gradient_duplicate</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_gradient_duplicate             (const <link linkend="gchar">gchar</link> *name);</programlisting>
178
 
<para>
179
 
Duplicates a gradient
180
 
</para>
181
 
<para>
182
 
This procedure creates an identical gradient by a different name</para>
183
 
<para>
184
 
</para><variablelist role="params">
185
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
186
 
<listitem><simpara> The gradient name.
187
 
</simpara></listitem></varlistentry>
188
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The name of the gradient's copy.
189
 
 
190
 
</simpara></listitem></varlistentry>
191
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
192
 
<refsect2 id="gimp-gradient-rename" role="function" condition="since:GIMP 2.2">
193
 
<title>gimp_gradient_rename ()</title>
194
 
<indexterm zone="gimp-gradient-rename" role="GIMP 2.2"><primary sortas="gimp_gradient_rename">gimp_gradient_rename</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_gradient_rename                (const <link linkend="gchar">gchar</link> *name,
195
 
                                                         const <link linkend="gchar">gchar</link> *new_name);</programlisting>
196
 
<para>
197
 
Rename a gradient
198
 
</para>
199
 
<para>
200
 
This procedure renames a gradient</para>
201
 
<para>
202
 
</para><variablelist role="params">
203
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
204
 
<listitem><simpara> The gradient name.
205
 
</simpara></listitem></varlistentry>
206
 
<varlistentry><term><parameter>new_name</parameter>&#160;:</term>
207
 
<listitem><simpara> The new name of the gradient.
208
 
</simpara></listitem></varlistentry>
209
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The actual new name of the gradient.
210
 
 
211
 
</simpara></listitem></varlistentry>
212
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
213
 
<refsect2 id="gimp-gradient-delete" role="function" condition="since:GIMP 2.2">
214
 
<title>gimp_gradient_delete ()</title>
215
 
<indexterm zone="gimp-gradient-delete" role="GIMP 2.2"><primary sortas="gimp_gradient_delete">gimp_gradient_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_delete                (const <link linkend="gchar">gchar</link> *name);</programlisting>
216
 
<para>
217
 
Deletes a gradient
218
 
</para>
219
 
<para>
220
 
This procedure deletes a gradient</para>
221
 
<para>
222
 
</para><variablelist role="params">
223
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
224
 
<listitem><simpara> The gradient name.
225
 
</simpara></listitem></varlistentry>
226
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
227
 
 
228
 
</simpara></listitem></varlistentry>
229
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
230
 
<refsect2 id="gimp-gradient-is-editable" role="function" condition="since:GIMP 2.4">
231
 
<title>gimp_gradient_is_editable ()</title>
232
 
<indexterm zone="gimp-gradient-is-editable" role="GIMP 2.4"><primary sortas="gimp_gradient_is_editable">gimp_gradient_is_editable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_is_editable           (const <link linkend="gchar">gchar</link> *name);</programlisting>
233
 
<para>
234
 
Tests if gradient can be edited
235
 
</para>
236
 
<para>
237
 
Returns TRUE if you have permission to change the gradient</para>
238
 
<para>
239
 
</para><variablelist role="params">
240
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
241
 
<listitem><simpara> The gradient name.
242
 
</simpara></listitem></varlistentry>
243
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the gradient can be edited.
244
 
 
245
 
</simpara></listitem></varlistentry>
246
 
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
247
 
<refsect2 id="gimp-gradient-get-uniform-samples" role="function" condition="since:GIMP 2.2">
248
 
<title>gimp_gradient_get_uniform_samples ()</title>
249
 
<indexterm zone="gimp-gradient-get-uniform-samples" role="GIMP 2.2"><primary sortas="gimp_gradient_get_uniform_samples">gimp_gradient_get_uniform_samples</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_get_uniform_samples   (const <link linkend="gchar">gchar</link> *name,
250
 
                                                         <link linkend="gint">gint</link> num_samples,
251
 
                                                         <link linkend="gboolean">gboolean</link> reverse,
252
 
                                                         <link linkend="gint">gint</link> *num_color_samples,
253
 
                                                         <link linkend="gdouble">gdouble</link> **color_samples);</programlisting>
254
 
<para>
255
 
Sample the specified in uniform parts.
256
 
</para>
257
 
<para>
258
 
This procedure samples the active gradient in the specified number
259
 
of uniform parts. It returns a list of floating-point values which
260
 
correspond to the RGBA values for each sample. The minimum number of
261
 
samples to take is 2, in which case the returned colors will
262
 
correspond to the { 0.0, 1.0 } positions in the gradient. For
263
 
example, if the number of samples is 3, the procedure will return
264
 
the colors at positions { 0.0, 0.5, 1.0 }.</para>
265
 
<para>
266
 
</para><variablelist role="params">
267
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
268
 
<listitem><simpara> The gradient name.
269
 
</simpara></listitem></varlistentry>
270
 
<varlistentry><term><parameter>num_samples</parameter>&#160;:</term>
271
 
<listitem><simpara> The number of samples to take.
272
 
</simpara></listitem></varlistentry>
273
 
<varlistentry><term><parameter>reverse</parameter>&#160;:</term>
274
 
<listitem><simpara> Use the reverse gradient.
275
 
</simpara></listitem></varlistentry>
276
 
<varlistentry><term><parameter>num_color_samples</parameter>&#160;:</term>
277
 
<listitem><simpara> Length of the color_samples array (4 * num_samples).
278
 
</simpara></listitem></varlistentry>
279
 
<varlistentry><term><parameter>color_samples</parameter>&#160;:</term>
280
 
<listitem><simpara> Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.
281
 
</simpara></listitem></varlistentry>
282
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
283
 
 
284
 
</simpara></listitem></varlistentry>
285
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
286
 
<refsect2 id="gimp-gradient-get-custom-samples" role="function" condition="since:GIMP 2.2">
287
 
<title>gimp_gradient_get_custom_samples ()</title>
288
 
<indexterm zone="gimp-gradient-get-custom-samples" role="GIMP 2.2"><primary sortas="gimp_gradient_get_custom_samples">gimp_gradient_get_custom_samples</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_get_custom_samples    (const <link linkend="gchar">gchar</link> *name,
289
 
                                                         <link linkend="gint">gint</link> num_samples,
290
 
                                                         const <link linkend="gdouble">gdouble</link> *positions,
291
 
                                                         <link linkend="gboolean">gboolean</link> reverse,
292
 
                                                         <link linkend="gint">gint</link> *num_color_samples,
293
 
                                                         <link linkend="gdouble">gdouble</link> **color_samples);</programlisting>
294
 
<para>
295
 
Sample the spacified gradient in custom positions.
296
 
</para>
297
 
<para>
298
 
This procedure samples the active gradient in the specified number
299
 
of points. The procedure will sample the gradient in the specified
300
 
positions from the list. The left endpoint of the gradient
301
 
corresponds to position 0.0, and the right endpoint corresponds to
302
 
1.0. The procedure returns a list of floating-point values which
303
 
correspond to the RGBA values for each sample.</para>
304
 
<para>
305
 
</para><variablelist role="params">
306
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
307
 
<listitem><simpara> The gradient name.
308
 
</simpara></listitem></varlistentry>
309
 
<varlistentry><term><parameter>num_samples</parameter>&#160;:</term>
310
 
<listitem><simpara> The number of samples to take.
311
 
</simpara></listitem></varlistentry>
312
 
<varlistentry><term><parameter>positions</parameter>&#160;:</term>
313
 
<listitem><simpara> The list of positions to sample along the gradient.
314
 
</simpara></listitem></varlistentry>
315
 
<varlistentry><term><parameter>reverse</parameter>&#160;:</term>
316
 
<listitem><simpara> Use the reverse gradient.
317
 
</simpara></listitem></varlistentry>
318
 
<varlistentry><term><parameter>num_color_samples</parameter>&#160;:</term>
319
 
<listitem><simpara> Length of the color_samples array (4 * num_samples).
320
 
</simpara></listitem></varlistentry>
321
 
<varlistentry><term><parameter>color_samples</parameter>&#160;:</term>
322
 
<listitem><simpara> Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.
323
 
</simpara></listitem></varlistentry>
324
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
325
 
 
326
 
</simpara></listitem></varlistentry>
327
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
328
 
<refsect2 id="gimp-gradient-get-number-of-segments" role="function" condition="since:GIMP 2.6">
329
 
<title>gimp_gradient_get_number_of_segments ()</title>
330
 
<indexterm zone="gimp-gradient-get-number-of-segments" role="GIMP 2.6"><primary sortas="gimp_gradient_get_number_of_segments">gimp_gradient_get_number_of_segments</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_gradient_get_number_of_segments
331
 
                                                        (const <link linkend="gchar">gchar</link> *name);</programlisting>
332
 
<para>
333
 
Returns the number of segments of the specified gradient
334
 
</para>
335
 
<para>
336
 
This procedure returns the number of segments of the specified
337
 
gradient.</para>
338
 
<para>
339
 
</para><variablelist role="params">
340
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
341
 
<listitem><simpara> The gradient name.
342
 
</simpara></listitem></varlistentry>
343
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> Number of segments.
344
 
 
345
 
</simpara></listitem></varlistentry>
346
 
</variablelist><para role="since">Since GIMP 2.6</para></refsect2>
347
 
<refsect2 id="gimp-gradient-segment-get-left-color" role="function" condition="since:GIMP 2.2">
348
 
<title>gimp_gradient_segment_get_left_color ()</title>
349
 
<indexterm zone="gimp-gradient-segment-get-left-color" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_get_left_color">gimp_gradient_segment_get_left_color</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_get_left_color
350
 
                                                        (const <link linkend="gchar">gchar</link> *name,
351
 
                                                         <link linkend="gint">gint</link> segment,
352
 
                                                         <link linkend="GimpRGB">GimpRGB</link> *color,
353
 
                                                         <link linkend="gdouble">gdouble</link> *opacity);</programlisting>
354
 
<para>
355
 
Retrieves the left endpoint color of the specified segment
356
 
</para>
357
 
<para>
358
 
This procedure retrieves the left endpoint color of the specified
359
 
segment of the specified gradient.</para>
360
 
<para>
361
 
</para><variablelist role="params">
362
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
363
 
<listitem><simpara> The gradient name.
364
 
</simpara></listitem></varlistentry>
365
 
<varlistentry><term><parameter>segment</parameter>&#160;:</term>
366
 
<listitem><simpara> The index of the segment within the gradient.
367
 
</simpara></listitem></varlistentry>
368
 
<varlistentry><term><parameter>color</parameter>&#160;:</term>
369
 
<listitem><simpara> The return color.
370
 
</simpara></listitem></varlistentry>
371
 
<varlistentry><term><parameter>opacity</parameter>&#160;:</term>
372
 
<listitem><simpara> The opacity of the endpoint.
373
 
</simpara></listitem></varlistentry>
374
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
375
 
 
376
 
</simpara></listitem></varlistentry>
377
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
378
 
<refsect2 id="gimp-gradient-segment-set-left-color" role="function" condition="since:GIMP 2.2">
379
 
<title>gimp_gradient_segment_set_left_color ()</title>
380
 
<indexterm zone="gimp-gradient-segment-set-left-color" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_set_left_color">gimp_gradient_segment_set_left_color</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_set_left_color
381
 
                                                        (const <link linkend="gchar">gchar</link> *name,
382
 
                                                         <link linkend="gint">gint</link> segment,
383
 
                                                         const <link linkend="GimpRGB">GimpRGB</link> *color,
384
 
                                                         <link linkend="gdouble">gdouble</link> opacity);</programlisting>
385
 
<para>
386
 
Sets the left endpoint color of the specified segment
387
 
</para>
388
 
<para>
389
 
This procedure sets the left endpoint color of the specified segment
390
 
of the specified gradient.</para>
391
 
<para>
392
 
</para><variablelist role="params">
393
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
394
 
<listitem><simpara> The gradient name.
395
 
</simpara></listitem></varlistentry>
396
 
<varlistentry><term><parameter>segment</parameter>&#160;:</term>
397
 
<listitem><simpara> The index of the segment within the gradient.
398
 
</simpara></listitem></varlistentry>
399
 
<varlistentry><term><parameter>color</parameter>&#160;:</term>
400
 
<listitem><simpara> The color to set.
401
 
</simpara></listitem></varlistentry>
402
 
<varlistentry><term><parameter>opacity</parameter>&#160;:</term>
403
 
<listitem><simpara> The opacity to set for the endpoint.
404
 
</simpara></listitem></varlistentry>
405
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
406
 
 
407
 
</simpara></listitem></varlistentry>
408
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
409
 
<refsect2 id="gimp-gradient-segment-get-right-color" role="function" condition="since:GIMP 2.2">
410
 
<title>gimp_gradient_segment_get_right_color ()</title>
411
 
<indexterm zone="gimp-gradient-segment-get-right-color" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_get_right_color">gimp_gradient_segment_get_right_color</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_get_right_color
412
 
                                                        (const <link linkend="gchar">gchar</link> *name,
413
 
                                                         <link linkend="gint">gint</link> segment,
414
 
                                                         <link linkend="GimpRGB">GimpRGB</link> *color,
415
 
                                                         <link linkend="gdouble">gdouble</link> *opacity);</programlisting>
416
 
<para>
417
 
Retrieves the right endpoint color of the specified segment
418
 
</para>
419
 
<para>
420
 
This procedure retrieves the right endpoint color of the specified
421
 
segment of the specified gradient.</para>
422
 
<para>
423
 
</para><variablelist role="params">
424
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
425
 
<listitem><simpara> The gradient name.
426
 
</simpara></listitem></varlistentry>
427
 
<varlistentry><term><parameter>segment</parameter>&#160;:</term>
428
 
<listitem><simpara> The index of the segment within the gradient.
429
 
</simpara></listitem></varlistentry>
430
 
<varlistentry><term><parameter>color</parameter>&#160;:</term>
431
 
<listitem><simpara> The return color.
432
 
</simpara></listitem></varlistentry>
433
 
<varlistentry><term><parameter>opacity</parameter>&#160;:</term>
434
 
<listitem><simpara> The opacity of the endpoint.
435
 
</simpara></listitem></varlistentry>
436
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
437
 
 
438
 
</simpara></listitem></varlistentry>
439
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
440
 
<refsect2 id="gimp-gradient-segment-set-right-color" role="function" condition="since:GIMP 2.2">
441
 
<title>gimp_gradient_segment_set_right_color ()</title>
442
 
<indexterm zone="gimp-gradient-segment-set-right-color" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_set_right_color">gimp_gradient_segment_set_right_color</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_set_right_color
443
 
                                                        (const <link linkend="gchar">gchar</link> *name,
444
 
                                                         <link linkend="gint">gint</link> segment,
445
 
                                                         const <link linkend="GimpRGB">GimpRGB</link> *color,
446
 
                                                         <link linkend="gdouble">gdouble</link> opacity);</programlisting>
447
 
<para>
448
 
Sets the right endpoint color of the specified segment
449
 
</para>
450
 
<para>
451
 
This procedure sets the right endpoint color of the specified
452
 
segment of the specified gradient.</para>
453
 
<para>
454
 
</para><variablelist role="params">
455
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
456
 
<listitem><simpara> The gradient name.
457
 
</simpara></listitem></varlistentry>
458
 
<varlistentry><term><parameter>segment</parameter>&#160;:</term>
459
 
<listitem><simpara> The index of the segment within the gradient.
460
 
</simpara></listitem></varlistentry>
461
 
<varlistentry><term><parameter>color</parameter>&#160;:</term>
462
 
<listitem><simpara> The color to set.
463
 
</simpara></listitem></varlistentry>
464
 
<varlistentry><term><parameter>opacity</parameter>&#160;:</term>
465
 
<listitem><simpara> The opacity to set for the endpoint.
466
 
</simpara></listitem></varlistentry>
467
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
468
 
 
469
 
</simpara></listitem></varlistentry>
470
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
471
 
<refsect2 id="gimp-gradient-segment-get-left-pos" role="function" condition="since:GIMP 2.2">
472
 
<title>gimp_gradient_segment_get_left_pos ()</title>
473
 
<indexterm zone="gimp-gradient-segment-get-left-pos" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_get_left_pos">gimp_gradient_segment_get_left_pos</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_get_left_pos  (const <link linkend="gchar">gchar</link> *name,
474
 
                                                         <link linkend="gint">gint</link> segment,
475
 
                                                         <link linkend="gdouble">gdouble</link> *pos);</programlisting>
476
 
<para>
477
 
Retrieves the left endpoint position of the specified segment
478
 
</para>
479
 
<para>
480
 
This procedure retrieves the left endpoint position of the specified
481
 
segment of the specified gradient.</para>
482
 
<para>
483
 
</para><variablelist role="params">
484
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
485
 
<listitem><simpara> The gradient name.
486
 
</simpara></listitem></varlistentry>
487
 
<varlistentry><term><parameter>segment</parameter>&#160;:</term>
488
 
<listitem><simpara> The index of the segment within the gradient.
489
 
</simpara></listitem></varlistentry>
490
 
<varlistentry><term><parameter>pos</parameter>&#160;:</term>
491
 
<listitem><simpara> The return position.
492
 
</simpara></listitem></varlistentry>
493
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
494
 
 
495
 
</simpara></listitem></varlistentry>
496
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
497
 
<refsect2 id="gimp-gradient-segment-set-left-pos" role="function" condition="since:GIMP 2.2">
498
 
<title>gimp_gradient_segment_set_left_pos ()</title>
499
 
<indexterm zone="gimp-gradient-segment-set-left-pos" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_set_left_pos">gimp_gradient_segment_set_left_pos</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_set_left_pos  (const <link linkend="gchar">gchar</link> *name,
500
 
                                                         <link linkend="gint">gint</link> segment,
501
 
                                                         <link linkend="gdouble">gdouble</link> pos,
502
 
                                                         <link linkend="gdouble">gdouble</link> *final_pos);</programlisting>
503
 
<para>
504
 
Sets the left endpoint position of the specified segment
505
 
</para>
506
 
<para>
507
 
This procedure sets the left endpoint position of the specified
508
 
segment of the specified gradient. The final position will be
509
 
between the position of the middle point to the left to the middle
510
 
point of the current segement. This procedure returns the final
511
 
position.</para>
512
 
<para>
513
 
</para><variablelist role="params">
514
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
515
 
<listitem><simpara> The gradient name.
516
 
</simpara></listitem></varlistentry>
517
 
<varlistentry><term><parameter>segment</parameter>&#160;:</term>
518
 
<listitem><simpara> The index of the segment within the gradient.
519
 
</simpara></listitem></varlistentry>
520
 
<varlistentry><term><parameter>pos</parameter>&#160;:</term>
521
 
<listitem><simpara> The position to set the guidepoint to.
522
 
</simpara></listitem></varlistentry>
523
 
<varlistentry><term><parameter>final_pos</parameter>&#160;:</term>
524
 
<listitem><simpara> The return position.
525
 
</simpara></listitem></varlistentry>
526
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
527
 
 
528
 
</simpara></listitem></varlistentry>
529
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
530
 
<refsect2 id="gimp-gradient-segment-get-middle-pos" role="function" condition="since:GIMP 2.2">
531
 
<title>gimp_gradient_segment_get_middle_pos ()</title>
532
 
<indexterm zone="gimp-gradient-segment-get-middle-pos" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_get_middle_pos">gimp_gradient_segment_get_middle_pos</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_get_middle_pos
533
 
                                                        (const <link linkend="gchar">gchar</link> *name,
534
 
                                                         <link linkend="gint">gint</link> segment,
535
 
                                                         <link linkend="gdouble">gdouble</link> *pos);</programlisting>
536
 
<para>
537
 
Retrieves the middle point position of the specified segment
538
 
</para>
539
 
<para>
540
 
This procedure retrieves the middle point position of the specified
541
 
segment of the specified gradient.</para>
542
 
<para>
543
 
</para><variablelist role="params">
544
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
545
 
<listitem><simpara> The gradient name.
546
 
</simpara></listitem></varlistentry>
547
 
<varlistentry><term><parameter>segment</parameter>&#160;:</term>
548
 
<listitem><simpara> The index of the segment within the gradient.
549
 
</simpara></listitem></varlistentry>
550
 
<varlistentry><term><parameter>pos</parameter>&#160;:</term>
551
 
<listitem><simpara> The return position.
552
 
</simpara></listitem></varlistentry>
553
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
554
 
 
555
 
</simpara></listitem></varlistentry>
556
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
557
 
<refsect2 id="gimp-gradient-segment-set-middle-pos" role="function" condition="since:GIMP 2.2">
558
 
<title>gimp_gradient_segment_set_middle_pos ()</title>
559
 
<indexterm zone="gimp-gradient-segment-set-middle-pos" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_set_middle_pos">gimp_gradient_segment_set_middle_pos</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_set_middle_pos
560
 
                                                        (const <link linkend="gchar">gchar</link> *name,
561
 
                                                         <link linkend="gint">gint</link> segment,
562
 
                                                         <link linkend="gdouble">gdouble</link> pos,
563
 
                                                         <link linkend="gdouble">gdouble</link> *final_pos);</programlisting>
564
 
<para>
565
 
Sets the middle point position of the specified segment
566
 
</para>
567
 
<para>
568
 
This procedure sets the middle point position of the specified
569
 
segment of the specified gradient. The final position will be
570
 
between the two endpoints of the segment. This procedure returns the
571
 
final position.</para>
572
 
<para>
573
 
</para><variablelist role="params">
574
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
575
 
<listitem><simpara> The gradient name.
576
 
</simpara></listitem></varlistentry>
577
 
<varlistentry><term><parameter>segment</parameter>&#160;:</term>
578
 
<listitem><simpara> The index of the segment within the gradient.
579
 
</simpara></listitem></varlistentry>
580
 
<varlistentry><term><parameter>pos</parameter>&#160;:</term>
581
 
<listitem><simpara> The position to set the guidepoint to.
582
 
</simpara></listitem></varlistentry>
583
 
<varlistentry><term><parameter>final_pos</parameter>&#160;:</term>
584
 
<listitem><simpara> The return position.
585
 
</simpara></listitem></varlistentry>
586
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
587
 
 
588
 
</simpara></listitem></varlistentry>
589
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
590
 
<refsect2 id="gimp-gradient-segment-get-right-pos" role="function" condition="since:GIMP 2.2">
591
 
<title>gimp_gradient_segment_get_right_pos ()</title>
592
 
<indexterm zone="gimp-gradient-segment-get-right-pos" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_get_right_pos">gimp_gradient_segment_get_right_pos</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_get_right_pos (const <link linkend="gchar">gchar</link> *name,
593
 
                                                         <link linkend="gint">gint</link> segment,
594
 
                                                         <link linkend="gdouble">gdouble</link> *pos);</programlisting>
595
 
<para>
596
 
Retrieves the right endpoint position of the specified segment
597
 
</para>
598
 
<para>
599
 
This procedure retrieves the right endpoint position of the
600
 
specified segment of the specified gradient.</para>
601
 
<para>
602
 
</para><variablelist role="params">
603
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
604
 
<listitem><simpara> The gradient name.
605
 
</simpara></listitem></varlistentry>
606
 
<varlistentry><term><parameter>segment</parameter>&#160;:</term>
607
 
<listitem><simpara> The index of the segment within the gradient.
608
 
</simpara></listitem></varlistentry>
609
 
<varlistentry><term><parameter>pos</parameter>&#160;:</term>
610
 
<listitem><simpara> The return position.
611
 
</simpara></listitem></varlistentry>
612
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
613
 
 
614
 
</simpara></listitem></varlistentry>
615
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
616
 
<refsect2 id="gimp-gradient-segment-set-right-pos" role="function" condition="since:GIMP 2.2">
617
 
<title>gimp_gradient_segment_set_right_pos ()</title>
618
 
<indexterm zone="gimp-gradient-segment-set-right-pos" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_set_right_pos">gimp_gradient_segment_set_right_pos</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_set_right_pos (const <link linkend="gchar">gchar</link> *name,
619
 
                                                         <link linkend="gint">gint</link> segment,
620
 
                                                         <link linkend="gdouble">gdouble</link> pos,
621
 
                                                         <link linkend="gdouble">gdouble</link> *final_pos);</programlisting>
622
 
<para>
623
 
Sets the right endpoint position of the specified segment
624
 
</para>
625
 
<para>
626
 
This procedure sets the right endpoint position of the specified
627
 
segment of the specified gradient. The final position will be
628
 
between the position of the middle point of the current segment and
629
 
the middle point of the segment to the right. This procedure returns
630
 
the final position.</para>
631
 
<para>
632
 
</para><variablelist role="params">
633
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
634
 
<listitem><simpara> The gradient name.
635
 
</simpara></listitem></varlistentry>
636
 
<varlistentry><term><parameter>segment</parameter>&#160;:</term>
637
 
<listitem><simpara> The index of the segment within the gradient.
638
 
</simpara></listitem></varlistentry>
639
 
<varlistentry><term><parameter>pos</parameter>&#160;:</term>
640
 
<listitem><simpara> The position to set the guidepoint to.
641
 
</simpara></listitem></varlistentry>
642
 
<varlistentry><term><parameter>final_pos</parameter>&#160;:</term>
643
 
<listitem><simpara> The return position.
644
 
</simpara></listitem></varlistentry>
645
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
646
 
 
647
 
</simpara></listitem></varlistentry>
648
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
649
 
<refsect2 id="gimp-gradient-segment-get-blending-function" role="function" condition="since:GIMP 2.2">
650
 
<title>gimp_gradient_segment_get_blending_function ()</title>
651
 
<indexterm zone="gimp-gradient-segment-get-blending-function" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_get_blending_function">gimp_gradient_segment_get_blending_function</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_get_blending_function
652
 
                                                        (const <link linkend="gchar">gchar</link> *name,
653
 
                                                         <link linkend="gint">gint</link> segment,
654
 
                                                         <link linkend="GimpGradientSegmentType">GimpGradientSegmentType</link> *blend_func);</programlisting>
655
 
<para>
656
 
Retrieves the gradient segment's blending function
657
 
</para>
658
 
<para>
659
 
This procedure retrieves the blending function of the segment at the
660
 
specified gradient name and segment index.</para>
661
 
<para>
662
 
</para><variablelist role="params">
663
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
664
 
<listitem><simpara> The gradient name.
665
 
</simpara></listitem></varlistentry>
666
 
<varlistentry><term><parameter>segment</parameter>&#160;:</term>
667
 
<listitem><simpara> The index of the segment within the gradient.
668
 
</simpara></listitem></varlistentry>
669
 
<varlistentry><term><parameter>blend_func</parameter>&#160;:</term>
670
 
<listitem><simpara> The blending function of the segment.
671
 
</simpara></listitem></varlistentry>
672
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
673
 
 
674
 
</simpara></listitem></varlistentry>
675
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
676
 
<refsect2 id="gimp-gradient-segment-get-coloring-type" role="function" condition="since:GIMP 2.2">
677
 
<title>gimp_gradient_segment_get_coloring_type ()</title>
678
 
<indexterm zone="gimp-gradient-segment-get-coloring-type" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_get_coloring_type">gimp_gradient_segment_get_coloring_type</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_get_coloring_type
679
 
                                                        (const <link linkend="gchar">gchar</link> *name,
680
 
                                                         <link linkend="gint">gint</link> segment,
681
 
                                                         <link linkend="GimpGradientSegmentColor">GimpGradientSegmentColor</link> *coloring_type);</programlisting>
682
 
<para>
683
 
Retrieves the gradient segment's coloring type
684
 
</para>
685
 
<para>
686
 
This procedure retrieves the coloring type of the segment at the
687
 
specified gradient name and segment index.</para>
688
 
<para>
689
 
</para><variablelist role="params">
690
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
691
 
<listitem><simpara> The gradient name.
692
 
</simpara></listitem></varlistentry>
693
 
<varlistentry><term><parameter>segment</parameter>&#160;:</term>
694
 
<listitem><simpara> The index of the segment within the gradient.
695
 
</simpara></listitem></varlistentry>
696
 
<varlistentry><term><parameter>coloring_type</parameter>&#160;:</term>
697
 
<listitem><simpara> The coloring type of the segment.
698
 
</simpara></listitem></varlistentry>
699
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
700
 
 
701
 
</simpara></listitem></varlistentry>
702
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
703
 
<refsect2 id="gimp-gradient-segment-range-set-blending-function" role="function" condition="since:GIMP 2.2">
704
 
<title>gimp_gradient_segment_range_set_blending_function ()</title>
705
 
<indexterm zone="gimp-gradient-segment-range-set-blending-function" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_set_blending_function">gimp_gradient_segment_range_set_blending_function</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_range_set_blending_function
706
 
                                                        (const <link linkend="gchar">gchar</link> *name,
707
 
                                                         <link linkend="gint">gint</link> start_segment,
708
 
                                                         <link linkend="gint">gint</link> end_segment,
709
 
                                                         <link linkend="GimpGradientSegmentType">GimpGradientSegmentType</link> blending_function);</programlisting>
710
 
<para>
711
 
Change the blending function of a segments range
712
 
</para>
713
 
<para>
714
 
This function changes the blending function of a segment range to
715
 
the specified blending function.</para>
716
 
<para>
717
 
</para><variablelist role="params">
718
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
719
 
<listitem><simpara> The gradient name.
720
 
</simpara></listitem></varlistentry>
721
 
<varlistentry><term><parameter>start_segment</parameter>&#160;:</term>
722
 
<listitem><simpara> The index of the first segment to operate on.
723
 
</simpara></listitem></varlistentry>
724
 
<varlistentry><term><parameter>end_segment</parameter>&#160;:</term>
725
 
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
726
 
</simpara></listitem></varlistentry>
727
 
<varlistentry><term><parameter>blending_function</parameter>&#160;:</term>
728
 
<listitem><simpara> The blending function.
729
 
</simpara></listitem></varlistentry>
730
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
731
 
 
732
 
</simpara></listitem></varlistentry>
733
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
734
 
<refsect2 id="gimp-gradient-segment-range-set-coloring-type" role="function" condition="since:GIMP 2.2">
735
 
<title>gimp_gradient_segment_range_set_coloring_type ()</title>
736
 
<indexterm zone="gimp-gradient-segment-range-set-coloring-type" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_set_coloring_type">gimp_gradient_segment_range_set_coloring_type</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_range_set_coloring_type
737
 
                                                        (const <link linkend="gchar">gchar</link> *name,
738
 
                                                         <link linkend="gint">gint</link> start_segment,
739
 
                                                         <link linkend="gint">gint</link> end_segment,
740
 
                                                         <link linkend="GimpGradientSegmentColor">GimpGradientSegmentColor</link> coloring_type);</programlisting>
741
 
<para>
742
 
Change the coloring type of a segments range
743
 
</para>
744
 
<para>
745
 
This function changes the coloring type of a segment range to the
746
 
specified coloring type.</para>
747
 
<para>
748
 
</para><variablelist role="params">
749
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
750
 
<listitem><simpara> The gradient name.
751
 
</simpara></listitem></varlistentry>
752
 
<varlistentry><term><parameter>start_segment</parameter>&#160;:</term>
753
 
<listitem><simpara> The index of the first segment to operate on.
754
 
</simpara></listitem></varlistentry>
755
 
<varlistentry><term><parameter>end_segment</parameter>&#160;:</term>
756
 
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
757
 
</simpara></listitem></varlistentry>
758
 
<varlistentry><term><parameter>coloring_type</parameter>&#160;:</term>
759
 
<listitem><simpara> The coloring type.
760
 
</simpara></listitem></varlistentry>
761
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
762
 
 
763
 
</simpara></listitem></varlistentry>
764
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
765
 
<refsect2 id="gimp-gradient-segment-range-flip" role="function" condition="since:GIMP 2.2">
766
 
<title>gimp_gradient_segment_range_flip ()</title>
767
 
<indexterm zone="gimp-gradient-segment-range-flip" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_flip">gimp_gradient_segment_range_flip</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_range_flip    (const <link linkend="gchar">gchar</link> *name,
768
 
                                                         <link linkend="gint">gint</link> start_segment,
769
 
                                                         <link linkend="gint">gint</link> end_segment);</programlisting>
770
 
<para>
771
 
Flip the segment range
772
 
</para>
773
 
<para>
774
 
This function flips a segment range.</para>
775
 
<para>
776
 
</para><variablelist role="params">
777
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
778
 
<listitem><simpara> The gradient name.
779
 
</simpara></listitem></varlistentry>
780
 
<varlistentry><term><parameter>start_segment</parameter>&#160;:</term>
781
 
<listitem><simpara> The index of the first segment to operate on.
782
 
</simpara></listitem></varlistentry>
783
 
<varlistentry><term><parameter>end_segment</parameter>&#160;:</term>
784
 
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
785
 
</simpara></listitem></varlistentry>
786
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
787
 
 
788
 
</simpara></listitem></varlistentry>
789
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
790
 
<refsect2 id="gimp-gradient-segment-range-replicate" role="function" condition="since:GIMP 2.2">
791
 
<title>gimp_gradient_segment_range_replicate ()</title>
792
 
<indexterm zone="gimp-gradient-segment-range-replicate" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_replicate">gimp_gradient_segment_range_replicate</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_range_replicate
793
 
                                                        (const <link linkend="gchar">gchar</link> *name,
794
 
                                                         <link linkend="gint">gint</link> start_segment,
795
 
                                                         <link linkend="gint">gint</link> end_segment,
796
 
                                                         <link linkend="gint">gint</link> replicate_times);</programlisting>
797
 
<para>
798
 
Replicate the segment range
799
 
</para>
800
 
<para>
801
 
This function replicates a segment range a given number of times.
802
 
Instead of the original segment range, several smaller scaled copies
803
 
of it will appear in equal widths.</para>
804
 
<para>
805
 
</para><variablelist role="params">
806
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
807
 
<listitem><simpara> The gradient name.
808
 
</simpara></listitem></varlistentry>
809
 
<varlistentry><term><parameter>start_segment</parameter>&#160;:</term>
810
 
<listitem><simpara> The index of the first segment to operate on.
811
 
</simpara></listitem></varlistentry>
812
 
<varlistentry><term><parameter>end_segment</parameter>&#160;:</term>
813
 
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
814
 
</simpara></listitem></varlistentry>
815
 
<varlistentry><term><parameter>replicate_times</parameter>&#160;:</term>
816
 
<listitem><simpara> The number of times to replicate.
817
 
</simpara></listitem></varlistentry>
818
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
819
 
 
820
 
</simpara></listitem></varlistentry>
821
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
822
 
<refsect2 id="gimp-gradient-segment-range-split-midpoint" role="function" condition="since:GIMP 2.2">
823
 
<title>gimp_gradient_segment_range_split_midpoint ()</title>
824
 
<indexterm zone="gimp-gradient-segment-range-split-midpoint" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_split_midpoint">gimp_gradient_segment_range_split_midpoint</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_range_split_midpoint
825
 
                                                        (const <link linkend="gchar">gchar</link> *name,
826
 
                                                         <link linkend="gint">gint</link> start_segment,
827
 
                                                         <link linkend="gint">gint</link> end_segment);</programlisting>
828
 
<para>
829
 
Splits each segment in the segment range at midpoint
830
 
</para>
831
 
<para>
832
 
This function splits each segment in the segment range at its
833
 
midpoint.</para>
834
 
<para>
835
 
</para><variablelist role="params">
836
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
837
 
<listitem><simpara> The gradient name.
838
 
</simpara></listitem></varlistentry>
839
 
<varlistentry><term><parameter>start_segment</parameter>&#160;:</term>
840
 
<listitem><simpara> The index of the first segment to operate on.
841
 
</simpara></listitem></varlistentry>
842
 
<varlistentry><term><parameter>end_segment</parameter>&#160;:</term>
843
 
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
844
 
</simpara></listitem></varlistentry>
845
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
846
 
 
847
 
</simpara></listitem></varlistentry>
848
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
849
 
<refsect2 id="gimp-gradient-segment-range-split-uniform" role="function" condition="since:GIMP 2.2">
850
 
<title>gimp_gradient_segment_range_split_uniform ()</title>
851
 
<indexterm zone="gimp-gradient-segment-range-split-uniform" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_split_uniform">gimp_gradient_segment_range_split_uniform</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_range_split_uniform
852
 
                                                        (const <link linkend="gchar">gchar</link> *name,
853
 
                                                         <link linkend="gint">gint</link> start_segment,
854
 
                                                         <link linkend="gint">gint</link> end_segment,
855
 
                                                         <link linkend="gint">gint</link> split_parts);</programlisting>
856
 
<para>
857
 
Splits each segment in the segment range uniformly
858
 
</para>
859
 
<para>
860
 
This function splits each segment in the segment range uniformly
861
 
according to the number of times specified by the parameter.</para>
862
 
<para>
863
 
</para><variablelist role="params">
864
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
865
 
<listitem><simpara> The gradient name.
866
 
</simpara></listitem></varlistentry>
867
 
<varlistentry><term><parameter>start_segment</parameter>&#160;:</term>
868
 
<listitem><simpara> The index of the first segment to operate on.
869
 
</simpara></listitem></varlistentry>
870
 
<varlistentry><term><parameter>end_segment</parameter>&#160;:</term>
871
 
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
872
 
</simpara></listitem></varlistentry>
873
 
<varlistentry><term><parameter>split_parts</parameter>&#160;:</term>
874
 
<listitem><simpara> The number of uniform divisions to split each segment to.
875
 
</simpara></listitem></varlistentry>
876
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
877
 
 
878
 
</simpara></listitem></varlistentry>
879
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
880
 
<refsect2 id="gimp-gradient-segment-range-delete" role="function" condition="since:GIMP 2.2">
881
 
<title>gimp_gradient_segment_range_delete ()</title>
882
 
<indexterm zone="gimp-gradient-segment-range-delete" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_delete">gimp_gradient_segment_range_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_range_delete  (const <link linkend="gchar">gchar</link> *name,
883
 
                                                         <link linkend="gint">gint</link> start_segment,
884
 
                                                         <link linkend="gint">gint</link> end_segment);</programlisting>
885
 
<para>
886
 
Delete the segment range
887
 
</para>
888
 
<para>
889
 
This function deletes a segment range.</para>
890
 
<para>
891
 
</para><variablelist role="params">
892
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
893
 
<listitem><simpara> The gradient name.
894
 
</simpara></listitem></varlistentry>
895
 
<varlistentry><term><parameter>start_segment</parameter>&#160;:</term>
896
 
<listitem><simpara> The index of the first segment to operate on.
897
 
</simpara></listitem></varlistentry>
898
 
<varlistentry><term><parameter>end_segment</parameter>&#160;:</term>
899
 
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
900
 
</simpara></listitem></varlistentry>
901
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
902
 
 
903
 
</simpara></listitem></varlistentry>
904
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
905
 
<refsect2 id="gimp-gradient-segment-range-redistribute-handles" role="function" condition="since:GIMP 2.2">
906
 
<title>gimp_gradient_segment_range_redistribute_handles ()</title>
907
 
<indexterm zone="gimp-gradient-segment-range-redistribute-handles" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_redistribute_handles">gimp_gradient_segment_range_redistribute_handles</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_range_redistribute_handles
908
 
                                                        (const <link linkend="gchar">gchar</link> *name,
909
 
                                                         <link linkend="gint">gint</link> start_segment,
910
 
                                                         <link linkend="gint">gint</link> end_segment);</programlisting>
911
 
<para>
912
 
Uniformly redistribute the segment range's handles
913
 
</para>
914
 
<para>
915
 
This function redistributes the handles of the specified segment
916
 
range of the specified gradient, so they'll be evenly spaced.</para>
917
 
<para>
918
 
</para><variablelist role="params">
919
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
920
 
<listitem><simpara> The gradient name.
921
 
</simpara></listitem></varlistentry>
922
 
<varlistentry><term><parameter>start_segment</parameter>&#160;:</term>
923
 
<listitem><simpara> The index of the first segment to operate on.
924
 
</simpara></listitem></varlistentry>
925
 
<varlistentry><term><parameter>end_segment</parameter>&#160;:</term>
926
 
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
927
 
</simpara></listitem></varlistentry>
928
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
929
 
 
930
 
</simpara></listitem></varlistentry>
931
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
932
 
<refsect2 id="gimp-gradient-segment-range-blend-colors" role="function" condition="since:GIMP 2.2">
933
 
<title>gimp_gradient_segment_range_blend_colors ()</title>
934
 
<indexterm zone="gimp-gradient-segment-range-blend-colors" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_blend_colors">gimp_gradient_segment_range_blend_colors</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_range_blend_colors
935
 
                                                        (const <link linkend="gchar">gchar</link> *name,
936
 
                                                         <link linkend="gint">gint</link> start_segment,
937
 
                                                         <link linkend="gint">gint</link> end_segment);</programlisting>
938
 
<para>
939
 
Blend the colors of the segment range.
940
 
</para>
941
 
<para>
942
 
This function blends the colors (but not the opacity) of the
943
 
segments' range of the gradient. Using it, the colors' transition
944
 
will be uniform across the range.</para>
945
 
<para>
946
 
</para><variablelist role="params">
947
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
948
 
<listitem><simpara> The gradient name.
949
 
</simpara></listitem></varlistentry>
950
 
<varlistentry><term><parameter>start_segment</parameter>&#160;:</term>
951
 
<listitem><simpara> The index of the first segment to operate on.
952
 
</simpara></listitem></varlistentry>
953
 
<varlistentry><term><parameter>end_segment</parameter>&#160;:</term>
954
 
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
955
 
</simpara></listitem></varlistentry>
956
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
957
 
 
958
 
</simpara></listitem></varlistentry>
959
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
960
 
<refsect2 id="gimp-gradient-segment-range-blend-opacity" role="function" condition="since:GIMP 2.2">
961
 
<title>gimp_gradient_segment_range_blend_opacity ()</title>
962
 
<indexterm zone="gimp-gradient-segment-range-blend-opacity" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_blend_opacity">gimp_gradient_segment_range_blend_opacity</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_gradient_segment_range_blend_opacity
963
 
                                                        (const <link linkend="gchar">gchar</link> *name,
964
 
                                                         <link linkend="gint">gint</link> start_segment,
965
 
                                                         <link linkend="gint">gint</link> end_segment);</programlisting>
966
 
<para>
967
 
Blend the opacity of the segment range.
968
 
</para>
969
 
<para>
970
 
This function blends the opacity (but not the colors) of the
971
 
segments' range of the gradient. Using it, the opacity's transition
972
 
will be uniform across the range.</para>
973
 
<para>
974
 
</para><variablelist role="params">
975
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
976
 
<listitem><simpara> The gradient name.
977
 
</simpara></listitem></varlistentry>
978
 
<varlistentry><term><parameter>start_segment</parameter>&#160;:</term>
979
 
<listitem><simpara> The index of the first segment to operate on.
980
 
</simpara></listitem></varlistentry>
981
 
<varlistentry><term><parameter>end_segment</parameter>&#160;:</term>
982
 
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
983
 
</simpara></listitem></varlistentry>
984
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
985
 
 
986
 
</simpara></listitem></varlistentry>
987
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
988
 
<refsect2 id="gimp-gradient-segment-range-move" role="function" condition="since:GIMP 2.2">
989
 
<title>gimp_gradient_segment_range_move ()</title>
990
 
<indexterm zone="gimp-gradient-segment-range-move" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_move">gimp_gradient_segment_range_move</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_gradient_segment_range_move    (const <link linkend="gchar">gchar</link> *name,
991
 
                                                         <link linkend="gint">gint</link> start_segment,
992
 
                                                         <link linkend="gint">gint</link> end_segment,
993
 
                                                         <link linkend="gdouble">gdouble</link> delta,
994
 
                                                         <link linkend="gboolean">gboolean</link> control_compress);</programlisting>
995
 
<para>
996
 
Move the position of an entire segment range by a delta.
997
 
</para>
998
 
<para>
999
 
This funtions moves the position of an entire segment range by a
1000
 
delta. The actual delta (which is returned) will be limited by the
1001
 
control points of the neighboring segments.</para>
1002
 
<para>
1003
 
</para><variablelist role="params">
1004
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
1005
 
<listitem><simpara> The gradient name.
1006
 
</simpara></listitem></varlistentry>
1007
 
<varlistentry><term><parameter>start_segment</parameter>&#160;:</term>
1008
 
<listitem><simpara> The index of the first segment to operate on.
1009
 
</simpara></listitem></varlistentry>
1010
 
<varlistentry><term><parameter>end_segment</parameter>&#160;:</term>
1011
 
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
1012
 
</simpara></listitem></varlistentry>
1013
 
<varlistentry><term><parameter>delta</parameter>&#160;:</term>
1014
 
<listitem><simpara> The delta to move the segment range.
1015
 
</simpara></listitem></varlistentry>
1016
 
<varlistentry><term><parameter>control_compress</parameter>&#160;:</term>
1017
 
<listitem><simpara> Whether or not to compress the neighboring segments.
1018
 
</simpara></listitem></varlistentry>
1019
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The final delta by which the range moved.
1020
 
 
1021
 
</simpara></listitem></varlistentry>
1022
 
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
1023
 
 
1024
 
</refsect1>
1025
 
 
1026
 
 
1027
 
 
1028
 
 
1029
 
</refentry>