callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Imported Upstream version 2.2.9

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:15:37 -04:00
parent 0b9c5e2b5d
commit f6af42dd71
596 changed files with 118511 additions and 46407 deletions
Download Patch File Download Diff File Expand all files Collapse all files

805
devel-docs/libgimp/html/libgimp-gimppaths.html
View File

@ -1,4 +1,43 @@
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimppaths</title><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"><link rel="start" href="index.html" title="GIMP Library Reference Manual"><link rel="up" href="libgimp-image.html" title="Manupulating Images and all their Properties"><link rel="prev" href="libgimp-gimplayer.html" title="gimplayer"><link rel="next" href="libgimp-gimppixelfetcher.html" title="gimppixelfetcher"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="gimpdefinitions.html" title="Part<72>I.<2E>GIMP Constants"><link rel="part" href="libgimp.html" title="Part<72>II.<2E>GIMP Library"><link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images"><link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties"><link rel="chapter" href="libgimp-data.html" title="Data Objects"><link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs"><link rel="part" href="libgimpui.html" title="Part<72>III.<2E>GIMP User Interface Library"><link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libgimp-gimplayer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">GIMP Library Reference Manual</th><td><a accesskey="n" href="libgimp-gimppixelfetcher.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="libgimp-gimppaths"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">gimppaths</span></h2><p>gimppaths &#8212; Operations related to paths.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimppaths</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manupulating Images and all their Properties">
<link rel="prev" href="libgimp-gimplayer.html" title="gimplayer">
<link rel="next" href="libgimp-gimppixelfetcher.html" title="gimppixelfetcher">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;GIMP Library">
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="part" href="libgimpui.html" title="Part&#160;III.&#160;GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="libgimp-gimplayer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimppixelfetcher.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry" lang="en">
<a name="libgimp-gimppaths"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">gimppaths</span></h2>
<p>gimppaths &#8212; Operations related to paths.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
@ -47,193 +86,717 @@ gboolean <a href="libgimp-gimppaths.html#gimp-path-import">gimp_path_import</
const gchar *filename,
gboolean merge,
gboolean scale);
</pre></div><div class="refsect1" lang="en"><a name="id2616472"></a><h2>Description</h2><p>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2592082"></a><h2>Description</h2>
<p>
Operations related to paths.
</p></div><div class="refsect1" lang="en"><a name="id2616481"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2616487"></a><h3><a name="gimp-path-list"></a>gimp_path_list ()</h3><a class="indexterm" name="id2616495"></a><pre class="programlisting">gchar** gimp_path_list (gint32 image_ID,
gint *num_paths);</pre><p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2592092"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2592099"></a><h3>
<a name="gimp-path-list"></a>gimp_path_list ()</h3>
<a class="indexterm" name="id2592109"></a><pre class="programlisting">gchar** gimp_path_list (gint32 image_ID,
gint *num_paths);</pre>
<p>
List the paths associated with the passed image.
</p><p>
List the paths associated with the passed image.</p><p>
</p>
<p>
List the paths associated with the passed image.</p>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>image_ID</code></em><EFBFBD>:</span></td><td> The ID of the image to list the paths from.
</td></tr><tr><td><span class="term"><em class="parameter"><code>num_paths</code></em><EFBFBD>:</span></td><td> The number of paths returned.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> List of the paths belonging to this image.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2616565"></a><h3><a name="gimp-path-get-points"></a>gimp_path_get_points ()</h3><a class="indexterm" name="id2616574"></a><pre class="programlisting">gint gimp_path_get_points (gint32 image_ID,
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The ID of the image to list the paths from.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>num_paths</code></em>&#160;:</span></td>
<td> The number of paths returned.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> List of the paths belonging to this image.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2592196"></a><h3>
<a name="gimp-path-get-points"></a>gimp_path_get_points ()</h3>
<a class="indexterm" name="id2592204"></a><pre class="programlisting">gint gimp_path_get_points (gint32 image_ID,
const gchar *name,
gint *path_closed,
gint *num_path_point_details,
gdouble **points_pairs);</pre><p>
gdouble **points_pairs);</pre>
<p>
List the points associated with the named path.
</p><p>
List the points associated with the named path.</p><p>
</p>
<p>
List the points associated with the named path.</p>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>image_ID</code></em><EFBFBD>:</span></td><td> The ID of the image to list the paths from.
</td></tr><tr><td><span class="term"><em class="parameter"><code>name</code></em><EFBFBD>:</span></td><td> The name of the path whose points should be listed.
</td></tr><tr><td><span class="term"><em class="parameter"><code>path_closed</code></em><EFBFBD>:</span></td><td> Return if the path is closed. (0 = path open, 1 = path closed).
</td></tr><tr><td><span class="term"><em class="parameter"><code>num_path_point_details</code></em><EFBFBD>:</span></td><td> The number of points returned. Each point is made up of (x, y, pnt_type) of floats.
</td></tr><tr><td><span class="term"><em class="parameter"><code>points_pairs</code></em><EFBFBD>:</span></td><td> 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.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> The type of the path. Currently only one type (1 = Bezier) is supported.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2611688"></a><h3><a name="gimp-path-get-current"></a>gimp_path_get_current ()</h3><a class="indexterm" name="id2611697"></a><pre class="programlisting">gchar* gimp_path_get_current (gint32 image_ID);</pre><p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The ID of the image to list the paths from.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The name of the path whose points should be listed.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>path_closed</code></em>&#160;:</span></td>
<td> Return if the path is closed. (0 = path open, 1 = path closed).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>num_path_point_details</code></em>&#160;:</span></td>
<td> The number of points returned. Each point is made up of (x, y, pnt_type) of floats.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>points_pairs</code></em>&#160;:</span></td>
<td> 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.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The type of the path. Currently only one type (1 = Bezier) is supported.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2592364"></a><h3>
<a name="gimp-path-get-current"></a>gimp_path_get_current ()</h3>
<a class="indexterm" name="id2592372"></a><pre class="programlisting">gchar* gimp_path_get_current (gint32 image_ID);</pre>
<p>
The name of the current path. Error if no paths.
</p><p>
The name of the current path. Error if no paths.</p><p>
</p>
<p>
The name of the current path. Error if no paths.</p>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>image_ID</code></em><EFBFBD>:</span></td><td> The ID of the image to get the current path from.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> The name of the current path.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2611749"></a><h3><a name="gimp-path-set-current"></a>gimp_path_set_current ()</h3><a class="indexterm" name="id2611758"></a><pre class="programlisting">gboolean gimp_path_set_current (gint32 image_ID,
const gchar *name);</pre><p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The ID of the image to get the current path from.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The name of the current path.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2592437"></a><h3>
<a name="gimp-path-set-current"></a>gimp_path_set_current ()</h3>
<a class="indexterm" name="id2592446"></a><pre class="programlisting">gboolean gimp_path_set_current (gint32 image_ID,
const gchar *name);</pre>
<p>
Sets the current path associated with the passed image.
</p><p>
Sets a named path as the current path.</p><p>
</p>
<p>
Sets a named path as the current path.</p>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>image_ID</code></em><EFBFBD>:</span></td><td> The ID of the image in which a path will become current.
</td></tr><tr><td><span class="term"><em class="parameter"><code>name</code></em><EFBFBD>:</span></td><td> The name of the path to make current.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2611827"></a><h3><a name="gimp-path-set-points"></a>gimp_path_set_points ()</h3><a class="indexterm" name="id2611835"></a><pre class="programlisting">gboolean gimp_path_set_points (gint32 image_ID,
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The ID of the image in which a path will become current.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The name of the path to make current.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2599469"></a><h3>
<a name="gimp-path-set-points"></a>gimp_path_set_points ()</h3>
<a class="indexterm" name="id2599478"></a><pre class="programlisting">gboolean gimp_path_set_points (gint32 image_ID,
const gchar *name,
gint ptype,
gint num_path_points,
const gdouble *points_pairs);</pre><p>
const gdouble *points_pairs);</pre>
<p>
Set the points associated with the named path.
</p><p>
Set the points associated with the named path.</p><p>
</p>
<p>
Set the points associated with the named path.</p>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>image_ID</code></em><EFBFBD>:</span></td><td> The ID of the image to set the paths in.
</td></tr><tr><td><span class="term"><em class="parameter"><code>name</code></em><EFBFBD>:</span></td><td> 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.
</td></tr><tr><td><span class="term"><em class="parameter"><code>ptype</code></em><EFBFBD>:</span></td><td> The type of the path. Currently only one type (1 = Bezier) is supported.
</td></tr><tr><td><span class="term"><em class="parameter"><code>num_path_points</code></em><EFBFBD>:</span></td><td> 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.
</td></tr><tr><td><span class="term"><em class="parameter"><code>points_pairs</code></em><EFBFBD>:</span></td><td> 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.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2570337"></a><h3><a name="gimp-path-stroke-current"></a>gimp_path_stroke_current ()</h3><a class="indexterm" name="id2575676"></a><pre class="programlisting">gboolean gimp_path_stroke_current (gint32 image_ID);</pre><p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The ID of the image to set the paths in.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> 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.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>ptype</code></em>&#160;:</span></td>
<td> The type of the path. Currently only one type (1 = Bezier) is supported.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>num_path_points</code></em>&#160;:</span></td>
<td> 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.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>points_pairs</code></em>&#160;:</span></td>
<td> 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.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2599625"></a><h3>
<a name="gimp-path-stroke-current"></a>gimp_path_stroke_current ()</h3>
<a class="indexterm" name="id2599634"></a><pre class="programlisting">gboolean gimp_path_stroke_current (gint32 image_ID);</pre>
<p>
Stroke the current path in the passed image.
</p><p>
Stroke the current path in the passed image.</p><p>
</p>
<p>
Stroke the current path in the passed image.</p>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>image_ID</code></em><EFBFBD>:</span></td><td> The ID of the image which contains the path to stroke.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2621170"></a><h3><a name="gimp-path-get-point-at-dist"></a>gimp_path_get_point_at_dist ()</h3><a class="indexterm" name="id2621178"></a><pre class="programlisting">gint gimp_path_get_point_at_dist (gint32 image_ID,
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The ID of the image which contains the path to stroke.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2599700"></a><h3>
<a name="gimp-path-get-point-at-dist"></a>gimp_path_get_point_at_dist ()</h3>
<a class="indexterm" name="id2599708"></a><pre class="programlisting">gint gimp_path_get_point_at_dist (gint32 image_ID,
gdouble distance,
gint *y_point,
gdouble *slope);</pre><p>
gdouble *slope);</pre>
<p>
Get point on a path at a specified distance along the path.
</p><p>
</p>
<p>
This will return the x,y position of a point at a given distance
along the bezier curve. The distance will be obtained by first
digitizing the curve internally and then walking along the curve.
For a closed curve the start of the path is the first point on the
path that was created. This might not be obvious. Note the current
path is used.</p><p>
path is used.</p>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>image_ID</code></em><EFBFBD>:</span></td><td> The ID of the image the paths belongs to.
</td></tr><tr><td><span class="term"><em class="parameter"><code>distance</code></em><EFBFBD>:</span></td><td> The distance along the path.
</td></tr><tr><td><span class="term"><em class="parameter"><code>y_point</code></em><EFBFBD>:</span></td><td> The y position of the point.
</td></tr><tr><td><span class="term"><em class="parameter"><code>slope</code></em><EFBFBD>:</span></td><td> The slope (dy / dx) at the specified point.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> The x position of the point.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2621279"></a><h3><a name="gimp-path-get-tattoo"></a>gimp_path_get_tattoo ()</h3><a class="indexterm" name="id2621286"></a><pre class="programlisting">gint gimp_path_get_tattoo (gint32 image_ID,
const gchar *name);</pre><p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The ID of the image the paths belongs to.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>distance</code></em>&#160;:</span></td>
<td> The distance along the path.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y_point</code></em>&#160;:</span></td>
<td> The y position of the point.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>slope</code></em>&#160;:</span></td>
<td> The slope (dy / dx) at the specified point.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The x position of the point.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2599841"></a><h3>
<a name="gimp-path-get-tattoo"></a>gimp_path_get_tattoo ()</h3>
<a class="indexterm" name="id2599850"></a><pre class="programlisting">gint gimp_path_get_tattoo (gint32 image_ID,
const gchar *name);</pre>
<p>
Returns the tattoo associated with the name path.
</p><p>
</p>
<p>
This procedure returns the tattoo associated with the specified
path. A tattoo is a unique and permanent identifier attached to a
path that can be used to uniquely identify a path within an image
even between sessions.</p><p>
even between sessions.</p>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>image_ID</code></em><EFBFBD>:</span></td><td> The image.
</td></tr><tr><td><span class="term"><em class="parameter"><code>name</code></em><EFBFBD>:</span></td><td> The name of the path whose tattoo should be obtained.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> The tattoo associated with the named path.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2621353"></a><h3><a name="gimp-get-path-by-tattoo"></a>gimp_get_path_by_tattoo ()</h3><a class="indexterm" name="id2621360"></a><pre class="programlisting">gchar* gimp_get_path_by_tattoo (gint32 image_ID,
gint tattoo);</pre><p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The name of the path whose tattoo should be obtained.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The tattoo associated with the named path.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2599940"></a><h3>
<a name="gimp-get-path-by-tattoo"></a>gimp_get_path_by_tattoo ()</h3>
<a class="indexterm" name="id2599949"></a><pre class="programlisting">gchar* gimp_get_path_by_tattoo (gint32 image_ID,
gint tattoo);</pre>
<p>
Return the name of the path with the given tattoo.
</p><p>
</p>
<p>
The procedure returns the name of the path in the specified image
which has the passed tattoo. The tattoos are unique within the image
and will be preserved across sessions and through renaming of the
path. An error is returned if no path with the specified tattoo can
be found.</p><p>
be found.</p>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>image_ID</code></em><EFBFBD>:</span></td><td> The image.
</td></tr><tr><td><span class="term"><em class="parameter"><code>tattoo</code></em><EFBFBD>:</span></td><td> The tattoo of the required path.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> The name of the path with the specified tattoo.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2621429"></a><h3><a name="gimp-path-delete"></a>gimp_path_delete ()</h3><a class="indexterm" name="id2621438"></a><pre class="programlisting">gboolean gimp_path_delete (gint32 image_ID,
const gchar *name);</pre><p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>tattoo</code></em>&#160;:</span></td>
<td> The tattoo of the required path.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The name of the path with the specified tattoo.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2600040"></a><h3>
<a name="gimp-path-delete"></a>gimp_path_delete ()</h3>
<a class="indexterm" name="id2600050"></a><pre class="programlisting">gboolean gimp_path_delete (gint32 image_ID,
const gchar *name);</pre>
<p>
Delete the named path associated with the passed image.
</p><p>
Delete the named path.</p><p>
</p>
<p>
Delete the named path.</p>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>image_ID</code></em><EFBFBD>:</span></td><td> The ID of the image to delete the path from.
</td></tr><tr><td><span class="term"><em class="parameter"><code>name</code></em><EFBFBD>:</span></td><td> The name of the path to delete.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2621505"></a><h3><a name="gimp-path-get-locked"></a>gimp_path_get_locked ()</h3><a class="indexterm" name="id2621514"></a><pre class="programlisting">gint gimp_path_get_locked (gint32 image_ID,
const gchar *name);</pre><p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The ID of the image to delete the path from.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The name of the path to delete.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2600136"></a><h3>
<a name="gimp-path-get-locked"></a>gimp_path_get_locked ()</h3>
<a class="indexterm" name="id2600145"></a><pre class="programlisting">gint gimp_path_get_locked (gint32 image_ID,
const gchar *name);</pre>
<p>
Returns the locked status associated with the named path.
</p><p>
</p>
<p>
This procedure returns the lock status associated with the specified
path. A path can be \"locked\" which means that the transformation
tool operations will also apply to the path.</p><p>
tool operations will also apply to the path.</p>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>image_ID</code></em><EFBFBD>:</span></td><td> The image.
</td></tr><tr><td><span class="term"><em class="parameter"><code>name</code></em><EFBFBD>:</span></td><td> The name of the path whose locked status should be obtained.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> The lock status associated with the name path. 0 is returned if the path is not locked. 1 is returned if the path is locked.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2621587"></a><h3><a name="gimp-path-set-locked"></a>gimp_path_set_locked ()</h3><a class="indexterm" name="id2621595"></a><pre class="programlisting">gboolean gimp_path_set_locked (gint32 image_ID,
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The name of the path whose locked status should be obtained.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The lock status associated with the name path. 0 is returned if the path is not locked. 1 is returned if the path is locked.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2593162"></a><h3>
<a name="gimp-path-set-locked"></a>gimp_path_set_locked ()</h3>
<a class="indexterm" name="id2593171"></a><pre class="programlisting">gboolean gimp_path_set_locked (gint32 image_ID,
const gchar *name,
gint lockstatus);</pre><p>
gint lockstatus);</pre>
<p>
Set the locked status associated with the named path.
</p><p>
</p>
<p>
This procedure sets the lock status associated with the specified
path. A path can be \"locked\" which means that the transformation
tool operations will also apply to the path.</p><p>
tool operations will also apply to the path.</p>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>image_ID</code></em><EFBFBD>:</span></td><td> The image.
</td></tr><tr><td><span class="term"><em class="parameter"><code>name</code></em><EFBFBD>:</span></td><td> the name of the path whose locked status should be set.
</td></tr><tr><td><span class="term"><em class="parameter"><code>lockstatus</code></em><EFBFBD>:</span></td><td> The lock status associated with the name path. 0 if the path is not locked. 1 if the path is to be locked.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2621686"></a><h3><a name="gimp-path-set-tattoo"></a>gimp_path_set_tattoo ()</h3><a class="indexterm" name="id2621695"></a><pre class="programlisting">gboolean gimp_path_set_tattoo (gint32 image_ID,
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> the name of the path whose locked status should be set.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>lockstatus</code></em>&#160;:</span></td>
<td> The lock status associated with the name path. 0 if the path is not locked. 1 if the path is to be locked.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2593283"></a><h3>
<a name="gimp-path-set-tattoo"></a>gimp_path_set_tattoo ()</h3>
<a class="indexterm" name="id2593292"></a><pre class="programlisting">gboolean gimp_path_set_tattoo (gint32 image_ID,
const gchar *name,
gint tattovalue);</pre><p>
gint tattovalue);</pre>
<p>
Sets the tattoo associated with the named path.
</p><p>
</p>
<p>
This procedure sets the tattoo associated with the specified path. A
tattoo is a unique and permenant identifier attached to a path that
can be used to uniquely identify a path within an image even between
sessions. Note that the value passed to this function must have been
obtained from a previous call to path_get_tattoo.</p><p>
obtained from a previous call to path_get_tattoo.</p>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>image_ID</code></em><EFBFBD>:</span></td><td> The image.
</td></tr><tr><td><span class="term"><em class="parameter"><code>name</code></em><EFBFBD>:</span></td><td> the name of the path whose tattoo should be set.
</td></tr><tr><td><span class="term"><em class="parameter"><code>tattovalue</code></em><EFBFBD>:</span></td><td> The tattoo associated with the name path. Only values returned from 'path_get_tattoo' should be used here.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2621788"></a><h3><a name="gimp-path-to-selection"></a>gimp_path_to_selection ()</h3><a class="indexterm" name="id2621796"></a><pre class="programlisting">gboolean gimp_path_to_selection (gint32 image_ID,
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> the name of the path whose tattoo should be set.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>tattovalue</code></em>&#160;:</span></td>
<td> The tattoo associated with the name path. Only values returned from 'path_get_tattoo' should be used here.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2593407"></a><h3>
<a name="gimp-path-to-selection"></a>gimp_path_to_selection ()</h3>
<a class="indexterm" name="id2593416"></a><pre class="programlisting">gboolean gimp_path_to_selection (gint32 image_ID,
const gchar *name,
<a href="libgimp-gimpenums.html#GimpChannelOps">GimpChannelOps</a> op,
gboolean antialias,
gboolean feather,
gdouble feather_radius_x,
gdouble feather_radius_y);</pre><p>
gdouble feather_radius_y);</pre>
<p>
Transforms the active path into a selection
</p><p>
This procedure renders the desired path into the current selection.</p><p>
</p>
<p>
This procedure renders the desired path into the current selection.</p>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>image_ID</code></em><EFBFBD>:</span></td><td> The image.
</td></tr><tr><td><span class="term"><em class="parameter"><code>name</code></em><EFBFBD>:</span></td><td> The name of the path which should be made into selection.
</td></tr><tr><td><span class="term"><em class="parameter"><code>op</code></em><EFBFBD>:</span></td><td> The desired operation with current selection.
</td></tr><tr><td><span class="term"><em class="parameter"><code>antialias</code></em><EFBFBD>:</span></td><td> Antialias selection.
</td></tr><tr><td><span class="term"><em class="parameter"><code>feather</code></em><EFBFBD>:</span></td><td> Feather selection.
</td></tr><tr><td><span class="term"><em class="parameter"><code>feather_radius_x</code></em><EFBFBD>:</span></td><td> Feather radius x.
</td></tr><tr><td><span class="term"><em class="parameter"><code>feather_radius_y</code></em><EFBFBD>:</span></td><td> Feather radius y.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2631318"></a><h3><a name="gimp-path-import"></a>gimp_path_import ()</h3><a class="indexterm" name="id2631327"></a><pre class="programlisting">gboolean gimp_path_import (gint32 image_ID,
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The name of the path which should be made into selection.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>op</code></em>&#160;:</span></td>
<td> The desired operation with current selection.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>antialias</code></em>&#160;:</span></td>
<td> Antialias selection.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>feather</code></em>&#160;:</span></td>
<td> Feather selection.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>feather_radius_x</code></em>&#160;:</span></td>
<td> Feather radius x.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>feather_radius_y</code></em>&#160;:</span></td>
<td> Feather radius y.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2593610"></a><h3>
<a name="gimp-path-import"></a>gimp_path_import ()</h3>
<a class="indexterm" name="id2593620"></a><pre class="programlisting">gboolean gimp_path_import (gint32 image_ID,
const gchar *filename,
gboolean merge,
gboolean scale);</pre><p>
gboolean scale);</pre>
<p>
Import paths from an SVG file.
</p><p>
</p>
<p>
This procedure imports paths from an SVG file. This is a temporary
solution until the new vectors PDB API is in place. Don't rely on
this function being available in future GIMP releases.</p><p>
this function being available in future GIMP releases.</p>
<p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><em class="parameter"><code>image_ID</code></em><EFBFBD>:</span></td><td> The image.
</td></tr><tr><td><span class="term"><em class="parameter"><code>filename</code></em><EFBFBD>:</span></td><td> The name of the SVG file to import.
</td></tr><tr><td><span class="term"><em class="parameter"><code>merge</code></em><EFBFBD>:</span></td><td> Merge paths into a single vectors object.
</td></tr><tr><td><span class="term"><em class="parameter"><code>scale</code></em><EFBFBD>:</span></td><td> Scale the SVG to image dimensions.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span><EFBFBD>:</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libgimp-gimplayer.html"><b>&lt;&lt;<EFBFBD>gimplayer</b></a></td><td align="right"><a accesskey="n" href="libgimp-gimppixelfetcher.html"><b>gimppixelfetcher<EFBFBD>&gt;&gt;</b></a></td></tr></table></body></html>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></td>
<td> The image.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>filename</code></em>&#160;:</span></td>
<td> The name of the SVG file to import.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>merge</code></em>&#160;:</span></td>
<td> Merge paths into a single vectors object.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>scale</code></em>&#160;:</span></td>
<td> Scale the SVG to image dimensions.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="libgimp-gimplayer.html"><b>&lt;&lt;&#160;gimplayer</b></a></td>
<td align="right"><a accesskey="n" href="libgimp-gimppixelfetcher.html"><b>gimppixelfetcher&#160;&gt;&gt;</b></a></td>
</tr></table>
</body>
</html>