347 lines
13 KiB
HTML
347 lines
13 KiB
HTML
<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.4 (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" 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></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><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="id2619538"></a><h2>Description</h2>
|
|
<p>
|
|
Operations related to gradients.
|
|
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2619549"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2619555"></a><h3>
|
|
<a name="gimp-gradients-refresh"></a>gimp_gradients_refresh ()</h3>
|
|
<a class="indexterm" name="id2619564"></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="id2618921"></a><h3>
|
|
<a name="gimp-gradients-get-list"></a>gimp_gradients_get_list ()</h3>
|
|
<a class="indexterm" name="id2618930"></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="id2619017"></a><h3>
|
|
<a name="gimp-gradients-get-gradient"></a>gimp_gradients_get_gradient ()</h3>
|
|
<a class="indexterm" name="id2619026"></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="id2619086"></a><h3>
|
|
<a name="gimp-gradients-set-gradient"></a>gimp_gradients_set_gradient ()</h3>
|
|
<a class="indexterm" name="id2619095"></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="id2617979"></a><h3>
|
|
<a name="gimp-gradients-sample-uniform"></a>gimp_gradients_sample_uniform ()</h3>
|
|
<a class="indexterm" name="id2617988"></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="id2618089"></a><h3>
|
|
<a name="gimp-gradients-sample-custom"></a>gimp_gradients_sample_custom ()</h3>
|
|
<a class="indexterm" name="id2618098"></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="id2618220"></a><h3>
|
|
<a name="gimp-gradients-get-gradient-data"></a>gimp_gradients_get_gradient_data ()</h3>
|
|
<a class="indexterm" name="id2618230"></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>
|
|
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
|
|
<td align="left"><a accesskey="p" href="libgimp-gimpgradient.html"><b><< gimpgradient</b></a></td>
|
|
<td align="right"><a accesskey="n" href="libgimp-gimppalette.html"><b>gimppalette >></b></a></td>
|
|
</tr></table>
|
|
</body>
|
|
</html>
|