1
<?xml version="1.0" encoding="UTF-8" ?>
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
5
<refentry id="libgimp-gimppaths">
7
<refentrytitle role="top_of_page" id="libgimp-gimppaths.top_of_page">gimppaths</refentrytitle>
8
<manvolnum>3</manvolnum>
9
<refmiscinfo>LIBGIMP Library</refmiscinfo>
13
<refname>gimppaths</refname>
14
<refpurpose>Operations related to paths.</refpurpose>
17
<refsynopsisdiv id="libgimp-gimppaths.synopsis" role="synopsis">
18
<title role="synopsis.title">Synopsis</title>
21
<link linkend="gchar">gchar</link>** <link linkend="gimp-path-list">gimp_path_list</link> (<link linkend="gint32">gint32</link> image_ID,
22
<link linkend="gint">gint</link> *num_paths);
23
<link linkend="gint">gint</link> <link linkend="gimp-path-get-points">gimp_path_get_points</link> (<link linkend="gint32">gint32</link> image_ID,
24
const <link linkend="gchar">gchar</link> *name,
25
<link linkend="gint">gint</link> *path_closed,
26
<link linkend="gint">gint</link> *num_path_point_details,
27
<link linkend="gdouble">gdouble</link> **points_pairs);
28
<link linkend="gchar">gchar</link>* <link linkend="gimp-path-get-current">gimp_path_get_current</link> (<link linkend="gint32">gint32</link> image_ID);
29
<link linkend="gboolean">gboolean</link> <link linkend="gimp-path-set-current">gimp_path_set_current</link> (<link linkend="gint32">gint32</link> image_ID,
30
const <link linkend="gchar">gchar</link> *name);
31
<link linkend="gboolean">gboolean</link> <link linkend="gimp-path-set-points">gimp_path_set_points</link> (<link linkend="gint32">gint32</link> image_ID,
32
const <link linkend="gchar">gchar</link> *name,
33
<link linkend="gint">gint</link> ptype,
34
<link linkend="gint">gint</link> num_path_points,
35
const <link linkend="gdouble">gdouble</link> *points_pairs);
36
<link linkend="gboolean">gboolean</link> <link linkend="gimp-path-stroke-current">gimp_path_stroke_current</link> (<link linkend="gint32">gint32</link> image_ID);
37
<link linkend="gint">gint</link> <link linkend="gimp-path-get-point-at-dist">gimp_path_get_point_at_dist</link> (<link linkend="gint32">gint32</link> image_ID,
38
<link linkend="gdouble">gdouble</link> distance,
39
<link linkend="gint">gint</link> *y_point,
40
<link linkend="gdouble">gdouble</link> *slope);
41
<link linkend="gint">gint</link> <link linkend="gimp-path-get-tattoo">gimp_path_get_tattoo</link> (<link linkend="gint32">gint32</link> image_ID,
42
const <link linkend="gchar">gchar</link> *name);
43
<link linkend="gchar">gchar</link>* <link linkend="gimp-get-path-by-tattoo">gimp_get_path_by_tattoo</link> (<link linkend="gint32">gint32</link> image_ID,
44
<link linkend="gint">gint</link> tattoo);
45
<link linkend="gboolean">gboolean</link> <link linkend="gimp-path-delete">gimp_path_delete</link> (<link linkend="gint32">gint32</link> image_ID,
46
const <link linkend="gchar">gchar</link> *name);
47
<link linkend="gboolean">gboolean</link> <link linkend="gimp-path-get-locked">gimp_path_get_locked</link> (<link linkend="gint32">gint32</link> image_ID,
48
const <link linkend="gchar">gchar</link> *name);
49
<link linkend="gboolean">gboolean</link> <link linkend="gimp-path-set-locked">gimp_path_set_locked</link> (<link linkend="gint32">gint32</link> image_ID,
50
const <link linkend="gchar">gchar</link> *name,
51
<link linkend="gboolean">gboolean</link> locked);
52
<link linkend="gboolean">gboolean</link> <link linkend="gimp-path-set-tattoo">gimp_path_set_tattoo</link> (<link linkend="gint32">gint32</link> image_ID,
53
const <link linkend="gchar">gchar</link> *name,
54
<link linkend="gint">gint</link> tattovalue);
55
<link linkend="gboolean">gboolean</link> <link linkend="gimp-path-to-selection">gimp_path_to_selection</link> (<link linkend="gint32">gint32</link> image_ID,
56
const <link linkend="gchar">gchar</link> *name,
57
<link linkend="GimpChannelOps">GimpChannelOps</link> op,
58
<link linkend="gboolean">gboolean</link> antialias,
59
<link linkend="gboolean">gboolean</link> feather,
60
<link linkend="gdouble">gdouble</link> feather_radius_x,
61
<link linkend="gdouble">gdouble</link> feather_radius_y);
62
<link linkend="gboolean">gboolean</link> <link linkend="gimp-path-import">gimp_path_import</link> (<link linkend="gint32">gint32</link> image_ID,
63
const <link linkend="gchar">gchar</link> *filename,
64
<link linkend="gboolean">gboolean</link> merge,
65
<link linkend="gboolean">gboolean</link> scale);
77
<refsect1 id="libgimp-gimppaths.description" role="desc">
78
<title role="desc.title">Description</title>
80
Operations related to paths.
84
<refsect1 id="libgimp-gimppaths.details" role="details">
85
<title role="details.title">Details</title>
86
<refsect2 id="gimp-path-list" role="function" condition="deprecated:">
87
<title>gimp_path_list ()</title>
88
<indexterm zone="gimp-path-list" role="deprecated"><primary sortas="gimp_path_list">gimp_path_list</primary></indexterm><programlisting><link linkend="gchar">gchar</link>** gimp_path_list (<link linkend="gint32">gint32</link> image_ID,
89
<link linkend="gint">gint</link> *num_paths);</programlisting>
90
<warning><para><literal>gimp_path_list</literal> is deprecated and should not be used in newly-written code.</para></warning>
92
This procedure is deprecated! Use <link linkend="gimp-image-get-vectors"><function>gimp_image_get_vectors()</function></link> instead.</para>
94
</para><variablelist role="params">
95
<varlistentry><term><parameter>image_ID</parameter> :</term>
96
<listitem><simpara> The image to list the paths from.
97
</simpara></listitem></varlistentry>
98
<varlistentry><term><parameter>num_paths</parameter> :</term>
99
<listitem><simpara> The number of paths returned.
100
</simpara></listitem></varlistentry>
101
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> List of the paths belonging to this image.
102
</simpara></listitem></varlistentry>
103
</variablelist></refsect2>
104
<refsect2 id="gimp-path-get-points" role="function" condition="deprecated:">
105
<title>gimp_path_get_points ()</title>
106
<indexterm zone="gimp-path-get-points" role="deprecated"><primary sortas="gimp_path_get_points">gimp_path_get_points</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_path_get_points (<link linkend="gint32">gint32</link> image_ID,
107
const <link linkend="gchar">gchar</link> *name,
108
<link linkend="gint">gint</link> *path_closed,
109
<link linkend="gint">gint</link> *num_path_point_details,
110
<link linkend="gdouble">gdouble</link> **points_pairs);</programlisting>
111
<warning><para><literal>gimp_path_get_points</literal> is deprecated and should not be used in newly-written code.</para></warning>
113
This procedure is deprecated! Use <link linkend="gimp-vectors-stroke-get-points"><function>gimp_vectors_stroke_get_points()</function></link>
116
</para><variablelist role="params">
117
<varlistentry><term><parameter>image_ID</parameter> :</term>
118
<listitem><simpara> The image to list the paths from.
119
</simpara></listitem></varlistentry>
120
<varlistentry><term><parameter>name</parameter> :</term>
121
<listitem><simpara> The name of the path whose points should be listed.
122
</simpara></listitem></varlistentry>
123
<varlistentry><term><parameter>path_closed</parameter> :</term>
124
<listitem><simpara> Return if the path is closed. (0 = path open, 1 = path closed).
125
</simpara></listitem></varlistentry>
126
<varlistentry><term><parameter>num_path_point_details</parameter> :</term>
127
<listitem><simpara> The number of points returned. Each point is made up of (x, y, pnt_type) of floats.
128
</simpara></listitem></varlistentry>
129
<varlistentry><term><parameter>points_pairs</parameter> :</term>
130
<listitem><simpara> The points in the path represented as 3 floats. The first is the x pos, next is the y pos, last is the type of the pnt. The type field is dependant on the path type. For beziers (type 1 paths) the type can either be (1.0 = BEZIER_ANCHOR, 2.0 = BEZIER_CONTROL, 3.0 = BEZIER_MOVE). Note all points are returned in pixel resolution.
131
</simpara></listitem></varlistentry>
132
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The type of the path. Currently only one type (1 = Bezier) is supported.
133
</simpara></listitem></varlistentry>
134
</variablelist></refsect2>
135
<refsect2 id="gimp-path-get-current" role="function" condition="deprecated:">
136
<title>gimp_path_get_current ()</title>
137
<indexterm zone="gimp-path-get-current" role="deprecated"><primary sortas="gimp_path_get_current">gimp_path_get_current</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_path_get_current (<link linkend="gint32">gint32</link> image_ID);</programlisting>
138
<warning><para><literal>gimp_path_get_current</literal> is deprecated and should not be used in newly-written code.</para></warning>
140
This procedure is deprecated! Use <link linkend="gimp-image-get-active-vectors"><function>gimp_image_get_active_vectors()</function></link>
143
</para><variablelist role="params">
144
<varlistentry><term><parameter>image_ID</parameter> :</term>
145
<listitem><simpara> The image to get the current path from.
146
</simpara></listitem></varlistentry>
147
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The name of the current path.
148
</simpara></listitem></varlistentry>
149
</variablelist></refsect2>
150
<refsect2 id="gimp-path-set-current" role="function" condition="deprecated:">
151
<title>gimp_path_set_current ()</title>
152
<indexterm zone="gimp-path-set-current" role="deprecated"><primary sortas="gimp_path_set_current">gimp_path_set_current</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_path_set_current (<link linkend="gint32">gint32</link> image_ID,
153
const <link linkend="gchar">gchar</link> *name);</programlisting>
154
<warning><para><literal>gimp_path_set_current</literal> is deprecated and should not be used in newly-written code.</para></warning>
156
This procedure is deprecated! Use <link linkend="gimp-image-set-active-vectors"><function>gimp_image_set_active_vectors()</function></link>
159
</para><variablelist role="params">
160
<varlistentry><term><parameter>image_ID</parameter> :</term>
161
<listitem><simpara> The image in which a path will become current.
162
</simpara></listitem></varlistentry>
163
<varlistentry><term><parameter>name</parameter> :</term>
164
<listitem><simpara> The name of the path to make current.
165
</simpara></listitem></varlistentry>
166
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
167
</simpara></listitem></varlistentry>
168
</variablelist></refsect2>
169
<refsect2 id="gimp-path-set-points" role="function" condition="deprecated:">
170
<title>gimp_path_set_points ()</title>
171
<indexterm zone="gimp-path-set-points" role="deprecated"><primary sortas="gimp_path_set_points">gimp_path_set_points</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_path_set_points (<link linkend="gint32">gint32</link> image_ID,
172
const <link linkend="gchar">gchar</link> *name,
173
<link linkend="gint">gint</link> ptype,
174
<link linkend="gint">gint</link> num_path_points,
175
const <link linkend="gdouble">gdouble</link> *points_pairs);</programlisting>
176
<warning><para><literal>gimp_path_set_points</literal> is deprecated and should not be used in newly-written code.</para></warning>
178
This procedure is deprecated! Use <link linkend="vectors-stroke-new-from-points"><function>vectors_stroke_new_from_points()</function></link>
181
</para><variablelist role="params">
182
<varlistentry><term><parameter>image_ID</parameter> :</term>
183
<listitem><simpara> The image to set the paths in.
184
</simpara></listitem></varlistentry>
185
<varlistentry><term><parameter>name</parameter> :</term>
186
<listitem><simpara> The name of the path to create. If it exists then a unique name will be created - query the list of paths if you want to make sure that the name of the path you create is unique. This will be set as the current path.
187
</simpara></listitem></varlistentry>
188
<varlistentry><term><parameter>ptype</parameter> :</term>
189
<listitem><simpara> The type of the path. Currently only one type (1 = Bezier) is supported.
190
</simpara></listitem></varlistentry>
191
<varlistentry><term><parameter>num_path_points</parameter> :</term>
192
<listitem><simpara> The number of elements in the array, i.e. the number of points in the path * 3. Each point is made up of (x, y, type) of floats. Currently only the creation of bezier curves is allowed. The type parameter must be set to (1) to indicate a BEZIER type curve. Note that for BEZIER curves, points must be given in the following order: ACCACCAC... If the path is not closed the last control point is missed off. Points consist of three control points (control/anchor/control) so for a curve that is not closed there must be at least two points passed (2 x,y pairs). If (num_path_points/3) % 3 = 0 then the path is assumed to be closed and the points are ACCACCACCACC.
193
</simpara></listitem></varlistentry>
194
<varlistentry><term><parameter>points_pairs</parameter> :</term>
195
<listitem><simpara> The points in the path represented as 3 floats. The first is the x pos, next is the y pos, last is the type of the pnt. The type field is dependant on the path type. For beziers (type 1 paths) the type can either be (1.0 = BEZIER_ANCHOR, 2.0 = BEZIER_CONTROL, 3.0= BEZIER_MOVE). Note all points are returned in pixel resolution.
196
</simpara></listitem></varlistentry>
197
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
198
</simpara></listitem></varlistentry>
199
</variablelist></refsect2>
200
<refsect2 id="gimp-path-stroke-current" role="function" condition="deprecated:">
201
<title>gimp_path_stroke_current ()</title>
202
<indexterm zone="gimp-path-stroke-current" role="deprecated"><primary sortas="gimp_path_stroke_current">gimp_path_stroke_current</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_path_stroke_current (<link linkend="gint32">gint32</link> image_ID);</programlisting>
203
<warning><para><literal>gimp_path_stroke_current</literal> is deprecated and should not be used in newly-written code.</para></warning>
205
This procedure is deprecated! Use <link linkend="gimp-edit-stroke-vectors"><function>gimp_edit_stroke_vectors()</function></link>
208
</para><variablelist role="params">
209
<varlistentry><term><parameter>image_ID</parameter> :</term>
210
<listitem><simpara> The image which contains the path to stroke.
211
</simpara></listitem></varlistentry>
212
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
213
</simpara></listitem></varlistentry>
214
</variablelist></refsect2>
215
<refsect2 id="gimp-path-get-point-at-dist" role="function" condition="deprecated:">
216
<title>gimp_path_get_point_at_dist ()</title>
217
<indexterm zone="gimp-path-get-point-at-dist" role="deprecated"><primary sortas="gimp_path_get_point_at_dist">gimp_path_get_point_at_dist</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_path_get_point_at_dist (<link linkend="gint32">gint32</link> image_ID,
218
<link linkend="gdouble">gdouble</link> distance,
219
<link linkend="gint">gint</link> *y_point,
220
<link linkend="gdouble">gdouble</link> *slope);</programlisting>
221
<warning><para><literal>gimp_path_get_point_at_dist</literal> is deprecated and should not be used in newly-written code.</para></warning>
223
This procedure is deprecated! Use
224
<link linkend="gimp-vectors-stroke-get-point-at-dist"><function>gimp_vectors_stroke_get_point_at_dist()</function></link> instead.</para>
226
</para><variablelist role="params">
227
<varlistentry><term><parameter>image_ID</parameter> :</term>
228
<listitem><simpara> The image the paths belongs to.
229
</simpara></listitem></varlistentry>
230
<varlistentry><term><parameter>distance</parameter> :</term>
231
<listitem><simpara> The distance along the path.
232
</simpara></listitem></varlistentry>
233
<varlistentry><term><parameter>y_point</parameter> :</term>
234
<listitem><simpara> The y position of the point.
235
</simpara></listitem></varlistentry>
236
<varlistentry><term><parameter>slope</parameter> :</term>
237
<listitem><simpara> The slope (dy / dx) at the specified point.
238
</simpara></listitem></varlistentry>
239
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The x position of the point.
240
</simpara></listitem></varlistentry>
241
</variablelist></refsect2>
242
<refsect2 id="gimp-path-get-tattoo" role="function" condition="deprecated:">
243
<title>gimp_path_get_tattoo ()</title>
244
<indexterm zone="gimp-path-get-tattoo" role="deprecated"><primary sortas="gimp_path_get_tattoo">gimp_path_get_tattoo</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_path_get_tattoo (<link linkend="gint32">gint32</link> image_ID,
245
const <link linkend="gchar">gchar</link> *name);</programlisting>
246
<warning><para><literal>gimp_path_get_tattoo</literal> is deprecated and should not be used in newly-written code.</para></warning>
248
This procedure is deprecated! Use <link linkend="gimp-vectors-get-tattoo"><function>gimp_vectors_get_tattoo()</function></link> instead.</para>
250
</para><variablelist role="params">
251
<varlistentry><term><parameter>image_ID</parameter> :</term>
252
<listitem><simpara> The image.
253
</simpara></listitem></varlistentry>
254
<varlistentry><term><parameter>name</parameter> :</term>
255
<listitem><simpara> The name of the path whose tattoo should be obtained.
256
</simpara></listitem></varlistentry>
257
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The tattoo associated with the named path.
258
</simpara></listitem></varlistentry>
259
</variablelist></refsect2>
260
<refsect2 id="gimp-get-path-by-tattoo" role="function" condition="deprecated:">
261
<title>gimp_get_path_by_tattoo ()</title>
262
<indexterm zone="gimp-get-path-by-tattoo" role="deprecated"><primary sortas="gimp_get_path_by_tattoo">gimp_get_path_by_tattoo</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_get_path_by_tattoo (<link linkend="gint32">gint32</link> image_ID,
263
<link linkend="gint">gint</link> tattoo);</programlisting>
264
<warning><para><literal>gimp_get_path_by_tattoo</literal> is deprecated and should not be used in newly-written code.</para></warning>
266
This procedure is deprecated! Use <link linkend="gimp-image-get-vectors-by-tattoo"><function>gimp_image_get_vectors_by_tattoo()</function></link>
269
</para><variablelist role="params">
270
<varlistentry><term><parameter>image_ID</parameter> :</term>
271
<listitem><simpara> The image.
272
</simpara></listitem></varlistentry>
273
<varlistentry><term><parameter>tattoo</parameter> :</term>
274
<listitem><simpara> The tattoo of the required path.
275
</simpara></listitem></varlistentry>
276
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The name of the path with the specified tattoo.
277
</simpara></listitem></varlistentry>
278
</variablelist></refsect2>
279
<refsect2 id="gimp-path-delete" role="function" condition="deprecated:">
280
<title>gimp_path_delete ()</title>
281
<indexterm zone="gimp-path-delete" role="deprecated"><primary sortas="gimp_path_delete">gimp_path_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_path_delete (<link linkend="gint32">gint32</link> image_ID,
282
const <link linkend="gchar">gchar</link> *name);</programlisting>
283
<warning><para><literal>gimp_path_delete</literal> is deprecated and should not be used in newly-written code.</para></warning>
285
This procedure is deprecated! Use <link linkend="gimp-image-remove-vectors"><function>gimp_image_remove_vectors()</function></link>
288
</para><variablelist role="params">
289
<varlistentry><term><parameter>image_ID</parameter> :</term>
290
<listitem><simpara> The image to delete the path from.
291
</simpara></listitem></varlistentry>
292
<varlistentry><term><parameter>name</parameter> :</term>
293
<listitem><simpara> The name of the path to delete.
294
</simpara></listitem></varlistentry>
295
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
296
</simpara></listitem></varlistentry>
297
</variablelist></refsect2>
298
<refsect2 id="gimp-path-get-locked" role="function" condition="deprecated:">
299
<title>gimp_path_get_locked ()</title>
300
<indexterm zone="gimp-path-get-locked" role="deprecated"><primary sortas="gimp_path_get_locked">gimp_path_get_locked</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_path_get_locked (<link linkend="gint32">gint32</link> image_ID,
301
const <link linkend="gchar">gchar</link> *name);</programlisting>
302
<warning><para><literal>gimp_path_get_locked</literal> is deprecated and should not be used in newly-written code.</para></warning>
304
This procedure is deprecated! Use <link linkend="gimp-vectors-get-linked"><function>gimp_vectors_get_linked()</function></link> instead.</para>
306
</para><variablelist role="params">
307
<varlistentry><term><parameter>image_ID</parameter> :</term>
308
<listitem><simpara> The image.
309
</simpara></listitem></varlistentry>
310
<varlistentry><term><parameter>name</parameter> :</term>
311
<listitem><simpara> The name of the path whose locked status should be obtained.
312
</simpara></listitem></varlistentry>
313
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the path is locked, FALSE otherwise.
314
</simpara></listitem></varlistentry>
315
</variablelist></refsect2>
316
<refsect2 id="gimp-path-set-locked" role="function" condition="deprecated:">
317
<title>gimp_path_set_locked ()</title>
318
<indexterm zone="gimp-path-set-locked" role="deprecated"><primary sortas="gimp_path_set_locked">gimp_path_set_locked</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_path_set_locked (<link linkend="gint32">gint32</link> image_ID,
319
const <link linkend="gchar">gchar</link> *name,
320
<link linkend="gboolean">gboolean</link> locked);</programlisting>
321
<warning><para><literal>gimp_path_set_locked</literal> is deprecated and should not be used in newly-written code.</para></warning>
323
This procedure is deprecated! Use <link linkend="gimp-vectors-set-linked"><function>gimp_vectors_set_linked()</function></link> instead.</para>
325
</para><variablelist role="params">
326
<varlistentry><term><parameter>image_ID</parameter> :</term>
327
<listitem><simpara> The image.
328
</simpara></listitem></varlistentry>
329
<varlistentry><term><parameter>name</parameter> :</term>
330
<listitem><simpara> the name of the path whose locked status should be set.
331
</simpara></listitem></varlistentry>
332
<varlistentry><term><parameter>locked</parameter> :</term>
333
<listitem><simpara> Whether the path is locked.
334
</simpara></listitem></varlistentry>
335
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
336
</simpara></listitem></varlistentry>
337
</variablelist></refsect2>
338
<refsect2 id="gimp-path-set-tattoo" role="function" condition="deprecated:">
339
<title>gimp_path_set_tattoo ()</title>
340
<indexterm zone="gimp-path-set-tattoo" role="deprecated"><primary sortas="gimp_path_set_tattoo">gimp_path_set_tattoo</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_path_set_tattoo (<link linkend="gint32">gint32</link> image_ID,
341
const <link linkend="gchar">gchar</link> *name,
342
<link linkend="gint">gint</link> tattovalue);</programlisting>
343
<warning><para><literal>gimp_path_set_tattoo</literal> is deprecated and should not be used in newly-written code.</para></warning>
345
This procedure is deprecated! Use <link linkend="gimp-vectors-set-tattoo"><function>gimp_vectors_set_tattoo()</function></link> instead.</para>
347
</para><variablelist role="params">
348
<varlistentry><term><parameter>image_ID</parameter> :</term>
349
<listitem><simpara> The image.
350
</simpara></listitem></varlistentry>
351
<varlistentry><term><parameter>name</parameter> :</term>
352
<listitem><simpara> the name of the path whose tattoo should be set.
353
</simpara></listitem></varlistentry>
354
<varlistentry><term><parameter>tattovalue</parameter> :</term>
355
<listitem><simpara> The tattoo associated with the name path. Only values returned from 'path_get_tattoo' should be used here.
356
</simpara></listitem></varlistentry>
357
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
358
</simpara></listitem></varlistentry>
359
</variablelist></refsect2>
360
<refsect2 id="gimp-path-to-selection" role="function" condition="deprecated:">
361
<title>gimp_path_to_selection ()</title>
362
<indexterm zone="gimp-path-to-selection" role="deprecated"><primary sortas="gimp_path_to_selection">gimp_path_to_selection</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_path_to_selection (<link linkend="gint32">gint32</link> image_ID,
363
const <link linkend="gchar">gchar</link> *name,
364
<link linkend="GimpChannelOps">GimpChannelOps</link> op,
365
<link linkend="gboolean">gboolean</link> antialias,
366
<link linkend="gboolean">gboolean</link> feather,
367
<link linkend="gdouble">gdouble</link> feather_radius_x,
368
<link linkend="gdouble">gdouble</link> feather_radius_y);</programlisting>
369
<warning><para><literal>gimp_path_to_selection</literal> is deprecated and should not be used in newly-written code.</para></warning>
371
This procedure is deprecated! Use <link linkend="gimp-vectors-to-selection"><function>gimp_vectors_to_selection()</function></link>
374
</para><variablelist role="params">
375
<varlistentry><term><parameter>image_ID</parameter> :</term>
376
<listitem><simpara> The image.
377
</simpara></listitem></varlistentry>
378
<varlistentry><term><parameter>name</parameter> :</term>
379
<listitem><simpara> The name of the path which should be made into selection.
380
</simpara></listitem></varlistentry>
381
<varlistentry><term><parameter>op</parameter> :</term>
382
<listitem><simpara> The desired operation with current selection.
383
</simpara></listitem></varlistentry>
384
<varlistentry><term><parameter>antialias</parameter> :</term>
385
<listitem><simpara> Antialias selection.
386
</simpara></listitem></varlistentry>
387
<varlistentry><term><parameter>feather</parameter> :</term>
388
<listitem><simpara> Feather selection.
389
</simpara></listitem></varlistentry>
390
<varlistentry><term><parameter>feather_radius_x</parameter> :</term>
391
<listitem><simpara> Feather radius x.
392
</simpara></listitem></varlistentry>
393
<varlistentry><term><parameter>feather_radius_y</parameter> :</term>
394
<listitem><simpara> Feather radius y.
395
</simpara></listitem></varlistentry>
396
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
397
</simpara></listitem></varlistentry>
398
</variablelist></refsect2>
399
<refsect2 id="gimp-path-import" role="function" condition="deprecated:">
400
<title>gimp_path_import ()</title>
401
<indexterm zone="gimp-path-import" role="deprecated"><primary sortas="gimp_path_import">gimp_path_import</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_path_import (<link linkend="gint32">gint32</link> image_ID,
402
const <link linkend="gchar">gchar</link> *filename,
403
<link linkend="gboolean">gboolean</link> merge,
404
<link linkend="gboolean">gboolean</link> scale);</programlisting>
405
<warning><para><literal>gimp_path_import</literal> is deprecated and should not be used in newly-written code.</para></warning>
407
This procedure is deprecated! Use <link linkend="vectors-import-from-file"><function>vectors_import_from_file()</function></link>
410
</para><variablelist role="params">
411
<varlistentry><term><parameter>image_ID</parameter> :</term>
412
<listitem><simpara> The image.
413
</simpara></listitem></varlistentry>
414
<varlistentry><term><parameter>filename</parameter> :</term>
415
<listitem><simpara> The name of the SVG file to import.
416
</simpara></listitem></varlistentry>
417
<varlistentry><term><parameter>merge</parameter> :</term>
418
<listitem><simpara> Merge paths into a single vectors object.
419
</simpara></listitem></varlistentry>
420
<varlistentry><term><parameter>scale</parameter> :</term>
421
<listitem><simpara> Scale the SVG to image dimensions.
422
</simpara></listitem></varlistentry>
423
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
424
</simpara></listitem></varlistentry>
425
</variablelist></refsect2>
added
removed
devel-docs/libgimp/xml/gimppaths.xml
