Imported Upstream version 2.2.14

This commit is contained in:
Ari Pollak
2010-08-11 01:17:12 -04:00
parent 70ad8213cf
commit a2f097051e
490 changed files with 35329 additions and 58398 deletions

View File

@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpbrush</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-data.html" title="Data Objects">
<link rel="prev" href="libgimp-data.html" title="Data Objects">
@ -28,16 +28,16 @@
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimpbrushes.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2532573" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2559417" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2626924" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2656357" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimpbrush"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2532573"></a><span class="refentrytitle">gimpbrush</span>
<a name="id2559417"></a><span class="refentrytitle">gimpbrush</span>
</h2>
<p>gimpbrush &#8212; Functions operating on a single brush.</p>
</td>
@ -75,17 +75,17 @@ gboolean <a href="libgimp-gimpbrush.html#gimp-brush-set-spacing">gimp_brush_s
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2626924"></a><h2>Description</h2>
<a name="id2656357"></a><h2>Description</h2>
<p>
Functions operating on a single brush.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2626939"></a><h2>Details</h2>
<a name="id2656372"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2626950"></a><h3>
<a name="id2656383"></a><h3>
<a name="gimp-brush-new"></a>gimp_brush_new ()</h3>
<a class="indexterm" name="id2626965"></a><pre class="programlisting">gchar* gimp_brush_new (const gchar *name);</pre>
<a class="indexterm" name="id2656398"></a><pre class="programlisting">gchar* gimp_brush_new (const gchar *name);</pre>
<p>
Creates a new brush
</p>
@ -98,14 +98,12 @@ This procedure creates a new, uninitialized brush</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The requested name of the new brush.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The actual new brush name.
</td>
@ -117,9 +115,9 @@ This procedure creates a new, uninitialized brush</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627033"></a><h3>
<a name="id2659999"></a><h3>
<a name="gimp-brush-duplicate"></a>gimp_brush_duplicate ()</h3>
<a class="indexterm" name="id2627047"></a><pre class="programlisting">gchar* gimp_brush_duplicate (const gchar *name);</pre>
<a class="indexterm" name="id2660013"></a><pre class="programlisting">gchar* gimp_brush_duplicate (const gchar *name);</pre>
<p>
Duplicates a brush
</p>
@ -132,14 +130,12 @@ This procedure creates an identical brush by a different name</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The brush name.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The name of the brush's copy.
</td>
@ -151,9 +147,9 @@ This procedure creates an identical brush by a different name</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627116"></a><h3>
<a name="id2660082"></a><h3>
<a name="gimp-brush-rename"></a>gimp_brush_rename ()</h3>
<a class="indexterm" name="id2627130"></a><pre class="programlisting">gchar* gimp_brush_rename (const gchar *name,
<a class="indexterm" name="id2660096"></a><pre class="programlisting">gchar* gimp_brush_rename (const gchar *name,
const gchar *new_name);</pre>
<p>
Rename a brush
@ -167,20 +163,17 @@ This procedure renames a brush</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The brush name.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>new_name</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>new_name</code></em>&#160;:</span></td>
<td> The new name of the brush.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The actual new name of the brush.
</td>
@ -192,9 +185,9 @@ This procedure renames a brush</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627220"></a><h3>
<a name="id2660186"></a><h3>
<a name="gimp-brush-delete"></a>gimp_brush_delete ()</h3>
<a class="indexterm" name="id2627234"></a><pre class="programlisting">gboolean gimp_brush_delete (const gchar *name);</pre>
<a class="indexterm" name="id2660200"></a><pre class="programlisting">gboolean gimp_brush_delete (const gchar *name);</pre>
<p>
Deletes a brush
</p>
@ -207,14 +200,12 @@ This procedure deletes a brush</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The brush name.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
@ -226,9 +217,9 @@ This procedure deletes a brush</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627865"></a><h3>
<a name="id2660878"></a><h3>
<a name="gimp-brush-get-info"></a>gimp_brush_get_info ()</h3>
<a class="indexterm" name="id2627879"></a><pre class="programlisting">gboolean gimp_brush_get_info (const gchar *name,
<a class="indexterm" name="id2660892"></a><pre class="programlisting">gboolean gimp_brush_get_info (const gchar *name,
gint *width,
gint *height,
gint *mask_bpp,
@ -246,38 +237,32 @@ includes the brush name, and the brush extents (width and height).</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The brush name.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td> The brush width.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> The brush height.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>mask_bpp</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>mask_bpp</code></em>&#160;:</span></td>
<td> The brush mask bpp.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>color_bpp</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>color_bpp</code></em>&#160;:</span></td>
<td> The brush color bpp.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
@ -289,9 +274,9 @@ includes the brush name, and the brush extents (width and height).</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2628034"></a><h3>
<a name="id2661047"></a><h3>
<a name="gimp-brush-get-pixels"></a>gimp_brush_get_pixels ()</h3>
<a class="indexterm" name="id2628048"></a><pre class="programlisting">gboolean gimp_brush_get_pixels (const gchar *name,
<a class="indexterm" name="id2661061"></a><pre class="programlisting">gboolean gimp_brush_get_pixels (const gchar *name,
gint *width,
gint *height,
gint *mask_bpp,
@ -313,62 +298,52 @@ includes the brush extents (width and height) and its pixels data.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The brush name.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td> The brush width.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> The brush height.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>mask_bpp</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>mask_bpp</code></em>&#160;:</span></td>
<td> The brush mask bpp.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>num_mask_bytes</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>num_mask_bytes</code></em>&#160;:</span></td>
<td> Length of brush mask data.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>mask_bytes</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>mask_bytes</code></em>&#160;:</span></td>
<td> The brush mask data.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>color_bpp</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>color_bpp</code></em>&#160;:</span></td>
<td> The brush color bpp.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>num_color_bytes</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>num_color_bytes</code></em>&#160;:</span></td>
<td> Length of brush color data.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>color_bytes</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>color_bytes</code></em>&#160;:</span></td>
<td> The brush color data.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
@ -380,9 +355,9 @@ includes the brush extents (width and height) and its pixels data.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2628287"></a><h3>
<a name="id2661300"></a><h3>
<a name="gimp-brush-get-spacing"></a>gimp_brush_get_spacing ()</h3>
<a class="indexterm" name="id2628301"></a><pre class="programlisting">gboolean gimp_brush_get_spacing (const gchar *name,
<a class="indexterm" name="id2661314"></a><pre class="programlisting">gboolean gimp_brush_get_spacing (const gchar *name,
gint *spacing);</pre>
<p>
Get the brush spacing.
@ -398,20 +373,17 @@ percentage of the maximum of the width and height of the mask.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The brush name.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></td>
<td> The brush spacing.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
@ -423,9 +395,9 @@ percentage of the maximum of the width and height of the mask.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2628393"></a><h3>
<a name="id2661406"></a><h3>
<a name="gimp-brush-set-spacing"></a>gimp_brush_set_spacing ()</h3>
<a class="indexterm" name="id2628407"></a><pre class="programlisting">gboolean gimp_brush_set_spacing (const gchar *name,
<a class="indexterm" name="id2661420"></a><pre class="programlisting">gboolean gimp_brush_set_spacing (const gchar *name,
gint spacing);</pre>
<p>
Set the brush spacing.
@ -440,20 +412,17 @@ The value should be a integer between 0 and 1000.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The brush name.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></td>
<td> The brush spacing.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>