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

Imported Upstream version 2.3.6

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:18:19 -04:00
parent 7802c3a9cb
commit de5dc4f4c2
3129 changed files with 762016 additions and 525609 deletions
Download Patch File Download Diff File Expand all files Collapse all files

168
devel-docs/libgimp/html/libgimp-gimpgradients.html
View File

@ -1,14 +1,13 @@
<!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.72.0">
<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.8 (XML mode)">
<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&#160;I.&#160;GIMP Constants">
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;GIMP Library">
@ -18,27 +17,24 @@
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="part" href="libgimpui.html" title="Part&#160;III.&#160;GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="ix03.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="ix04.html" title="Index of deprecated symbols">
</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">
<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>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2597912" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2664815" class="shortcut">Description</a></nobr></td></tr>
</table>
</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="id2597912"></a><span class="refentrytitle">gimpgradients</span>
</h2>
<h2><span class="refentrytitle">gimpgradients</span></h2>
<p>gimpgradients &#8212; Operations related to gradients.</p>
</td>
<td valign="top" align="right"></td>
@ -49,36 +45,37 @@
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);
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="id2664815"></a><h2>Description</h2>
<a name="id2624885"></a><h2>Description</h2>
<p>
Operations related to gradients.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2665245"></a><h2>Details</h2>
<a name="id2624896"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2665256"></a><h3>
<a name="id2624902"></a><h3>
<a name="gimp-gradients-refresh"></a>gimp_gradients_refresh ()</h3>
<a class="indexterm" name="id2665267"></a><pre class="programlisting">gboolean gimp_gradients_refresh (void);</pre>
<a class="indexterm" name="id2624911"></a><pre class="programlisting">gboolean gimp_gradients_refresh (void);</pre>
<p>
Refresh current gradients. This function always succeeds.
</p>
@ -91,7 +88,8 @@ 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>
@ -99,16 +97,16 @@ gradient path and updates the gradient dialogs accordingly.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2665313"></a><h3>
<a name="id2624437"></a><h3>
<a name="gimp-gradients-get-list"></a>gimp_gradients_get_list ()</h3>
<a class="indexterm" name="id2665324"></a><pre class="programlisting">gchar** gimp_gradients_get_list (const gchar *filter,
gint *num_gradients);</pre>
<a class="indexterm" name="id2624446"></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
loaded. You can later use the 'gimp-context-set-gradient' function
to set the active gradient.</p>
<p>
@ -117,17 +115,20 @@ 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>
@ -136,9 +137,9 @@ to set the active gradient.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2672116"></a><h3>
<a name="id2624532"></a><h3>
<a name="gimp-gradients-get-gradient"></a>gimp_gradients_get_gradient ()</h3>
<a class="indexterm" name="id2672130"></a><pre class="programlisting">gchar* gimp_gradients_get_gradient (void);</pre>
<a class="indexterm" name="id2624541"></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>
@ -151,7 +152,8 @@ 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>
@ -159,9 +161,9 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2672190"></a><h3>
<a name="id2638470"></a><h3>
<a name="gimp-gradients-set-gradient"></a>gimp_gradients_set_gradient ()</h3>
<a class="indexterm" name="id2672203"></a><pre class="programlisting">gboolean gimp_gradients_set_gradient (const gchar *name);</pre>
<a class="indexterm" name="id2638479"></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>
@ -175,12 +177,14 @@ 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>
@ -189,10 +193,10 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2672283"></a><h3>
<a name="id2638558"></a><h3>
<a name="gimp-gradients-sample-uniform"></a>gimp_gradients_sample_uniform ()</h3>
<a class="indexterm" name="id2672297"></a><pre class="programlisting">gdouble* gimp_gradients_sample_uniform (gint num_samples,
gboolean reverse);</pre>
<a class="indexterm" name="id2638567"></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>
@ -207,17 +211,20 @@ 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>
@ -226,11 +233,11 @@ This procedure is deprecated! Use
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2666176"></a><h3>
<a name="id2638669"></a><h3>
<a name="gimp-gradients-sample-custom"></a>gimp_gradients_sample_custom ()</h3>
<a class="indexterm" name="id2666189"></a><pre class="programlisting">gdouble* gimp_gradients_sample_custom (gint num_samples,
const gdouble *positions,
gboolean reverse);</pre>
<a class="indexterm" name="id2638680"></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>
@ -245,22 +252,26 @@ 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>
@ -269,13 +280,14 @@ instead.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2666314"></a><h3>
<a name="id2628023"></a><h3>
<a name="gimp-gradients-get-gradient-data"></a>gimp_gradients_get_gradient_data ()</h3>
<a class="indexterm" name="id2666327"></a><pre class="programlisting">gchar* gimp_gradients_get_gradient_data (const gchar *name,
gint sample_size,
gboolean reverse,
gint *width,
gdouble **grad_data);</pre>
<a class="indexterm" name="id2628034"></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>
@ -290,32 +302,38 @@ 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>
@ -324,5 +342,9 @@ This procedure is deprecated! Use
</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>&lt;&lt;&#160;gimpgradient</b></a></td>
<td align="right"><a accesskey="n" href="libgimp-gimppalette.html"><b>gimppalette&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>