439 lines
14 KiB
HTML
439 lines
14 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>gimpbrush</title>
|
|
<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">
|
|
<link rel="next" href="libgimp-gimpbrushes.html" title="gimpbrushes">
|
|
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
|
<link rel="part" href="gimpdefinitions.html" title="Part I. GIMP Constants">
|
|
<link rel="part" href="libgimp.html" title="Part II. 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 III. 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" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
|
|
<tr valign="middle">
|
|
<td><a accesskey="p" href="libgimp-data.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
|
|
<td><a accesskey="u" href="libgimp-data.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-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="#id2559417" class="shortcut">Top</a>
|
|
 | 
|
|
<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="id2559417"></a><span class="refentrytitle">gimpbrush</span>
|
|
</h2>
|
|
<p>gimpbrush — Functions operating on a single brush.</p>
|
|
</td>
|
|
<td valign="top" align="right"></td>
|
|
</tr></table></div>
|
|
<div class="refsynopsisdiv">
|
|
<h2>Synopsis</h2>
|
|
<pre class="synopsis">
|
|
|
|
|
|
|
|
gchar* <a href="libgimp-gimpbrush.html#gimp-brush-new">gimp_brush_new</a> (const gchar *name);
|
|
gchar* <a href="libgimp-gimpbrush.html#gimp-brush-duplicate">gimp_brush_duplicate</a> (const gchar *name);
|
|
gchar* <a href="libgimp-gimpbrush.html#gimp-brush-rename">gimp_brush_rename</a> (const gchar *name,
|
|
const gchar *new_name);
|
|
gboolean <a href="libgimp-gimpbrush.html#gimp-brush-delete">gimp_brush_delete</a> (const gchar *name);
|
|
gboolean <a href="libgimp-gimpbrush.html#gimp-brush-get-info">gimp_brush_get_info</a> (const gchar *name,
|
|
gint *width,
|
|
gint *height,
|
|
gint *mask_bpp,
|
|
gint *color_bpp);
|
|
gboolean <a href="libgimp-gimpbrush.html#gimp-brush-get-pixels">gimp_brush_get_pixels</a> (const gchar *name,
|
|
gint *width,
|
|
gint *height,
|
|
gint *mask_bpp,
|
|
gint *num_mask_bytes,
|
|
guint8 **mask_bytes,
|
|
gint *color_bpp,
|
|
gint *num_color_bytes,
|
|
guint8 **color_bytes);
|
|
gboolean <a href="libgimp-gimpbrush.html#gimp-brush-get-spacing">gimp_brush_get_spacing</a> (const gchar *name,
|
|
gint *spacing);
|
|
gboolean <a href="libgimp-gimpbrush.html#gimp-brush-set-spacing">gimp_brush_set_spacing</a> (const gchar *name,
|
|
gint spacing);
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2656357"></a><h2>Description</h2>
|
|
<p>
|
|
Functions operating on a single brush.
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2656372"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2656383"></a><h3>
|
|
<a name="gimp-brush-new"></a>gimp_brush_new ()</h3>
|
|
<a class="indexterm" name="id2656398"></a><pre class="programlisting">gchar* gimp_brush_new (const gchar *name);</pre>
|
|
<p>
|
|
Creates a new brush
|
|
</p>
|
|
<p>
|
|
This procedure creates a new, uninitialized brush</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
|
|
<td> The requested name of the new brush.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The actual new brush name.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2659999"></a><h3>
|
|
<a name="gimp-brush-duplicate"></a>gimp_brush_duplicate ()</h3>
|
|
<a class="indexterm" name="id2660013"></a><pre class="programlisting">gchar* gimp_brush_duplicate (const gchar *name);</pre>
|
|
<p>
|
|
Duplicates a brush
|
|
</p>
|
|
<p>
|
|
This procedure creates an identical brush by a different name</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
|
|
<td> The brush name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The name of the brush's copy.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2660082"></a><h3>
|
|
<a name="gimp-brush-rename"></a>gimp_brush_rename ()</h3>
|
|
<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
|
|
</p>
|
|
<p>
|
|
This procedure renames a brush</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
|
|
<td> The brush name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>new_name</code></em> :</span></td>
|
|
<td> The new name of the brush.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> The actual new name of the brush.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2660186"></a><h3>
|
|
<a name="gimp-brush-delete"></a>gimp_brush_delete ()</h3>
|
|
<a class="indexterm" name="id2660200"></a><pre class="programlisting">gboolean gimp_brush_delete (const gchar *name);</pre>
|
|
<p>
|
|
Deletes a brush
|
|
</p>
|
|
<p>
|
|
This procedure deletes a brush</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
|
|
<td> The brush name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> TRUE on success.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2660878"></a><h3>
|
|
<a name="gimp-brush-get-info"></a>gimp_brush_get_info ()</h3>
|
|
<a class="indexterm" name="id2660892"></a><pre class="programlisting">gboolean gimp_brush_get_info (const gchar *name,
|
|
gint *width,
|
|
gint *height,
|
|
gint *mask_bpp,
|
|
gint *color_bpp);</pre>
|
|
<p>
|
|
Retrieve information about the specified brush.
|
|
</p>
|
|
<p>
|
|
This procedure retrieves information about the specified brush. This
|
|
includes the brush name, and the brush extents (width and height).</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
|
|
<td> The brush name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>width</code></em> :</span></td>
|
|
<td> The brush width.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>height</code></em> :</span></td>
|
|
<td> The brush height.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>mask_bpp</code></em> :</span></td>
|
|
<td> The brush mask bpp.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>color_bpp</code></em> :</span></td>
|
|
<td> The brush color bpp.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> TRUE on success.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2661047"></a><h3>
|
|
<a name="gimp-brush-get-pixels"></a>gimp_brush_get_pixels ()</h3>
|
|
<a class="indexterm" name="id2661061"></a><pre class="programlisting">gboolean gimp_brush_get_pixels (const gchar *name,
|
|
gint *width,
|
|
gint *height,
|
|
gint *mask_bpp,
|
|
gint *num_mask_bytes,
|
|
guint8 **mask_bytes,
|
|
gint *color_bpp,
|
|
gint *num_color_bytes,
|
|
guint8 **color_bytes);</pre>
|
|
<p>
|
|
Retrieve information about the specified brush.
|
|
</p>
|
|
<p>
|
|
This procedure retrieves information about the specified brush. This
|
|
includes the brush extents (width and height) and its pixels data.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
|
|
<td> The brush name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>width</code></em> :</span></td>
|
|
<td> The brush width.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>height</code></em> :</span></td>
|
|
<td> The brush height.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>mask_bpp</code></em> :</span></td>
|
|
<td> The brush mask bpp.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>num_mask_bytes</code></em> :</span></td>
|
|
<td> Length of brush mask data.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>mask_bytes</code></em> :</span></td>
|
|
<td> The brush mask data.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>color_bpp</code></em> :</span></td>
|
|
<td> The brush color bpp.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>num_color_bytes</code></em> :</span></td>
|
|
<td> Length of brush color data.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>color_bytes</code></em> :</span></td>
|
|
<td> The brush color data.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> TRUE on success.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2661300"></a><h3>
|
|
<a name="gimp-brush-get-spacing"></a>gimp_brush_get_spacing ()</h3>
|
|
<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.
|
|
</p>
|
|
<p>
|
|
This procedure returns the spacing setting for the specified brush.
|
|
The return value is an integer between 0 and 1000 which represents
|
|
percentage of the maximum of the width and height of the mask.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
|
|
<td> The brush name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
|
|
<td> The brush spacing.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> TRUE on success.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2661406"></a><h3>
|
|
<a name="gimp-brush-set-spacing"></a>gimp_brush_set_spacing ()</h3>
|
|
<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.
|
|
</p>
|
|
<p>
|
|
This procedure modifies the spacing setting for the specified brush.
|
|
The value should be a integer between 0 and 1000.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
|
|
<td> The brush name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
|
|
<td> The brush spacing.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
|
|
<td> TRUE on success.
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p>Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|