1030 lines
68 KiB
XML
1030 lines
68 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
|
|
|
<refentry id="libgimp-gimpgradient">
|
|
<refmeta>
|
|
<refentrytitle role="top_of_page" id="libgimp-gimpgradient.top_of_page">gimpgradient</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMP Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>gimpgradient</refname>
|
|
<refpurpose>Functions operating on a single gradient.</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv id="libgimp-gimpgradient.synopsis" role="synopsis">
|
|
<title role="synopsis.title">Synopsis</title>
|
|
|
|
<synopsis>
|
|
<link linkend="gchar">gchar</link>* <link linkend="gimp-gradient-new">gimp_gradient_new</link> (const <link linkend="gchar">gchar</link> *name);
|
|
<link linkend="gchar">gchar</link>* <link linkend="gimp-gradient-duplicate">gimp_gradient_duplicate</link> (const <link linkend="gchar">gchar</link> *name);
|
|
<link linkend="gchar">gchar</link>* <link linkend="gimp-gradient-rename">gimp_gradient_rename</link> (const <link linkend="gchar">gchar</link> *name,
|
|
const <link linkend="gchar">gchar</link> *new_name);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-delete">gimp_gradient_delete</link> (const <link linkend="gchar">gchar</link> *name);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-is-editable">gimp_gradient_is_editable</link> (const <link linkend="gchar">gchar</link> *name);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-get-uniform-samples">gimp_gradient_get_uniform_samples</link> (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> num_samples,
|
|
<link linkend="gboolean">gboolean</link> reverse,
|
|
<link linkend="gint">gint</link> *num_color_samples,
|
|
<link linkend="gdouble">gdouble</link> **color_samples);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-get-custom-samples">gimp_gradient_get_custom_samples</link> (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> num_samples,
|
|
const <link linkend="gdouble">gdouble</link> *positions,
|
|
<link linkend="gboolean">gboolean</link> reverse,
|
|
<link linkend="gint">gint</link> *num_color_samples,
|
|
<link linkend="gdouble">gdouble</link> **color_samples);
|
|
<link linkend="gint">gint</link> <link linkend="gimp-gradient-get-number-of-segments">gimp_gradient_get_number_of_segments</link>
|
|
(const <link linkend="gchar">gchar</link> *name);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-get-left-color">gimp_gradient_segment_get_left_color</link>
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="GimpRGB">GimpRGB</link> *color,
|
|
<link linkend="gdouble">gdouble</link> *opacity);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-set-left-color">gimp_gradient_segment_set_left_color</link>
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
const <link linkend="GimpRGB">GimpRGB</link> *color,
|
|
<link linkend="gdouble">gdouble</link> opacity);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-get-right-color">gimp_gradient_segment_get_right_color</link>
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="GimpRGB">GimpRGB</link> *color,
|
|
<link linkend="gdouble">gdouble</link> *opacity);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-set-right-color">gimp_gradient_segment_set_right_color</link>
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
const <link linkend="GimpRGB">GimpRGB</link> *color,
|
|
<link linkend="gdouble">gdouble</link> opacity);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-get-left-pos">gimp_gradient_segment_get_left_pos</link> (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="gdouble">gdouble</link> *pos);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-set-left-pos">gimp_gradient_segment_set_left_pos</link> (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="gdouble">gdouble</link> pos,
|
|
<link linkend="gdouble">gdouble</link> *final_pos);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-get-middle-pos">gimp_gradient_segment_get_middle_pos</link>
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="gdouble">gdouble</link> *pos);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-set-middle-pos">gimp_gradient_segment_set_middle_pos</link>
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="gdouble">gdouble</link> pos,
|
|
<link linkend="gdouble">gdouble</link> *final_pos);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-get-right-pos">gimp_gradient_segment_get_right_pos</link> (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="gdouble">gdouble</link> *pos);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-set-right-pos">gimp_gradient_segment_set_right_pos</link> (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="gdouble">gdouble</link> pos,
|
|
<link linkend="gdouble">gdouble</link> *final_pos);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-get-blending-function">gimp_gradient_segment_get_blending_function</link>
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="GimpGradientSegmentType">GimpGradientSegmentType</link> *blend_func);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-get-coloring-type">gimp_gradient_segment_get_coloring_type</link>
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="GimpGradientSegmentColor">GimpGradientSegmentColor</link> *coloring_type);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-range-set-blending-function">gimp_gradient_segment_range_set_blending_function</link>
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment,
|
|
<link linkend="GimpGradientSegmentType">GimpGradientSegmentType</link> blending_function);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-range-set-coloring-type">gimp_gradient_segment_range_set_coloring_type</link>
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment,
|
|
<link linkend="GimpGradientSegmentColor">GimpGradientSegmentColor</link> coloring_type);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-range-flip">gimp_gradient_segment_range_flip</link> (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-range-replicate">gimp_gradient_segment_range_replicate</link>
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment,
|
|
<link linkend="gint">gint</link> replicate_times);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-range-split-midpoint">gimp_gradient_segment_range_split_midpoint</link>
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-range-split-uniform">gimp_gradient_segment_range_split_uniform</link>
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment,
|
|
<link linkend="gint">gint</link> split_parts);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-range-delete">gimp_gradient_segment_range_delete</link> (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-range-redistribute-handles">gimp_gradient_segment_range_redistribute_handles</link>
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-range-blend-colors">gimp_gradient_segment_range_blend_colors</link>
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradient-segment-range-blend-opacity">gimp_gradient_segment_range_blend_opacity</link>
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment);
|
|
<link linkend="gdouble">gdouble</link> <link linkend="gimp-gradient-segment-range-move">gimp_gradient_segment_range_move</link> (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment,
|
|
<link linkend="gdouble">gdouble</link> delta,
|
|
<link linkend="gboolean">gboolean</link> control_compress);
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1 id="libgimp-gimpgradient.description" role="desc">
|
|
<title role="desc.title">Description</title>
|
|
<para>
|
|
Functions operating on a single gradient.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 id="libgimp-gimpgradient.details" role="details">
|
|
<title role="details.title">Details</title>
|
|
<refsect2 id="gimp-gradient-new" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_new ()</title>
|
|
<indexterm zone="gimp-gradient-new" role="GIMP 2.2"><primary sortas="gimp_gradient_new">gimp_gradient_new</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_gradient_new (const <link linkend="gchar">gchar</link> *name);</programlisting>
|
|
<para>
|
|
Creates a new gradient
|
|
</para>
|
|
<para>
|
|
This procedure creates a new, uninitialized gradient</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The requested name of the new gradient.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The actual new gradient name.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-duplicate" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_duplicate ()</title>
|
|
<indexterm zone="gimp-gradient-duplicate" role="GIMP 2.2"><primary sortas="gimp_gradient_duplicate">gimp_gradient_duplicate</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_gradient_duplicate (const <link linkend="gchar">gchar</link> *name);</programlisting>
|
|
<para>
|
|
Duplicates a gradient
|
|
</para>
|
|
<para>
|
|
This procedure creates an identical gradient by a different name</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The name of the gradient's copy.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-rename" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_rename ()</title>
|
|
<indexterm zone="gimp-gradient-rename" role="GIMP 2.2"><primary sortas="gimp_gradient_rename">gimp_gradient_rename</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_gradient_rename (const <link linkend="gchar">gchar</link> *name,
|
|
const <link linkend="gchar">gchar</link> *new_name);</programlisting>
|
|
<para>
|
|
Rename a gradient
|
|
</para>
|
|
<para>
|
|
This procedure renames a gradient</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>new_name</parameter> :</term>
|
|
<listitem><simpara> The new name of the gradient.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The actual new name of the gradient.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-delete" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_delete ()</title>
|
|
<indexterm zone="gimp-gradient-delete" role="GIMP 2.2"><primary sortas="gimp_gradient_delete">gimp_gradient_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_delete (const <link linkend="gchar">gchar</link> *name);</programlisting>
|
|
<para>
|
|
Deletes a gradient
|
|
</para>
|
|
<para>
|
|
This procedure deletes a gradient</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-is-editable" role="function" condition="since:GIMP 2.4">
|
|
<title>gimp_gradient_is_editable ()</title>
|
|
<indexterm zone="gimp-gradient-is-editable" role="GIMP 2.4"><primary sortas="gimp_gradient_is_editable">gimp_gradient_is_editable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_is_editable (const <link linkend="gchar">gchar</link> *name);</programlisting>
|
|
<para>
|
|
Tests if gradient can be edited
|
|
</para>
|
|
<para>
|
|
Returns TRUE if you have permission to change the gradient</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the gradient can be edited.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
|
|
<refsect2 id="gimp-gradient-get-uniform-samples" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_get_uniform_samples ()</title>
|
|
<indexterm zone="gimp-gradient-get-uniform-samples" role="GIMP 2.2"><primary sortas="gimp_gradient_get_uniform_samples">gimp_gradient_get_uniform_samples</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_get_uniform_samples (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> num_samples,
|
|
<link linkend="gboolean">gboolean</link> reverse,
|
|
<link linkend="gint">gint</link> *num_color_samples,
|
|
<link linkend="gdouble">gdouble</link> **color_samples);</programlisting>
|
|
<para>
|
|
Sample the specified in uniform parts.
|
|
</para>
|
|
<para>
|
|
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 }.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>num_samples</parameter> :</term>
|
|
<listitem><simpara> The number of samples to take.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>reverse</parameter> :</term>
|
|
<listitem><simpara> Use the reverse gradient.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>num_color_samples</parameter> :</term>
|
|
<listitem><simpara> Length of the color_samples array (4 * num_samples).
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>color_samples</parameter> :</term>
|
|
<listitem><simpara> Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-get-custom-samples" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_get_custom_samples ()</title>
|
|
<indexterm zone="gimp-gradient-get-custom-samples" role="GIMP 2.2"><primary sortas="gimp_gradient_get_custom_samples">gimp_gradient_get_custom_samples</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_get_custom_samples (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> num_samples,
|
|
const <link linkend="gdouble">gdouble</link> *positions,
|
|
<link linkend="gboolean">gboolean</link> reverse,
|
|
<link linkend="gint">gint</link> *num_color_samples,
|
|
<link linkend="gdouble">gdouble</link> **color_samples);</programlisting>
|
|
<para>
|
|
Sample the spacified gradient in custom positions.
|
|
</para>
|
|
<para>
|
|
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.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>num_samples</parameter> :</term>
|
|
<listitem><simpara> The number of samples to take.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>positions</parameter> :</term>
|
|
<listitem><simpara> The list of positions to sample along the gradient.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>reverse</parameter> :</term>
|
|
<listitem><simpara> Use the reverse gradient.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>num_color_samples</parameter> :</term>
|
|
<listitem><simpara> Length of the color_samples array (4 * num_samples).
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>color_samples</parameter> :</term>
|
|
<listitem><simpara> Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-get-number-of-segments" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_gradient_get_number_of_segments ()</title>
|
|
<indexterm zone="gimp-gradient-get-number-of-segments" role="GIMP 2.6"><primary sortas="gimp_gradient_get_number_of_segments">gimp_gradient_get_number_of_segments</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_gradient_get_number_of_segments
|
|
(const <link linkend="gchar">gchar</link> *name);</programlisting>
|
|
<para>
|
|
Returns the number of segments of the specified gradient
|
|
</para>
|
|
<para>
|
|
This procedure returns the number of segments of the specified
|
|
gradient.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Number of segments.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-get-left-color" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_get_left_color ()</title>
|
|
<indexterm zone="gimp-gradient-segment-get-left-color" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_get_left_color">gimp_gradient_segment_get_left_color</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_get_left_color
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="GimpRGB">GimpRGB</link> *color,
|
|
<link linkend="gdouble">gdouble</link> *opacity);</programlisting>
|
|
<para>
|
|
Retrieves the left endpoint color of the specified segment
|
|
</para>
|
|
<para>
|
|
This procedure retrieves the left endpoint color of the specified
|
|
segment of the specified gradient.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>segment</parameter> :</term>
|
|
<listitem><simpara> The index of the segment within the gradient.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>color</parameter> :</term>
|
|
<listitem><simpara> The return color.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>opacity</parameter> :</term>
|
|
<listitem><simpara> The opacity of the endpoint.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-set-left-color" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_set_left_color ()</title>
|
|
<indexterm zone="gimp-gradient-segment-set-left-color" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_set_left_color">gimp_gradient_segment_set_left_color</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_set_left_color
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
const <link linkend="GimpRGB">GimpRGB</link> *color,
|
|
<link linkend="gdouble">gdouble</link> opacity);</programlisting>
|
|
<para>
|
|
Sets the left endpoint color of the specified segment
|
|
</para>
|
|
<para>
|
|
This procedure sets the left endpoint color of the specified segment
|
|
of the specified gradient.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>segment</parameter> :</term>
|
|
<listitem><simpara> The index of the segment within the gradient.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>color</parameter> :</term>
|
|
<listitem><simpara> The color to set.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>opacity</parameter> :</term>
|
|
<listitem><simpara> The opacity to set for the endpoint.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-get-right-color" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_get_right_color ()</title>
|
|
<indexterm zone="gimp-gradient-segment-get-right-color" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_get_right_color">gimp_gradient_segment_get_right_color</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_get_right_color
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="GimpRGB">GimpRGB</link> *color,
|
|
<link linkend="gdouble">gdouble</link> *opacity);</programlisting>
|
|
<para>
|
|
Retrieves the right endpoint color of the specified segment
|
|
</para>
|
|
<para>
|
|
This procedure retrieves the right endpoint color of the specified
|
|
segment of the specified gradient.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>segment</parameter> :</term>
|
|
<listitem><simpara> The index of the segment within the gradient.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>color</parameter> :</term>
|
|
<listitem><simpara> The return color.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>opacity</parameter> :</term>
|
|
<listitem><simpara> The opacity of the endpoint.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-set-right-color" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_set_right_color ()</title>
|
|
<indexterm zone="gimp-gradient-segment-set-right-color" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_set_right_color">gimp_gradient_segment_set_right_color</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_set_right_color
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
const <link linkend="GimpRGB">GimpRGB</link> *color,
|
|
<link linkend="gdouble">gdouble</link> opacity);</programlisting>
|
|
<para>
|
|
Sets the right endpoint color of the specified segment
|
|
</para>
|
|
<para>
|
|
This procedure sets the right endpoint color of the specified
|
|
segment of the specified gradient.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>segment</parameter> :</term>
|
|
<listitem><simpara> The index of the segment within the gradient.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>color</parameter> :</term>
|
|
<listitem><simpara> The color to set.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>opacity</parameter> :</term>
|
|
<listitem><simpara> The opacity to set for the endpoint.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-get-left-pos" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_get_left_pos ()</title>
|
|
<indexterm zone="gimp-gradient-segment-get-left-pos" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_get_left_pos">gimp_gradient_segment_get_left_pos</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_get_left_pos (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="gdouble">gdouble</link> *pos);</programlisting>
|
|
<para>
|
|
Retrieves the left endpoint position of the specified segment
|
|
</para>
|
|
<para>
|
|
This procedure retrieves the left endpoint position of the specified
|
|
segment of the specified gradient.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>segment</parameter> :</term>
|
|
<listitem><simpara> The index of the segment within the gradient.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>pos</parameter> :</term>
|
|
<listitem><simpara> The return position.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-set-left-pos" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_set_left_pos ()</title>
|
|
<indexterm zone="gimp-gradient-segment-set-left-pos" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_set_left_pos">gimp_gradient_segment_set_left_pos</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_set_left_pos (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="gdouble">gdouble</link> pos,
|
|
<link linkend="gdouble">gdouble</link> *final_pos);</programlisting>
|
|
<para>
|
|
Sets the left endpoint position of the specified segment
|
|
</para>
|
|
<para>
|
|
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.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>segment</parameter> :</term>
|
|
<listitem><simpara> The index of the segment within the gradient.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>pos</parameter> :</term>
|
|
<listitem><simpara> The position to set the guidepoint to.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>final_pos</parameter> :</term>
|
|
<listitem><simpara> The return position.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-get-middle-pos" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_get_middle_pos ()</title>
|
|
<indexterm zone="gimp-gradient-segment-get-middle-pos" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_get_middle_pos">gimp_gradient_segment_get_middle_pos</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_get_middle_pos
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="gdouble">gdouble</link> *pos);</programlisting>
|
|
<para>
|
|
Retrieves the middle point position of the specified segment
|
|
</para>
|
|
<para>
|
|
This procedure retrieves the middle point position of the specified
|
|
segment of the specified gradient.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>segment</parameter> :</term>
|
|
<listitem><simpara> The index of the segment within the gradient.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>pos</parameter> :</term>
|
|
<listitem><simpara> The return position.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-set-middle-pos" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_set_middle_pos ()</title>
|
|
<indexterm zone="gimp-gradient-segment-set-middle-pos" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_set_middle_pos">gimp_gradient_segment_set_middle_pos</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_set_middle_pos
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="gdouble">gdouble</link> pos,
|
|
<link linkend="gdouble">gdouble</link> *final_pos);</programlisting>
|
|
<para>
|
|
Sets the middle point position of the specified segment
|
|
</para>
|
|
<para>
|
|
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.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>segment</parameter> :</term>
|
|
<listitem><simpara> The index of the segment within the gradient.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>pos</parameter> :</term>
|
|
<listitem><simpara> The position to set the guidepoint to.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>final_pos</parameter> :</term>
|
|
<listitem><simpara> The return position.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-get-right-pos" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_get_right_pos ()</title>
|
|
<indexterm zone="gimp-gradient-segment-get-right-pos" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_get_right_pos">gimp_gradient_segment_get_right_pos</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_get_right_pos (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="gdouble">gdouble</link> *pos);</programlisting>
|
|
<para>
|
|
Retrieves the right endpoint position of the specified segment
|
|
</para>
|
|
<para>
|
|
This procedure retrieves the right endpoint position of the
|
|
specified segment of the specified gradient.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>segment</parameter> :</term>
|
|
<listitem><simpara> The index of the segment within the gradient.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>pos</parameter> :</term>
|
|
<listitem><simpara> The return position.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-set-right-pos" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_set_right_pos ()</title>
|
|
<indexterm zone="gimp-gradient-segment-set-right-pos" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_set_right_pos">gimp_gradient_segment_set_right_pos</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_set_right_pos (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="gdouble">gdouble</link> pos,
|
|
<link linkend="gdouble">gdouble</link> *final_pos);</programlisting>
|
|
<para>
|
|
Sets the right endpoint position of the specified segment
|
|
</para>
|
|
<para>
|
|
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.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>segment</parameter> :</term>
|
|
<listitem><simpara> The index of the segment within the gradient.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>pos</parameter> :</term>
|
|
<listitem><simpara> The position to set the guidepoint to.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>final_pos</parameter> :</term>
|
|
<listitem><simpara> The return position.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-get-blending-function" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_get_blending_function ()</title>
|
|
<indexterm zone="gimp-gradient-segment-get-blending-function" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_get_blending_function">gimp_gradient_segment_get_blending_function</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_get_blending_function
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="GimpGradientSegmentType">GimpGradientSegmentType</link> *blend_func);</programlisting>
|
|
<para>
|
|
Retrieves the gradient segment's blending function
|
|
</para>
|
|
<para>
|
|
This procedure retrieves the blending function of the segment at the
|
|
specified gradient name and segment index.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>segment</parameter> :</term>
|
|
<listitem><simpara> The index of the segment within the gradient.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>blend_func</parameter> :</term>
|
|
<listitem><simpara> The blending function of the segment.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-get-coloring-type" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_get_coloring_type ()</title>
|
|
<indexterm zone="gimp-gradient-segment-get-coloring-type" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_get_coloring_type">gimp_gradient_segment_get_coloring_type</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_get_coloring_type
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> segment,
|
|
<link linkend="GimpGradientSegmentColor">GimpGradientSegmentColor</link> *coloring_type);</programlisting>
|
|
<para>
|
|
Retrieves the gradient segment's coloring type
|
|
</para>
|
|
<para>
|
|
This procedure retrieves the coloring type of the segment at the
|
|
specified gradient name and segment index.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>segment</parameter> :</term>
|
|
<listitem><simpara> The index of the segment within the gradient.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>coloring_type</parameter> :</term>
|
|
<listitem><simpara> The coloring type of the segment.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-range-set-blending-function" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_range_set_blending_function ()</title>
|
|
<indexterm zone="gimp-gradient-segment-range-set-blending-function" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_set_blending_function">gimp_gradient_segment_range_set_blending_function</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_range_set_blending_function
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment,
|
|
<link linkend="GimpGradientSegmentType">GimpGradientSegmentType</link> blending_function);</programlisting>
|
|
<para>
|
|
Change the blending function of a segments range
|
|
</para>
|
|
<para>
|
|
This function changes the blending function of a segment range to
|
|
the specified blending function.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>start_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the first segment to operate on.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>end_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>blending_function</parameter> :</term>
|
|
<listitem><simpara> The blending function.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-range-set-coloring-type" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_range_set_coloring_type ()</title>
|
|
<indexterm zone="gimp-gradient-segment-range-set-coloring-type" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_set_coloring_type">gimp_gradient_segment_range_set_coloring_type</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_range_set_coloring_type
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment,
|
|
<link linkend="GimpGradientSegmentColor">GimpGradientSegmentColor</link> coloring_type);</programlisting>
|
|
<para>
|
|
Change the coloring type of a segments range
|
|
</para>
|
|
<para>
|
|
This function changes the coloring type of a segment range to the
|
|
specified coloring type.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>start_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the first segment to operate on.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>end_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>coloring_type</parameter> :</term>
|
|
<listitem><simpara> The coloring type.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-range-flip" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_range_flip ()</title>
|
|
<indexterm zone="gimp-gradient-segment-range-flip" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_flip">gimp_gradient_segment_range_flip</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_range_flip (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment);</programlisting>
|
|
<para>
|
|
Flip the segment range
|
|
</para>
|
|
<para>
|
|
This function flips a segment range.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>start_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the first segment to operate on.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>end_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-range-replicate" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_range_replicate ()</title>
|
|
<indexterm zone="gimp-gradient-segment-range-replicate" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_replicate">gimp_gradient_segment_range_replicate</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_range_replicate
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment,
|
|
<link linkend="gint">gint</link> replicate_times);</programlisting>
|
|
<para>
|
|
Replicate the segment range
|
|
</para>
|
|
<para>
|
|
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.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>start_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the first segment to operate on.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>end_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>replicate_times</parameter> :</term>
|
|
<listitem><simpara> The number of times to replicate.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-range-split-midpoint" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_range_split_midpoint ()</title>
|
|
<indexterm zone="gimp-gradient-segment-range-split-midpoint" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_split_midpoint">gimp_gradient_segment_range_split_midpoint</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_range_split_midpoint
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment);</programlisting>
|
|
<para>
|
|
Splits each segment in the segment range at midpoint
|
|
</para>
|
|
<para>
|
|
This function splits each segment in the segment range at its
|
|
midpoint.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>start_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the first segment to operate on.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>end_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-range-split-uniform" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_range_split_uniform ()</title>
|
|
<indexterm zone="gimp-gradient-segment-range-split-uniform" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_split_uniform">gimp_gradient_segment_range_split_uniform</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_range_split_uniform
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment,
|
|
<link linkend="gint">gint</link> split_parts);</programlisting>
|
|
<para>
|
|
Splits each segment in the segment range uniformly
|
|
</para>
|
|
<para>
|
|
This function splits each segment in the segment range uniformly
|
|
according to the number of times specified by the parameter.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>start_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the first segment to operate on.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>end_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>split_parts</parameter> :</term>
|
|
<listitem><simpara> The number of uniform divisions to split each segment to.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-range-delete" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_range_delete ()</title>
|
|
<indexterm zone="gimp-gradient-segment-range-delete" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_delete">gimp_gradient_segment_range_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_range_delete (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment);</programlisting>
|
|
<para>
|
|
Delete the segment range
|
|
</para>
|
|
<para>
|
|
This function deletes a segment range.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>start_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the first segment to operate on.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>end_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-range-redistribute-handles" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_range_redistribute_handles ()</title>
|
|
<indexterm zone="gimp-gradient-segment-range-redistribute-handles" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_redistribute_handles">gimp_gradient_segment_range_redistribute_handles</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_range_redistribute_handles
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment);</programlisting>
|
|
<para>
|
|
Uniformly redistribute the segment range's handles
|
|
</para>
|
|
<para>
|
|
This function redistributes the handles of the specified segment
|
|
range of the specified gradient, so they'll be evenly spaced.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>start_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the first segment to operate on.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>end_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-range-blend-colors" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_range_blend_colors ()</title>
|
|
<indexterm zone="gimp-gradient-segment-range-blend-colors" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_blend_colors">gimp_gradient_segment_range_blend_colors</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_range_blend_colors
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment);</programlisting>
|
|
<para>
|
|
Blend the colors of the segment range.
|
|
</para>
|
|
<para>
|
|
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.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>start_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the first segment to operate on.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>end_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-range-blend-opacity" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_range_blend_opacity ()</title>
|
|
<indexterm zone="gimp-gradient-segment-range-blend-opacity" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_blend_opacity">gimp_gradient_segment_range_blend_opacity</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradient_segment_range_blend_opacity
|
|
(const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment);</programlisting>
|
|
<para>
|
|
Blend the opacity of the segment range.
|
|
</para>
|
|
<para>
|
|
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.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>start_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the first segment to operate on.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>end_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
<refsect2 id="gimp-gradient-segment-range-move" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_gradient_segment_range_move ()</title>
|
|
<indexterm zone="gimp-gradient-segment-range-move" role="GIMP 2.2"><primary sortas="gimp_gradient_segment_range_move">gimp_gradient_segment_range_move</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gimp_gradient_segment_range_move (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> start_segment,
|
|
<link linkend="gint">gint</link> end_segment,
|
|
<link linkend="gdouble">gdouble</link> delta,
|
|
<link linkend="gboolean">gboolean</link> control_compress);</programlisting>
|
|
<para>
|
|
Move the position of an entire segment range by a delta.
|
|
</para>
|
|
<para>
|
|
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.</para>
|
|
<para>
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The gradient name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>start_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the first segment to operate on.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>end_segment</parameter> :</term>
|
|
<listitem><simpara> The index of the last segment to operate on. If negative, the selection will extend to the end of the string.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>delta</parameter> :</term>
|
|
<listitem><simpara> The delta to move the segment range.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>control_compress</parameter> :</term>
|
|
<listitem><simpara> Whether or not to compress the neighboring segments.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The final delta by which the range moved.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|