Imported Upstream version 2.2.14

This commit is contained in:
Ari Pollak
2010-08-11 01:17:12 -04:00
parent 70ad8213cf
commit a2f097051e
490 changed files with 35329 additions and 58398 deletions

View File

@ -3,7 +3,7 @@
<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">
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<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">
@ -28,16 +28,16 @@
<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>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2595888" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2632482" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2665761" 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>
<a name="id2595888"></a><span class="refentrytitle">gimpgradients</span>
</h2>
<p>gimpgradients &#8212; Operations related to gradients.</p>
</td>
@ -68,18 +68,18 @@ gchar* <a href="libgimp-gimpgradients.html#gimp-gradients-get-gradient-data
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2632482"></a><h2>Description</h2>
<a name="id2665761"></a><h2>Description</h2>
<p>
Operations related to gradients.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2632497"></a><h2>Details</h2>
<a name="id2663544"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2632508"></a><h3>
<a name="id2663554"></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>
<a class="indexterm" name="id2663566"></a><pre class="programlisting">gboolean gimp_gradients_refresh (void);</pre>
<p>
Refresh current gradients. This function always succeeds.
</p>
@ -92,8 +92,7 @@ gradient path and updates the gradient dialogs accordingly.</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>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr></tbody>
@ -101,9 +100,9 @@ gradient path and updates the gradient dialogs accordingly.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2632563"></a><h3>
<a name="id2663610"></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,
<a class="indexterm" name="id2663621"></a><pre class="programlisting">gchar** gimp_gradients_get_list (const gchar *filter,
gint *num_gradients);</pre>
<p>
Retrieve the list of loaded gradients.
@ -119,20 +118,17 @@ to set the active gradient.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>filter</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>filter</code></em>&#160;:</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>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>num_gradients</code></em>&#160;:</span></td>
<td> The number of loaded gradients.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The list of gradient names.
</td>
</tr>
@ -141,9 +137,9 @@ to set the active gradient.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2631176"></a><h3>
<a name="id2664483"></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>
<a class="indexterm" name="id2664497"></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>
@ -156,8 +152,7 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The name of the active gradient.
</td>
</tr></tbody>
@ -165,9 +160,9 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2631249"></a><h3>
<a name="id2664557"></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>
<a class="indexterm" name="id2664570"></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>
@ -181,14 +176,12 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The name of the gradient to set.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
@ -197,9 +190,9 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2631342"></a><h3>
<a name="id2664649"></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,
<a class="indexterm" name="id2664663"></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>
@ -215,20 +208,17 @@ This procedure is deprecated! Use
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>num_samples</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>num_samples</code></em>&#160;:</span></td>
<td> The number of samples to take.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>reverse</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>reverse</code></em>&#160;:</span></td>
<td> Use the reverse gradient.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.
</td>
</tr>
@ -237,9 +227,9 @@ This procedure is deprecated! Use
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630074"></a><h3>
<a name="id2663022"></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,
<a class="indexterm" name="id2663036"></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;">
@ -256,26 +246,22 @@ instead.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>num_samples</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>num_samples</code></em>&#160;:</span></td>
<td> The number of samples to take.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>positions</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>positions</code></em>&#160;:</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>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>reverse</code></em>&#160;:</span></td>
<td> Use the reverse gradient.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.
</td>
</tr>
@ -284,9 +270,9 @@ instead.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630214"></a><h3>
<a name="id2663159"></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
<a class="indexterm" name="id2663174"></a><pre class="programlisting">gchar* gimp_gradients_get_gradient_data
(const gchar *name,
gint sample_size,
gboolean reverse,
@ -306,38 +292,32 @@ This procedure is deprecated! Use
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</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>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>sample_size</code></em>&#160;:</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>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>reverse</code></em>&#160;:</span></td>
<td> Use the reverse gradient.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</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>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>grad_data</code></em>&#160;:</span></td>
<td> The gradient sample data.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The gradient name.
</td>
</tr>