Adding upstream version 2.10.22.upstream/2.10.22 upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
author: Daniel Baumann <daniel.baumann@progress-linux.org> 2024-04-27 16:23:22 +0000
committer: Daniel Baumann <daniel.baumann@progress-linux.org> 2024-04-27 16:23:22 +0000
commit: e42129241681dde7adae7d20697e7b421682fbb4 (patch)
tree: af1fe815a5e639e68e59fabd8395ec69458b3e5e /devel-docs/libgimp/html/libgimp-gimpgradients.html
parent: Initial commit. (diff)
download: gimp-e42129241681dde7adae7d20697e7b421682fbb4.tar.xz
gimp-e42129241681dde7adae7d20697e7b421682fbb4.zip
1 files changed, 336 insertions, 0 deletions
diff --git a/devel-docs/libgimp/html/libgimp-gimpgradients.html b/devel-docs/libgimp/html/libgimp-gimpgradients.html
new file mode 100644
index 0000000..890d594
--- /dev/null
+++ b/devel-docs/libgimp/html/libgimp-gimpgradients.html
@@ -0,0 +1,336 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>gimpgradients: GIMP Library Reference Manual</title>
+<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
+<link rel="home" 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.32 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</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="5"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
+                  <a href="#libgimp-gimpgradients.description" class="shortcut">Description</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="libgimp-data.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="libgimp-gimpgradient.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="libgimp-gimppalette.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="libgimp-gimpgradients"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="libgimp-gimpgradients.top_of_page"></a>gimpgradients</span></h2>
+<p>gimpgradients — Operations related to gradients.</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="libgimp-gimpgradients.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_proto_type">
+<col class="functions_proto_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="libgimp-gimpgradients.html#gimp-gradients-refresh" title="gimp_gradients_refresh ()">gimp_gradients_refresh</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gchar</span> **
+</td>
+<td class="function_name">
+<a class="link" href="libgimp-gimpgradients.html#gimp-gradients-get-list" title="gimp_gradients_get_list ()">gimp_gradients_get_list</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gchar</span> *
+</td>
+<td class="function_name">
+<a class="link" href="libgimp-gimpgradients.html#gimp-gradients-get-gradient" title="gimp_gradients_get_gradient ()">gimp_gradients_get_gradient</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="libgimp-gimpgradients.html#gimp-gradients-set-gradient" title="gimp_gradients_set_gradient ()">gimp_gradients_set_gradient</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gdouble</span> *
+</td>
+<td class="function_name">
+<a class="link" href="libgimp-gimpgradients.html#gimp-gradients-sample-uniform" title="gimp_gradients_sample_uniform ()">gimp_gradients_sample_uniform</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gdouble</span> *
+</td>
+<td class="function_name">
+<a class="link" href="libgimp-gimpgradients.html#gimp-gradients-sample-custom" title="gimp_gradients_sample_custom ()">gimp_gradients_sample_custom</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gchar</span> *
+</td>
+<td class="function_name">
+<a class="link" href="libgimp-gimpgradients.html#gimp-gradients-get-gradient-data" title="gimp_gradients_get_gradient_data ()">gimp_gradients_get_gradient_data</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="libgimp-gimpgradients.description"></a><h2>Description</h2>
+<p>Operations related to gradients.</p>
+</div>
+<div class="refsect1">
+<a name="libgimp-gimpgradients.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="gimp-gradients-refresh"></a><h3>gimp_gradients_refresh ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gimp_gradients_refresh (<em class="parameter"><code><span class="type">void</span></code></em>);</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>
+<div class="refsect3">
+<a name="gimp-gradients-refresh.returns"></a><h4>Returns</h4>
+<p> TRUE on success.</p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gimp-gradients-get-list"></a><h3>gimp_gradients_get_list ()</h3>
+<pre class="programlisting"><span class="returnvalue">gchar</span> **
+gimp_gradients_get_list (<em class="parameter"><code>const <span class="type">gchar</span> *filter</code></em>,
+                         <em class="parameter"><code><span class="type">gint</span> *num_gradients</code></em>);</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 class="link" href="libgimp-gimpcontext.html#gimp-context-set-gradient" title="gimp_context_set_gradient ()"><code class="function">gimp_context_set_gradient()</code></a> function
+to set the active gradient.</p>
+<div class="refsect3">
+<a name="gimp-gradients-get-list.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>filter</p></td>
+<td class="parameter_description"><p>An optional regular expression used to filter the list.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>num_gradients</p></td>
+<td class="parameter_description"><p>The number of loaded gradients.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="gimp-gradients-get-list.returns"></a><h4>Returns</h4>
+<p> The list of gradient names. The returned value must be
+freed with <code class="function">g_strfreev()</code>.</p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gimp-gradients-get-gradient"></a><h3>gimp_gradients_get_gradient ()</h3>
+<pre class="programlisting"><span class="returnvalue">gchar</span> *
+gimp_gradients_get_gradient (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<div class="warning"><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 class="link" href="libgimp-gimpcontext.html#gimp-context-get-gradient" title="gimp_context_get_gradient ()"><code class="function">gimp_context_get_gradient()</code></a> instead.</p>
+<div class="refsect3">
+<a name="gimp-gradients-get-gradient.returns"></a><h4>Returns</h4>
+<p> The name of the active gradient.</p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gimp-gradients-set-gradient"></a><h3>gimp_gradients_set_gradient ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gimp_gradients_set_gradient (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
+<div class="warning"><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 class="link" href="libgimp-gimpcontext.html#gimp-context-set-gradient" title="gimp_context_set_gradient ()"><code class="function">gimp_context_set_gradient()</code></a> instead.</p>
+<div class="refsect3">
+<a name="gimp-gradients-set-gradient.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>name</p></td>
+<td class="parameter_description"><p>The name of the gradient to set.</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="gimp-gradients-set-gradient.returns"></a><h4>Returns</h4>
+<p> TRUE on success.</p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gimp-gradients-sample-uniform"></a><h3>gimp_gradients_sample_uniform ()</h3>
+<pre class="programlisting"><span class="returnvalue">gdouble</span> *
+gimp_gradients_sample_uniform (<em class="parameter"><code><span class="type">gint</span> num_samples</code></em>,
+                               <em class="parameter"><code><span class="type">gboolean</span> reverse</code></em>);</pre>
+<div class="warning">
+<p><code class="literal">gimp_gradients_sample_uniform</code> is deprecated and should not be used in newly-written code.</p>
+<p>Use <a class="link" href="libgimp-gimpgradient.html#gimp-gradient-get-uniform-samples" title="gimp_gradient_get_uniform_samples ()"><code class="function">gimp_gradient_get_uniform_samples()</code></a> instead.</p>
+</div>
+<div class="refsect3">
+<a name="gimp-gradients-sample-uniform.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>num_samples</p></td>
+<td class="parameter_description"><p>The number of samples to take.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>reverse</p></td>
+<td class="parameter_description"><p>Use the reverse gradient.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="gimp-gradients-sample-uniform.returns"></a><h4>Returns</h4>
+<p> Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.</p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gimp-gradients-sample-custom"></a><h3>gimp_gradients_sample_custom ()</h3>
+<pre class="programlisting"><span class="returnvalue">gdouble</span> *
+gimp_gradients_sample_custom (<em class="parameter"><code><span class="type">gint</span> num_samples</code></em>,
+                              <em class="parameter"><code>const <span class="type">gdouble</span> *positions</code></em>,
+                              <em class="parameter"><code><span class="type">gboolean</span> reverse</code></em>);</pre>
+<div class="warning">
+<p><code class="literal">gimp_gradients_sample_custom</code> is deprecated and should not be used in newly-written code.</p>
+<p>Use <a class="link" href="libgimp-gimpgradient.html#gimp-gradient-get-custom-samples" title="gimp_gradient_get_custom_samples ()"><code class="function">gimp_gradient_get_custom_samples()</code></a> instead.</p>
+</div>
+<div class="refsect3">
+<a name="gimp-gradients-sample-custom.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>num_samples</p></td>
+<td class="parameter_description"><p>The number of samples to take.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>positions</p></td>
+<td class="parameter_description"><p>The list of positions to sample along the gradient.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>reverse</p></td>
+<td class="parameter_description"><p>Use the reverse gradient.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="gimp-gradients-sample-custom.returns"></a><h4>Returns</h4>
+<p> Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.</p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gimp-gradients-get-gradient-data"></a><h3>gimp_gradients_get_gradient_data ()</h3>
+<pre class="programlisting"><span class="returnvalue">gchar</span> *
+gimp_gradients_get_gradient_data (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
+                                  <em class="parameter"><code><span class="type">gint</span> sample_size</code></em>,
+                                  <em class="parameter"><code><span class="type">gboolean</span> reverse</code></em>,
+                                  <em class="parameter"><code><span class="type">gint</span> *width</code></em>,
+                                  <em class="parameter"><code><span class="type">gdouble</span> **grad_data</code></em>);</pre>
+<div class="warning">
+<p><code class="literal">gimp_gradients_get_gradient_data</code> is deprecated and should not be used in newly-written code.</p>
+<p>Use <a class="link" href="libgimp-gimpgradient.html#gimp-gradient-get-uniform-samples" title="gimp_gradient_get_uniform_samples ()"><code class="function">gimp_gradient_get_uniform_samples()</code></a> instead.</p>
+</div>
+<div class="refsect3">
+<a name="gimp-gradients-get-gradient-data.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>name</p></td>
+<td class="parameter_description"><p>The gradient name (\"\" means current active gradient).</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>sample_size</p></td>
+<td class="parameter_description"><p>Size of the sample to return when the gradient is changed.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>reverse</p></td>
+<td class="parameter_description"><p>Use the reverse gradient.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>width</p></td>
+<td class="parameter_description"><p>The gradient sample width (r,g,b,a).</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>grad_data</p></td>
+<td class="parameter_description"><p>The gradient sample data.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="gimp-gradients-get-gradient-data.returns"></a><h4>Returns</h4>
+<p> The gradient name.</p>
+</div>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>Generated by GTK-Doc V1.32</div>
+</body>
+</html>
+\ No newline at end of file
author	Daniel Baumann <daniel.baumann@progress-linux.org>	2024-04-27 16:23:22 +0000
committer	Daniel Baumann <daniel.baumann@progress-linux.org>	2024-04-27 16:23:22 +0000
commit	e42129241681dde7adae7d20697e7b421682fbb4 (patch)
tree	af1fe815a5e639e68e59fabd8395ec69458b3e5e /devel-docs/libgimp/html/libgimp-gimpgradients.html
parent	Initial commit. (diff)
download	gimp-e42129241681dde7adae7d20697e7b421682fbb4.tar.xz gimp-e42129241681dde7adae7d20697e7b421682fbb4.zip