1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
<?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-gimpgradients">
<refmeta>
<refentrytitle role="top_of_page">gimpgradients</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpgradients</refname>
<refpurpose>Operations related to gradients.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradients-refresh">gimp_gradients_refresh</link> (void);
<link linkend="gchar">gchar</link>** <link linkend="gimp-gradients-get-list">gimp_gradients_get_list</link> (const <link linkend="gchar">gchar</link> *filter,
<link linkend="gint">gint</link> *num_gradients);
<link linkend="gchar">gchar</link>* <link linkend="gimp-gradients-get-gradient">gimp_gradients_get_gradient</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-gradients-set-gradient">gimp_gradients_set_gradient</link> (const <link linkend="gchar">gchar</link> *name);
<link linkend="gdouble">gdouble</link>* <link linkend="gimp-gradients-sample-uniform">gimp_gradients_sample_uniform</link> (<link linkend="gint">gint</link> num_samples,
<link linkend="gboolean">gboolean</link> reverse);
<link linkend="gdouble">gdouble</link>* <link linkend="gimp-gradients-sample-custom">gimp_gradients_sample_custom</link> (<link linkend="gint">gint</link> num_samples,
const <link linkend="gdouble">gdouble</link> *positions,
<link linkend="gboolean">gboolean</link> reverse);
<link linkend="gchar">gchar</link>* <link linkend="gimp-gradients-get-gradient-data">gimp_gradients_get_gradient_data</link>
(const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> sample_size,
<link linkend="gboolean">gboolean</link> reverse,
<link linkend="gint">gint</link> *width,
<link linkend="gdouble">gdouble</link> **grad_data);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Operations related to gradients.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-gradients-refresh" role="function"/>gimp_gradients_refresh ()</title>
<indexterm><primary>gimp_gradients_refresh</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradients_refresh (void);</programlisting>
<para>
Refresh current gradients. This function always succeeds.
</para>
<para>
This procedure retrieves all gradients currently in the user's
gradient path and updates the gradient dialogs accordingly.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-gradients-get-list" role="function"/>gimp_gradients_get_list ()</title>
<indexterm><primary>gimp_gradients_get_list</primary></indexterm><programlisting><link linkend="gchar">gchar</link>** gimp_gradients_get_list (const <link linkend="gchar">gchar</link> *filter,
<link linkend="gint">gint</link> *num_gradients);</programlisting>
<para>
Retrieve the list of loaded gradients.
</para>
<para>
This procedure returns a list of the gradients that are currently
loaded. You can later use the 'gimp_context_set_gradient' function
to set the active gradient.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>filter</parameter> :</term>
<listitem><simpara> An optional regular expression used to filter the list.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>num_gradients</parameter> :</term>
<listitem><simpara> The number of loaded gradients.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The list of gradient names.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-gradients-get-gradient" role="function" condition="deprecated:"/>gimp_gradients_get_gradient ()</title>
<indexterm role="deprecated"><primary>gimp_gradients_get_gradient</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_gradients_get_gradient (void);</programlisting>
<warning><para><literal>gimp_gradients_get_gradient</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
This procedure is deprecated! Use <link linkend="gimp-context-get-gradient"><function>gimp_context_get_gradient()</function></link> instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The name of the active gradient.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-gradients-set-gradient" role="function" condition="deprecated:"/>gimp_gradients_set_gradient ()</title>
<indexterm role="deprecated"><primary>gimp_gradients_set_gradient</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_gradients_set_gradient (const <link linkend="gchar">gchar</link> *name);</programlisting>
<warning><para><literal>gimp_gradients_set_gradient</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
This procedure is deprecated! Use <link linkend="gimp-context-set-gradient"><function>gimp_context_set_gradient()</function></link> instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The name of the gradient to set.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-gradients-sample-uniform" role="function" condition="deprecated:"/>gimp_gradients_sample_uniform ()</title>
<indexterm role="deprecated"><primary>gimp_gradients_sample_uniform</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>* gimp_gradients_sample_uniform (<link linkend="gint">gint</link> num_samples,
<link linkend="gboolean">gboolean</link> reverse);</programlisting>
<warning><para><literal>gimp_gradients_sample_uniform</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
This procedure is deprecated! Use
<link linkend="gimp-gradient-get-uniform-samples"><function>gimp_gradient_get_uniform_samples()</function></link> instead.</para>
<para>
</para><variablelist role="params">
<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><emphasis>Returns</emphasis> :</term><listitem><simpara> Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-gradients-sample-custom" role="function" condition="deprecated:"/>gimp_gradients_sample_custom ()</title>
<indexterm role="deprecated"><primary>gimp_gradients_sample_custom</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>* gimp_gradients_sample_custom (<link linkend="gint">gint</link> num_samples,
const <link linkend="gdouble">gdouble</link> *positions,
<link linkend="gboolean">gboolean</link> reverse);</programlisting>
<warning><para><literal>gimp_gradients_sample_custom</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
This procedure is deprecated! Use <link linkend="gimp-gradient-get-custom-samples"><function>gimp_gradient_get_custom_samples()</function></link>
instead.</para>
<para>
</para><variablelist role="params">
<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><emphasis>Returns</emphasis> :</term><listitem><simpara> Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-gradients-get-gradient-data" role="function" condition="deprecated:"/>gimp_gradients_get_gradient_data ()</title>
<indexterm role="deprecated"><primary>gimp_gradients_get_gradient_data</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_gradients_get_gradient_data
(const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> sample_size,
<link linkend="gboolean">gboolean</link> reverse,
<link linkend="gint">gint</link> *width,
<link linkend="gdouble">gdouble</link> **grad_data);</programlisting>
<warning><para><literal>gimp_gradients_get_gradient_data</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
This procedure is deprecated! Use
<link linkend="gimp-gradient-get-uniform-samples"><function>gimp_gradient_get_uniform_samples()</function></link> instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The gradient name (\"\" means current active gradient).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>sample_size</parameter> :</term>
<listitem><simpara> Size of the sample to return when the gradient is changed.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>reverse</parameter> :</term>
<listitem><simpara> Use the reverse gradient.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter> :</term>
<listitem><simpara> The gradient sample width (r,g,b,a).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>grad_data</parameter> :</term>
<listitem><simpara> The gradient sample data.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The gradient name.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
