callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Imported Upstream version 2.4.0~rc2

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:22:44 -04:00
parent d884b2912c
commit 4be5597e32
576 changed files with 70261 additions and 80724 deletions
Download Patch File Download Diff File Expand all files Collapse all files

218
devel-docs/libgimp/html/libgimp-gimpgradients.html
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.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<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">
@ -31,16 +31,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="#id2568916" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2581732" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2691406" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2708866" 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="id2568916"></a><span class="refentrytitle">gimpgradients</span>
<a name="id2581732"></a><span class="refentrytitle">gimpgradients</span>
</h2>
<p>gimpgradients &#8212; Operations related to gradients.</p>
</td>
@ -52,78 +52,36 @@
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpgradients.html#gimp-gradients-refresh">gimp_gradients_refresh</a> (void);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>** <a href="libgimp-gimpgradients.html#gimp-gradients-get-list">gimp_gradients_get_list</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *filter,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *num_gradients);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="libgimp-gimpgradients.html#gimp-gradients-get-gradient">gimp_gradients_get_gradient</a> (void);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libgimp-gimpgradients.html#gimp-gradients-set-gradient">gimp_gradients_set_gradient</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a>* <a href="libgimp-gimpgradients.html#gimp-gradients-sample-uniform">gimp_gradients_sample_uniform</a> (<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> num_samples,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> reverse);
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a>* <a href="libgimp-gimpgradients.html#gimp-gradients-sample-custom">gimp_gradients_sample_custom</a> (<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> num_samples,
const <a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *positions,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> reverse);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="libgimp-gimpgradients.html#gimp-gradients-get-gradient-data">gimp_gradients_get_gradient_data</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> sample_size,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> reverse,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *width,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> **grad_data);
gboolean <a class="link" href="libgimp-gimpgradients.html#gimp-gradients-refresh">gimp_gradients_refresh</a> (void);
gchar** <a class="link" href="libgimp-gimpgradients.html#gimp-gradients-get-list">gimp_gradients_get_list</a> (const gchar *filter,
gint *num_gradients);
gchar* <a class="link" href="libgimp-gimpgradients.html#gimp-gradients-get-gradient">gimp_gradients_get_gradient</a> (void);
gboolean <a class="link" href="libgimp-gimpgradients.html#gimp-gradients-set-gradient">gimp_gradients_set_gradient</a> (const gchar *name);
gdouble* <a class="link" href="libgimp-gimpgradients.html#gimp-gradients-sample-uniform">gimp_gradients_sample_uniform</a> (gint num_samples,
gboolean reverse);
gdouble* <a class="link" href="libgimp-gimpgradients.html#gimp-gradients-sample-custom">gimp_gradients_sample_custom</a> (gint num_samples,
const gdouble *positions,
gboolean reverse);
gchar* <a class="link" 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="id2691406"></a><h2>Description</h2>
<a name="id2708866"></a><h2>Description</h2>
<p>
Operations related to gradients.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2691422"></a><h2>Details</h2>
<a name="id2708882"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2691432"></a><h3>
<a name="id2708892"></a><h3>
<a name="gimp-gradients-refresh"></a>gimp_gradients_refresh ()</h3>
<a class="indexterm" name="id2691444"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_gradients_refresh (void);</pre>
<a class="indexterm" name="id2708903"></a><pre class="programlisting">gboolean gimp_gradients_refresh (void);</pre>
<p>
Refresh current gradients. This function always succeeds.
</p>
@ -136,7 +94,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><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr></tbody>
@ -144,22 +102,16 @@ gradient path and updates the gradient dialogs accordingly.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2691489"></a><h3>
<a name="id2708949"></a><h3>
<a name="gimp-gradients-get-list"></a>gimp_gradients_get_list ()</h3>
<a class="indexterm" name="id2691500"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>** gimp_gradients_get_list (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *filter,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *num_gradients);</pre>
<a class="indexterm" name="id2708960"></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 <a href="libgimp-gimpcontext.html#gimp-context-set-gradient"><code class="function">gimp_context_set_gradient()</code></a> function
loaded. You can later use the <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-gradient"><code class="function">gimp_context_set_gradient()</code></a> function
to set the active gradient.</p>
<p>
@ -168,17 +120,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><p><span class="term"><em class="parameter"><code>filter</code></em>&#160;:</span></p></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><p><span class="term"><em class="parameter"><code>num_gradients</code></em>&#160;:</span></p></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><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The list of gradient names.
</td>
</tr>
@ -187,24 +139,22 @@ to set the active gradient.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2671362"></a><h3>
<a name="id2686646"></a><h3>
<a name="gimp-gradients-get-gradient"></a>gimp_gradients_get_gradient ()</h3>
<a class="indexterm" name="id2671376"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_gradients_get_gradient (void);</pre>
<a class="indexterm" name="id2686659"></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>
This procedure is deprecated! Use <a class="link" 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>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The name of the active gradient.
</td>
</tr></tbody>
@ -212,19 +162,15 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2671436"></a><h3>
<a name="id2686719"></a><h3>
<a name="gimp-gradients-set-gradient"></a>gimp_gradients_set_gradient ()</h3>
<a class="indexterm" name="id2671449"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_gradients_set_gradient (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<a class="indexterm" name="id2686733"></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>
This procedure is deprecated! Use <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-gradient"><code class="function">gimp_context_set_gradient()</code></a> instead.</p>
<p>
</p>
@ -232,12 +178,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><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></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><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
@ -246,23 +192,17 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2671529"></a><h3>
<a name="id2686813"></a><h3>
<a name="gimp-gradients-sample-uniform"></a>gimp_gradients_sample_uniform ()</h3>
<a class="indexterm" name="id2671543"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a>* gimp_gradients_sample_uniform (<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> num_samples,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> reverse);</pre>
<a class="indexterm" name="id2686826"></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>
<a class="link" href="libgimp-gimpgradient.html#gimp-gradient-get-uniform-samples"><code class="function">gimp_gradient_get_uniform_samples()</code></a> instead.</p>
<p>
</p>
@ -270,17 +210,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><p><span class="term"><em class="parameter"><code>num_samples</code></em>&#160;:</span></p></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><p><span class="term"><em class="parameter"><code>reverse</code></em>&#160;:</span></p></td>
<td> Use the reverse gradient.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.
</td>
</tr>
@ -289,25 +229,17 @@ This procedure is deprecated! Use
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2669752"></a><h3>
<a name="id2688215"></a><h3>
<a name="gimp-gradients-sample-custom"></a>gimp_gradients_sample_custom ()</h3>
<a class="indexterm" name="id2669767"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a>* gimp_gradients_sample_custom (<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> num_samples,
const <a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *positions,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> reverse);</pre>
<a class="indexterm" name="id2688229"></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>
This procedure is deprecated! Use <a class="link" href="libgimp-gimpgradient.html#gimp-gradient-get-custom-samples"><code class="function">gimp_gradient_get_custom_samples()</code></a>
instead.</p>
<p>
@ -316,22 +248,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><p><span class="term"><em class="parameter"><code>num_samples</code></em>&#160;:</span></p></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><p><span class="term"><em class="parameter"><code>positions</code></em>&#160;:</span></p></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><p><span class="term"><em class="parameter"><code>reverse</code></em>&#160;:</span></p></td>
<td> Use the reverse gradient.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.
</td>
</tr>
@ -340,32 +272,20 @@ instead.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2669895"></a><h3>
<a name="id2688355"></a><h3>
<a name="gimp-gradients-get-gradient-data"></a>gimp_gradients_get_gradient_data ()</h3>
<a class="indexterm" name="id2669911"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_gradients_get_gradient_data (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> sample_size,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> reverse,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *width,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> **grad_data);</pre>
<a class="indexterm" name="id2688371"></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>
<a class="link" href="libgimp-gimpgradient.html#gimp-gradient-get-uniform-samples"><code class="function">gimp_gradient_get_uniform_samples()</code></a> instead.</p>
<p>
</p>
@ -373,32 +293,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><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></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><p><span class="term"><em class="parameter"><code>sample_size</code></em>&#160;:</span></p></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><p><span class="term"><em class="parameter"><code>reverse</code></em>&#160;:</span></p></td>
<td> Use the reverse gradient.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></p></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><p><span class="term"><em class="parameter"><code>grad_data</code></em>&#160;:</span></p></td>
<td> The gradient sample data.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The gradient name.
</td>
</tr>