1747 lines
56 KiB
HTML
1747 lines
56 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>gimpgradient</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-gimpfonts.html" title="gimpfonts">
|
|
<link rel="next" href="libgimp-gimpgradients.html" title="gimpgradients">
|
|
<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-gimpfonts.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-gimpgradients.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-gimpgradient"></a><div class="titlepage"></div>
|
|
<div class="refnamediv"><table width="100%"><tr>
|
|
<td valign="top">
|
|
<h2><span class="refentrytitle">gimpgradient</span></h2>
|
|
<p>gimpgradient — Functions operating on a single gradient.</p>
|
|
</td>
|
|
<td valign="top" align="right"></td>
|
|
</tr></table></div>
|
|
<div class="refsynopsisdiv">
|
|
<h2>Synopsis</h2>
|
|
<pre class="synopsis">
|
|
|
|
|
|
|
|
gchar* <a href="libgimp-gimpgradient.html#gimp-gradient-new">gimp_gradient_new</a> (const gchar *name);
|
|
gchar* <a href="libgimp-gimpgradient.html#gimp-gradient-duplicate">gimp_gradient_duplicate</a> (const gchar *name);
|
|
gchar* <a href="libgimp-gimpgradient.html#gimp-gradient-rename">gimp_gradient_rename</a> (const gchar *name,
|
|
const gchar *new_name);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-delete">gimp_gradient_delete</a> (const gchar *name);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-get-uniform-samples">gimp_gradient_get_uniform_samples</a>
|
|
(const gchar *name,
|
|
gint num_samples,
|
|
gboolean reverse,
|
|
gint *num_color_samples,
|
|
gdouble **color_samples);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-get-custom-samples">gimp_gradient_get_custom_samples</a>
|
|
(const gchar *name,
|
|
gint num_samples,
|
|
const gdouble *positions,
|
|
gboolean reverse,
|
|
gint *num_color_samples,
|
|
gdouble **color_samples);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-get-left-color">gimp_gradient_segment_get_left_color</a>
|
|
(const gchar *name,
|
|
gint segment,
|
|
<a
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *color,
|
|
gdouble *opacity);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-set-left-color">gimp_gradient_segment_set_left_color</a>
|
|
(const gchar *name,
|
|
gint segment,
|
|
const <a
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *color,
|
|
gdouble opacity);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-get-right-color">gimp_gradient_segment_get_right_color</a>
|
|
(const gchar *name,
|
|
gint segment,
|
|
<a
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *color,
|
|
gdouble *opacity);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-set-right-color">gimp_gradient_segment_set_right_color</a>
|
|
(const gchar *name,
|
|
gint segment,
|
|
const <a
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *color,
|
|
gdouble opacity);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-get-left-pos">gimp_gradient_segment_get_left_pos</a>
|
|
(const gchar *name,
|
|
gint segment,
|
|
gdouble *pos);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-set-left-pos">gimp_gradient_segment_set_left_pos</a>
|
|
(const gchar *name,
|
|
gint segment,
|
|
gdouble pos,
|
|
gdouble *final_pos);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-get-middle-pos">gimp_gradient_segment_get_middle_pos</a>
|
|
(const gchar *name,
|
|
gint segment,
|
|
gdouble *pos);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-set-middle-pos">gimp_gradient_segment_set_middle_pos</a>
|
|
(const gchar *name,
|
|
gint segment,
|
|
gdouble pos,
|
|
gdouble *final_pos);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-get-right-pos">gimp_gradient_segment_get_right_pos</a>
|
|
(const gchar *name,
|
|
gint segment,
|
|
gdouble *pos);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-set-right-pos">gimp_gradient_segment_set_right_pos</a>
|
|
(const gchar *name,
|
|
gint segment,
|
|
gdouble pos,
|
|
gdouble *final_pos);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-get-blending-function">gimp_gradient_segment_get_blending_function</a>
|
|
(const gchar *name,
|
|
gint segment,
|
|
<a href="libgimp-gimpenums.html#GimpGradientSegmentType">GimpGradientSegmentType</a> *blend_func);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-get-coloring-type">gimp_gradient_segment_get_coloring_type</a>
|
|
(const gchar *name,
|
|
gint segment,
|
|
<a href="libgimp-gimpenums.html#GimpGradientSegmentColor">GimpGradientSegmentColor</a> *coloring_type);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-range-set-blending-function">gimp_gradient_segment_range_set_blending_function</a>
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment,
|
|
<a href="libgimp-gimpenums.html#GimpGradientSegmentType">GimpGradientSegmentType</a> blending_function);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-range-set-coloring-type">gimp_gradient_segment_range_set_coloring_type</a>
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment,
|
|
<a href="libgimp-gimpenums.html#GimpGradientSegmentColor">GimpGradientSegmentColor</a> coloring_type);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-range-flip">gimp_gradient_segment_range_flip</a>
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-range-replicate">gimp_gradient_segment_range_replicate</a>
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment,
|
|
gint replicate_times);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-range-split-midpoint">gimp_gradient_segment_range_split_midpoint</a>
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-range-split-uniform">gimp_gradient_segment_range_split_uniform</a>
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment,
|
|
gint split_parts);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-range-delete">gimp_gradient_segment_range_delete</a>
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-range-redistribute-handles">gimp_gradient_segment_range_redistribute_handles</a>
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-range-blend-colors">gimp_gradient_segment_range_blend_colors</a>
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment);
|
|
gboolean <a href="libgimp-gimpgradient.html#gimp-gradient-segment-range-blend-opacity">gimp_gradient_segment_range_blend_opacity</a>
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment);
|
|
gdouble <a href="libgimp-gimpgradient.html#gimp-gradient-segment-range-move">gimp_gradient_segment_range_move</a>
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment,
|
|
gdouble delta,
|
|
gboolean control_compress);
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2632347"></a><h2>Description</h2>
|
|
<p>
|
|
Functions operating on a single gradient.
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2632358"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2632363"></a><h3>
|
|
<a name="gimp-gradient-new"></a>gimp_gradient_new ()</h3>
|
|
<a class="indexterm" name="id2632372"></a><pre class="programlisting">gchar* gimp_gradient_new (const gchar *name);</pre>
|
|
<p>
|
|
Creates a new gradient
|
|
</p>
|
|
<p>
|
|
This procedure creates a new, uninitialized 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>name</code></em> :</span></td>
|
|
<td> The requested name of the new gradient.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The actual new gradient name.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2523731"></a><h3>
|
|
<a name="gimp-gradient-duplicate"></a>gimp_gradient_duplicate ()</h3>
|
|
<a class="indexterm" name="id2592939"></a><pre class="programlisting">gchar* gimp_gradient_duplicate (const gchar *name);</pre>
|
|
<p>
|
|
Duplicates a gradient
|
|
</p>
|
|
<p>
|
|
This procedure creates an identical gradient by a different name</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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The name of the gradient's copy.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2632488"></a><h3>
|
|
<a name="gimp-gradient-rename"></a>gimp_gradient_rename ()</h3>
|
|
<a class="indexterm" name="id2632497"></a><pre class="programlisting">gchar* gimp_gradient_rename (const gchar *name,
|
|
const gchar *new_name);</pre>
|
|
<p>
|
|
Rename a gradient
|
|
</p>
|
|
<p>
|
|
This procedure renames a 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>name</code></em> :</span></td>
|
|
<td> The gradient name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>new_name</code></em> :</span></td>
|
|
<td> The new name of the gradient.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The actual new name of the gradient.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2632577"></a><h3>
|
|
<a name="gimp-gradient-delete"></a>gimp_gradient_delete ()</h3>
|
|
<a class="indexterm" name="id2632586"></a><pre class="programlisting">gboolean gimp_gradient_delete (const gchar *name);</pre>
|
|
<p>
|
|
Deletes a gradient
|
|
</p>
|
|
<p>
|
|
This procedure deletes a 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>name</code></em> :</span></td>
|
|
<td> The gradient name.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2632646"></a><h3>
|
|
<a name="gimp-gradient-get-uniform-samples"></a>gimp_gradient_get_uniform_samples ()</h3>
|
|
<a class="indexterm" name="id2632656"></a><pre class="programlisting">gboolean gimp_gradient_get_uniform_samples
|
|
(const gchar *name,
|
|
gint num_samples,
|
|
gboolean reverse,
|
|
gint *num_color_samples,
|
|
gdouble **color_samples);</pre>
|
|
<p>
|
|
Sample the specified in uniform parts.
|
|
</p>
|
|
<p>
|
|
This procedure samples the active gradient in the specified number
|
|
of uniform parts. It returns a list of floating-point values which
|
|
correspond to the RGBA values for each sample. The minimum number of
|
|
samples to take is 2, in which case the returned colors will
|
|
correspond to the { 0.0, 1.0 } positions in the gradient. For
|
|
example, if the number of samples is 3, the procedure will return
|
|
the colors at positions { 0.0, 0.5, 1.0 }.</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.
|
|
</td>
|
|
</tr>
|
|
<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"><em class="parameter"><code>num_color_samples</code></em> :</span></td>
|
|
<td> Length of the color_samples array (4 * num_samples).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>color_samples</code></em> :</span></td>
|
|
<td> Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2632803"></a><h3>
|
|
<a name="gimp-gradient-get-custom-samples"></a>gimp_gradient_get_custom_samples ()</h3>
|
|
<a class="indexterm" name="id2632813"></a><pre class="programlisting">gboolean gimp_gradient_get_custom_samples
|
|
(const gchar *name,
|
|
gint num_samples,
|
|
const gdouble *positions,
|
|
gboolean reverse,
|
|
gint *num_color_samples,
|
|
gdouble **color_samples);</pre>
|
|
<p>
|
|
Sample the spacified gradient in custom positions.
|
|
</p>
|
|
<p>
|
|
This procedure samples the active gradient in the specified number
|
|
of points. The procedure will sample the gradient in the specified
|
|
positions from the list. The left endpoint of the gradient
|
|
corresponds to position 0.0, and the right endpoint corresponds to
|
|
1.0. The procedure returns a list of floating-point values which
|
|
correspond to the RGBA values for each sample.</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.
|
|
</td>
|
|
</tr>
|
|
<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"><em class="parameter"><code>num_color_samples</code></em> :</span></td>
|
|
<td> Length of the color_samples array (4 * num_samples).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>color_samples</code></em> :</span></td>
|
|
<td> Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2632981"></a><h3>
|
|
<a name="gimp-gradient-segment-get-left-color"></a>gimp_gradient_segment_get_left_color ()</h3>
|
|
<a class="indexterm" name="id2632992"></a><pre class="programlisting">gboolean gimp_gradient_segment_get_left_color
|
|
(const gchar *name,
|
|
gint segment,
|
|
<a
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *color,
|
|
gdouble *opacity);</pre>
|
|
<p>
|
|
Retrieves the left endpoint color of the specified gradient and
|
|
segment
|
|
</p>
|
|
<p>
|
|
This procedure retrieves the left endpoint color of the specified
|
|
segment of the specified 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>name</code></em> :</span></td>
|
|
<td> The gradient name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>segment</code></em> :</span></td>
|
|
<td> The index of the segment within the gradient.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>color</code></em> :</span></td>
|
|
<td> The return color.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
|
|
<td> The opacity of the endpoint.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2633116"></a><h3>
|
|
<a name="gimp-gradient-segment-set-left-color"></a>gimp_gradient_segment_set_left_color ()</h3>
|
|
<a class="indexterm" name="id2633127"></a><pre class="programlisting">gboolean gimp_gradient_segment_set_left_color
|
|
(const gchar *name,
|
|
gint segment,
|
|
const <a
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *color,
|
|
gdouble opacity);</pre>
|
|
<p>
|
|
Retrieves the left endpoint color of the specified gradient and
|
|
segment
|
|
</p>
|
|
<p>
|
|
This procedure retrieves the left endpoint color of the specified
|
|
segment of the specified 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>name</code></em> :</span></td>
|
|
<td> The gradient name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>segment</code></em> :</span></td>
|
|
<td> The index of the segment within the gradient.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>color</code></em> :</span></td>
|
|
<td> The color to set.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
|
|
<td> The opacity to set for the endpoint.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2633251"></a><h3>
|
|
<a name="gimp-gradient-segment-get-right-color"></a>gimp_gradient_segment_get_right_color ()</h3>
|
|
<a class="indexterm" name="id2633262"></a><pre class="programlisting">gboolean gimp_gradient_segment_get_right_color
|
|
(const gchar *name,
|
|
gint segment,
|
|
<a
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *color,
|
|
gdouble *opacity);</pre>
|
|
<p>
|
|
Retrieves the right endpoint color of the specified gradient and
|
|
segment
|
|
</p>
|
|
<p>
|
|
This procedure retrieves the right endpoint color of the specified
|
|
segment of the specified 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>name</code></em> :</span></td>
|
|
<td> The gradient name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>segment</code></em> :</span></td>
|
|
<td> The index of the segment within the gradient.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>color</code></em> :</span></td>
|
|
<td> The return color.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
|
|
<td> The opacity of the endpoint.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2633386"></a><h3>
|
|
<a name="gimp-gradient-segment-set-right-color"></a>gimp_gradient_segment_set_right_color ()</h3>
|
|
<a class="indexterm" name="id2633397"></a><pre class="programlisting">gboolean gimp_gradient_segment_set_right_color
|
|
(const gchar *name,
|
|
gint segment,
|
|
const <a
|
|
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
|
|
>GimpRGB</a> *color,
|
|
gdouble opacity);</pre>
|
|
<p>
|
|
Retrieves the right endpoint color of the specified gradient and
|
|
segment
|
|
</p>
|
|
<p>
|
|
This procedure retrieves the right endpoint color of the specified
|
|
segment of the specified 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>name</code></em> :</span></td>
|
|
<td> The gradient name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>segment</code></em> :</span></td>
|
|
<td> The index of the segment within the gradient.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>color</code></em> :</span></td>
|
|
<td> The color to set.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
|
|
<td> The opacity to set for the endpoint.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2633521"></a><h3>
|
|
<a name="gimp-gradient-segment-get-left-pos"></a>gimp_gradient_segment_get_left_pos ()</h3>
|
|
<a class="indexterm" name="id2633532"></a><pre class="programlisting">gboolean gimp_gradient_segment_get_left_pos
|
|
(const gchar *name,
|
|
gint segment,
|
|
gdouble *pos);</pre>
|
|
<p>
|
|
Retrieves the left endpoint position of the specified gradient and
|
|
segment
|
|
</p>
|
|
<p>
|
|
This procedure retrieves the left endpoint position of the specified
|
|
segment of the specified 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>name</code></em> :</span></td>
|
|
<td> The gradient name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>segment</code></em> :</span></td>
|
|
<td> The index of the segment within the gradient.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>pos</code></em> :</span></td>
|
|
<td> The return position.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2633636"></a><h3>
|
|
<a name="gimp-gradient-segment-set-left-pos"></a>gimp_gradient_segment_set_left_pos ()</h3>
|
|
<a class="indexterm" name="id2633647"></a><pre class="programlisting">gboolean gimp_gradient_segment_set_left_pos
|
|
(const gchar *name,
|
|
gint segment,
|
|
gdouble pos,
|
|
gdouble *final_pos);</pre>
|
|
<p>
|
|
Sets the left endpoint position of the specified gradient and
|
|
segment
|
|
</p>
|
|
<p>
|
|
This procedure sets the left endpoint position of the specified
|
|
segment of the specified gradient. The final position will be
|
|
between the position of the middle point to the left to the middle
|
|
point of the current segement. This procedure returns the final
|
|
position.</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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>segment</code></em> :</span></td>
|
|
<td> The index of the segment within the gradient.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>pos</code></em> :</span></td>
|
|
<td> The position to set the guidepoint in.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>final_pos</code></em> :</span></td>
|
|
<td> The return position.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2633773"></a><h3>
|
|
<a name="gimp-gradient-segment-get-middle-pos"></a>gimp_gradient_segment_get_middle_pos ()</h3>
|
|
<a class="indexterm" name="id2633784"></a><pre class="programlisting">gboolean gimp_gradient_segment_get_middle_pos
|
|
(const gchar *name,
|
|
gint segment,
|
|
gdouble *pos);</pre>
|
|
<p>
|
|
Retrieves the middle point position of the specified gradient and
|
|
segment
|
|
</p>
|
|
<p>
|
|
This procedure retrieves the middle point position of the specified
|
|
segment of the specified 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>name</code></em> :</span></td>
|
|
<td> The gradient name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>segment</code></em> :</span></td>
|
|
<td> The index of the segment within the gradient.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>pos</code></em> :</span></td>
|
|
<td> The return position.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2633888"></a><h3>
|
|
<a name="gimp-gradient-segment-set-middle-pos"></a>gimp_gradient_segment_set_middle_pos ()</h3>
|
|
<a class="indexterm" name="id2633899"></a><pre class="programlisting">gboolean gimp_gradient_segment_set_middle_pos
|
|
(const gchar *name,
|
|
gint segment,
|
|
gdouble pos,
|
|
gdouble *final_pos);</pre>
|
|
<p>
|
|
Sets the middle point position of the specified gradient and segment
|
|
</p>
|
|
<p>
|
|
This procedure sets the middle point position of the specified
|
|
segment of the specified gradient. The final position will be
|
|
between the two endpoints of the segment. This procedure returns the
|
|
final position.</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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>segment</code></em> :</span></td>
|
|
<td> The index of the segment within the gradient.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>pos</code></em> :</span></td>
|
|
<td> The position to set the guidepoint in.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>final_pos</code></em> :</span></td>
|
|
<td> The return position.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2634024"></a><h3>
|
|
<a name="gimp-gradient-segment-get-right-pos"></a>gimp_gradient_segment_get_right_pos ()</h3>
|
|
<a class="indexterm" name="id2634036"></a><pre class="programlisting">gboolean gimp_gradient_segment_get_right_pos
|
|
(const gchar *name,
|
|
gint segment,
|
|
gdouble *pos);</pre>
|
|
<p>
|
|
Retrieves the right endpoint position of the specified gradient and
|
|
segment
|
|
</p>
|
|
<p>
|
|
This procedure retrieves the right endpoint position of the
|
|
specified segment of the specified 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>name</code></em> :</span></td>
|
|
<td> The gradient name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>segment</code></em> :</span></td>
|
|
<td> The index of the segment within the gradient.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>pos</code></em> :</span></td>
|
|
<td> The return position.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2634139"></a><h3>
|
|
<a name="gimp-gradient-segment-set-right-pos"></a>gimp_gradient_segment_set_right_pos ()</h3>
|
|
<a class="indexterm" name="id2634150"></a><pre class="programlisting">gboolean gimp_gradient_segment_set_right_pos
|
|
(const gchar *name,
|
|
gint segment,
|
|
gdouble pos,
|
|
gdouble *final_pos);</pre>
|
|
<p>
|
|
Sets the right endpoint position of the specified gradient and
|
|
segment
|
|
</p>
|
|
<p>
|
|
This procedure sets the right endpoint position of the specified
|
|
segment of the specified gradient. The final position will be
|
|
between the position of the middle point of the current segment and
|
|
the middle point of the segment to the right. This procedure returns
|
|
the final position.</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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>segment</code></em> :</span></td>
|
|
<td> The index of the segment within the gradient.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>pos</code></em> :</span></td>
|
|
<td> The position to set the guidepoint in.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>final_pos</code></em> :</span></td>
|
|
<td> The return position.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2634277"></a><h3>
|
|
<a name="gimp-gradient-segment-get-blending-function"></a>gimp_gradient_segment_get_blending_function ()</h3>
|
|
<a class="indexterm" name="id2634288"></a><pre class="programlisting">gboolean gimp_gradient_segment_get_blending_function
|
|
(const gchar *name,
|
|
gint segment,
|
|
<a href="libgimp-gimpenums.html#GimpGradientSegmentType">GimpGradientSegmentType</a> *blend_func);</pre>
|
|
<p>
|
|
Retrieves the gradient segment's blending function
|
|
</p>
|
|
<p>
|
|
This procedure retrieves the blending function of the segment at the
|
|
specified gradient name and segment index.</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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>segment</code></em> :</span></td>
|
|
<td> The index of the segment within the gradient.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>blend_func</code></em> :</span></td>
|
|
<td> The blending function of the segment.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2634393"></a><h3>
|
|
<a name="gimp-gradient-segment-get-coloring-type"></a>gimp_gradient_segment_get_coloring_type ()</h3>
|
|
<a class="indexterm" name="id2634403"></a><pre class="programlisting">gboolean gimp_gradient_segment_get_coloring_type
|
|
(const gchar *name,
|
|
gint segment,
|
|
<a href="libgimp-gimpenums.html#GimpGradientSegmentColor">GimpGradientSegmentColor</a> *coloring_type);</pre>
|
|
<p>
|
|
Retrieves the gradient segment's coloring type
|
|
</p>
|
|
<p>
|
|
This procedure retrieves the coloring type of the segment at the
|
|
specified gradient name and segment index.</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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>segment</code></em> :</span></td>
|
|
<td> The index of the segment within the gradient.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>coloring_type</code></em> :</span></td>
|
|
<td> The coloring type of the segment.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2634508"></a><h3>
|
|
<a name="gimp-gradient-segment-range-set-blending-function"></a>gimp_gradient_segment_range_set_blending_function ()</h3>
|
|
<a class="indexterm" name="id2634520"></a><pre class="programlisting">gboolean gimp_gradient_segment_range_set_blending_function
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment,
|
|
<a href="libgimp-gimpenums.html#GimpGradientSegmentType">GimpGradientSegmentType</a> blending_function);</pre>
|
|
<p>
|
|
Change the blending function of a segments range
|
|
</p>
|
|
<p>
|
|
This function changes the blending function of a segment range to
|
|
the specified blending function.</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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>start_segment</code></em> :</span></td>
|
|
<td> The index of the first segment to operate on.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>end_segment</code></em> :</span></td>
|
|
<td> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>blending_function</code></em> :</span></td>
|
|
<td> The Blending Function.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2634645"></a><h3>
|
|
<a name="gimp-gradient-segment-range-set-coloring-type"></a>gimp_gradient_segment_range_set_coloring_type ()</h3>
|
|
<a class="indexterm" name="id2634656"></a><pre class="programlisting">gboolean gimp_gradient_segment_range_set_coloring_type
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment,
|
|
<a href="libgimp-gimpenums.html#GimpGradientSegmentColor">GimpGradientSegmentColor</a> coloring_type);</pre>
|
|
<p>
|
|
Change the coloring type of a segments range
|
|
</p>
|
|
<p>
|
|
This function changes the coloring type of a segment range to the
|
|
specified coloring type.</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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>start_segment</code></em> :</span></td>
|
|
<td> The index of the first segment to operate on.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>end_segment</code></em> :</span></td>
|
|
<td> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>coloring_type</code></em> :</span></td>
|
|
<td> The Coloring Type.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2634781"></a><h3>
|
|
<a name="gimp-gradient-segment-range-flip"></a>gimp_gradient_segment_range_flip ()</h3>
|
|
<a class="indexterm" name="id2634791"></a><pre class="programlisting">gboolean gimp_gradient_segment_range_flip
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment);</pre>
|
|
<p>
|
|
Flip the segment range
|
|
</p>
|
|
<p>
|
|
This function flips a segment range.</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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>start_segment</code></em> :</span></td>
|
|
<td> The index of the first segment to operate on.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>end_segment</code></em> :</span></td>
|
|
<td> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2634895"></a><h3>
|
|
<a name="gimp-gradient-segment-range-replicate"></a>gimp_gradient_segment_range_replicate ()</h3>
|
|
<a class="indexterm" name="id2634906"></a><pre class="programlisting">gboolean gimp_gradient_segment_range_replicate
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment,
|
|
gint replicate_times);</pre>
|
|
<p>
|
|
Replicate the segment range
|
|
</p>
|
|
<p>
|
|
This function replicates a segment range a given number of times.
|
|
Instead of the original segment range, several smaller scaled copies
|
|
of it will appear in equal widths.</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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>start_segment</code></em> :</span></td>
|
|
<td> The index of the first segment to operate on.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>end_segment</code></em> :</span></td>
|
|
<td> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>replicate_times</code></em> :</span></td>
|
|
<td> The number of times to replicate.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2635033"></a><h3>
|
|
<a name="gimp-gradient-segment-range-split-midpoint"></a>gimp_gradient_segment_range_split_midpoint ()</h3>
|
|
<a class="indexterm" name="id2635044"></a><pre class="programlisting">gboolean gimp_gradient_segment_range_split_midpoint
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment);</pre>
|
|
<p>
|
|
Splits each segment in the segment range at midpoint
|
|
</p>
|
|
<p>
|
|
This function splits each segment in the segment range at its
|
|
midpoint.</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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>start_segment</code></em> :</span></td>
|
|
<td> The index of the first segment to operate on.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>end_segment</code></em> :</span></td>
|
|
<td> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2635149"></a><h3>
|
|
<a name="gimp-gradient-segment-range-split-uniform"></a>gimp_gradient_segment_range_split_uniform ()</h3>
|
|
<a class="indexterm" name="id2635161"></a><pre class="programlisting">gboolean gimp_gradient_segment_range_split_uniform
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment,
|
|
gint split_parts);</pre>
|
|
<p>
|
|
Splits each segment in the segment range uniformly
|
|
</p>
|
|
<p>
|
|
This function splits each segment in the segment range uniformly
|
|
according to the number of times specified by the parameter.</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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>start_segment</code></em> :</span></td>
|
|
<td> The index of the first segment to operate on.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>end_segment</code></em> :</span></td>
|
|
<td> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>split_parts</code></em> :</span></td>
|
|
<td> The number of uniform divisions to split each segment to.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2635287"></a><h3>
|
|
<a name="gimp-gradient-segment-range-delete"></a>gimp_gradient_segment_range_delete ()</h3>
|
|
<a class="indexterm" name="id2635298"></a><pre class="programlisting">gboolean gimp_gradient_segment_range_delete
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment);</pre>
|
|
<p>
|
|
Delete the segment range
|
|
</p>
|
|
<p>
|
|
This function deletes a segment range.</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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>start_segment</code></em> :</span></td>
|
|
<td> The index of the first segment to operate on.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>end_segment</code></em> :</span></td>
|
|
<td> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2635408"></a><h3>
|
|
<a name="gimp-gradient-segment-range-redistribute-handles"></a>gimp_gradient_segment_range_redistribute_handles ()</h3>
|
|
<a class="indexterm" name="id2635420"></a><pre class="programlisting">gboolean gimp_gradient_segment_range_redistribute_handles
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment);</pre>
|
|
<p>
|
|
Uniformly redistribute the segment range's handles
|
|
</p>
|
|
<p>
|
|
This function redistributes the handles of the specified segment
|
|
range of the specified gradient, so they'll be evenly spaced.</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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>start_segment</code></em> :</span></td>
|
|
<td> The index of the first segment to operate on.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>end_segment</code></em> :</span></td>
|
|
<td> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2635539"></a><h3>
|
|
<a name="gimp-gradient-segment-range-blend-colors"></a>gimp_gradient_segment_range_blend_colors ()</h3>
|
|
<a class="indexterm" name="id2635551"></a><pre class="programlisting">gboolean gimp_gradient_segment_range_blend_colors
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment);</pre>
|
|
<p>
|
|
Blend the colors of the segment range.
|
|
</p>
|
|
<p>
|
|
This function blends the colors (but not the opacity) of the
|
|
segments' range of the gradient. Using it, the colors' transition
|
|
will be uniform across the range.</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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>start_segment</code></em> :</span></td>
|
|
<td> The index of the first segment to operate on.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>end_segment</code></em> :</span></td>
|
|
<td> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2635670"></a><h3>
|
|
<a name="gimp-gradient-segment-range-blend-opacity"></a>gimp_gradient_segment_range_blend_opacity ()</h3>
|
|
<a class="indexterm" name="id2635683"></a><pre class="programlisting">gboolean gimp_gradient_segment_range_blend_opacity
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment);</pre>
|
|
<p>
|
|
Blend the opacity of the segment range.
|
|
</p>
|
|
<p>
|
|
This function blends the opacity (but not the colors) of the
|
|
segments' range of the gradient. Using it, the opacity's transition
|
|
will be uniform across the range.</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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>start_segment</code></em> :</span></td>
|
|
<td> The index of the first segment to operate on.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>end_segment</code></em> :</span></td>
|
|
<td> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</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>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2635801"></a><h3>
|
|
<a name="gimp-gradient-segment-range-move"></a>gimp_gradient_segment_range_move ()</h3>
|
|
<a class="indexterm" name="id2635813"></a><pre class="programlisting">gdouble gimp_gradient_segment_range_move
|
|
(const gchar *name,
|
|
gint start_segment,
|
|
gint end_segment,
|
|
gdouble delta,
|
|
gboolean control_compress);</pre>
|
|
<p>
|
|
Move the position of an entire segment range by a delta.
|
|
</p>
|
|
<p>
|
|
This funtions moves the position of an entire segment range by a
|
|
delta. The actual delta (which is returned) will be limited by the
|
|
control points of the neighboring segments.</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.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>start_segment</code></em> :</span></td>
|
|
<td> The index of the first segment to operate on.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>end_segment</code></em> :</span></td>
|
|
<td> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>delta</code></em> :</span></td>
|
|
<td> The delta to move the segment range.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>control_compress</code></em> :</span></td>
|
|
<td> Whether or not to compress the neighboring segments.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The final delta by which the range moved.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</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-gimpfonts.html"><b><< gimpfonts</b></a></td>
|
|
<td align="right"><a accesskey="n" href="libgimp-gimpgradients.html"><b>gimpgradients >></b></a></td>
|
|
</tr></table>
|
|
</body>
|
|
</html>
|