1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpgradients</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-data.html" title="Data Objects">
<link rel="prev" href="libgimp-gimpgradient.html" title="gimpgradient">
<link rel="next" href="libgimp-gimppalette.html" title="gimppalette">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gimpdefinitions.html" title="Part I. GIMP Constants">
<link rel="part" href="libgimp.html" title="Part II. GIMP Library">
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="part" href="libgimpui.html" title="Part III. GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimp-gimpgradient.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-data.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimppalette.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2539871" class="shortcut">Top</a>
 | 
<a href="#id2632482" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimpgradients"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2539871"></a><span class="refentrytitle">gimpgradients</span>
</h2>
<p>gimpgradients — Operations related to gradients.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
gboolean <a href="libgimp-gimpgradients.html#gimp-gradients-refresh">gimp_gradients_refresh</a> (void);
gchar** <a href="libgimp-gimpgradients.html#gimp-gradients-get-list">gimp_gradients_get_list</a> (const gchar *filter,
gint *num_gradients);
gchar* <a href="libgimp-gimpgradients.html#gimp-gradients-get-gradient">gimp_gradients_get_gradient</a> (void);
gboolean <a href="libgimp-gimpgradients.html#gimp-gradients-set-gradient">gimp_gradients_set_gradient</a> (const gchar *name);
gdouble* <a href="libgimp-gimpgradients.html#gimp-gradients-sample-uniform">gimp_gradients_sample_uniform</a> (gint num_samples,
gboolean reverse);
gdouble* <a href="libgimp-gimpgradients.html#gimp-gradients-sample-custom">gimp_gradients_sample_custom</a> (gint num_samples,
const gdouble *positions,
gboolean reverse);
gchar* <a href="libgimp-gimpgradients.html#gimp-gradients-get-gradient-data">gimp_gradients_get_gradient_data</a>
(const gchar *name,
gint sample_size,
gboolean reverse,
gint *width,
gdouble **grad_data);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2632482"></a><h2>Description</h2>
<p>
Operations related to gradients.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2632497"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2632508"></a><h3>
<a name="gimp-gradients-refresh"></a>gimp_gradients_refresh ()</h3>
<a class="indexterm" name="id2632519"></a><pre class="programlisting">gboolean gimp_gradients_refresh (void);</pre>
<p>
Refresh current gradients. This function always succeeds.
</p>
<p>
This procedure retrieves all gradients currently in the user's
gradient path and updates the gradient dialogs accordingly.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2632563"></a><h3>
<a name="gimp-gradients-get-list"></a>gimp_gradients_get_list ()</h3>
<a class="indexterm" name="id2632574"></a><pre class="programlisting">gchar** gimp_gradients_get_list (const gchar *filter,
gint *num_gradients);</pre>
<p>
Retrieve the list of loaded gradients.
</p>
<p>
This procedure returns a list of the gradients that are currently
loaded. You can later use the 'gimp_context_set_gradient' function
to set the active gradient.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>filter</code></em> :</span></td>
<td> An optional regular expression used to filter the list.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>num_gradients</code></em> :</span></td>
<td> The number of loaded gradients.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The list of gradient names.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2631176"></a><h3>
<a name="gimp-gradients-get-gradient"></a>gimp_gradients_get_gradient ()</h3>
<a class="indexterm" name="id2631189"></a><pre class="programlisting">gchar* gimp_gradients_get_gradient (void);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_gradients_get_gradient</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-get-gradient"><code class="function">gimp_context_get_gradient()</code></a> instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The name of the active gradient.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2631249"></a><h3>
<a name="gimp-gradients-set-gradient"></a>gimp_gradients_set_gradient ()</h3>
<a class="indexterm" name="id2631263"></a><pre class="programlisting">gboolean gimp_gradients_set_gradient (const gchar *name);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_gradients_set_gradient</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-set-gradient"><code class="function">gimp_context_set_gradient()</code></a> instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The name of the gradient to set.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2631342"></a><h3>
<a name="gimp-gradients-sample-uniform"></a>gimp_gradients_sample_uniform ()</h3>
<a class="indexterm" name="id2631355"></a><pre class="programlisting">gdouble* gimp_gradients_sample_uniform (gint num_samples,
gboolean reverse);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_gradients_sample_uniform</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use
<a href="libgimp-gimpgradient.html#gimp-gradient-get-uniform-samples"><code class="function">gimp_gradient_get_uniform_samples()</code></a> instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>num_samples</code></em> :</span></td>
<td> The number of samples to take.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>reverse</code></em> :</span></td>
<td> Use the reverse gradient.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630074"></a><h3>
<a name="gimp-gradients-sample-custom"></a>gimp_gradients_sample_custom ()</h3>
<a class="indexterm" name="id2630087"></a><pre class="programlisting">gdouble* gimp_gradients_sample_custom (gint num_samples,
const gdouble *positions,
gboolean reverse);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_gradients_sample_custom</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a href="libgimp-gimpgradient.html#gimp-gradient-get-custom-samples"><code class="function">gimp_gradient_get_custom_samples()</code></a>
instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>num_samples</code></em> :</span></td>
<td> The number of samples to take.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>positions</code></em> :</span></td>
<td> The list of positions to sample along the gradient.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>reverse</code></em> :</span></td>
<td> Use the reverse gradient.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630214"></a><h3>
<a name="gimp-gradients-get-gradient-data"></a>gimp_gradients_get_gradient_data ()</h3>
<a class="indexterm" name="id2630230"></a><pre class="programlisting">gchar* gimp_gradients_get_gradient_data
(const gchar *name,
gint sample_size,
gboolean reverse,
gint *width,
gdouble **grad_data);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_gradients_get_gradient_data</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use
<a href="libgimp-gimpgradient.html#gimp-gradient-get-uniform-samples"><code class="function">gimp_gradient_get_uniform_samples()</code></a> instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The gradient name (\"\" means current active gradient).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>sample_size</code></em> :</span></td>
<td> Size of the sample to return when the gradient is changed.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>reverse</code></em> :</span></td>
<td> Use the reverse gradient.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em> :</span></td>
<td> The gradient sample width (r,g,b,a).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>grad_data</code></em> :</span></td>
<td> The gradient sample data.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The gradient name.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|
