138 lines
14 KiB
HTML
138 lines
14 KiB
HTML
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpbrush</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><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.3 (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" 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></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><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="id2645014"></a><h2>Description</h2><p>
|
||
Functions operating on a single brush.
|
||
</p></div><div class="refsect1" lang="en"><a name="id2645024"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2645029"></a><h3><a name="gimp-brush-new"></a>gimp_brush_new ()</h3><a class="indexterm" name="id2645037"></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"><i class="parameter"><tt>name</tt></i> :</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="id2644694"></a><h3><a name="gimp-brush-duplicate"></a>gimp_brush_duplicate ()</h3><a class="indexterm" name="id2644702"></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"><i class="parameter"><tt>name</tt></i> :</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="id2644758"></a><h3><a name="gimp-brush-rename"></a>gimp_brush_rename ()</h3><a class="indexterm" name="id2644767"></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"><i class="parameter"><tt>name</tt></i> :</span></td><td> The brush name.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>new_name</tt></i> :</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="id2644838"></a><h3><a name="gimp-brush-delete"></a>gimp_brush_delete ()</h3><a class="indexterm" name="id2644847"></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"><i class="parameter"><tt>name</tt></i> :</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="id2644901"></a><h3><a name="gimp-brush-get-info"></a>gimp_brush_get_info ()</h3><a class="indexterm" name="id2644909"></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"><i class="parameter"><tt>name</tt></i> :</span></td><td> The brush name.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>width</tt></i> :</span></td><td> The brush width.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>height</tt></i> :</span></td><td> The brush height.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>mask_bpp</tt></i> :</span></td><td> The brush mask bpp.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>color_bpp</tt></i> :</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="id2634293"></a><h3><a name="gimp-brush-get-pixels"></a>gimp_brush_get_pixels ()</h3><a class="indexterm" name="id2634301"></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"><i class="parameter"><tt>name</tt></i> :</span></td><td> The brush name.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>width</tt></i> :</span></td><td> The brush width.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>height</tt></i> :</span></td><td> The brush height.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>mask_bpp</tt></i> :</span></td><td> The brush mask bpp.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>num_mask_bytes</tt></i> :</span></td><td> Length of brush mask data.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>mask_bytes</tt></i> :</span></td><td> The brush mask data.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>color_bpp</tt></i> :</span></td><td> The brush color bpp.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>num_color_bytes</tt></i> :</span></td><td> Length of brush color data.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>color_bytes</tt></i> :</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="id2646760"></a><h3><a name="gimp-brush-get-spacing"></a>gimp_brush_get_spacing ()</h3><a class="indexterm" name="id2646768"></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"><i class="parameter"><tt>name</tt></i> :</span></td><td> The brush name.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>spacing</tt></i> :</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="id2646843"></a><h3><a name="gimp-brush-set-spacing"></a>gimp_brush_set_spacing ()</h3><a class="indexterm" name="id2646852"></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"><i class="parameter"><tt>name</tt></i> :</span></td><td> The brush name.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>spacing</tt></i> :</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><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libgimp-data.html"><b><< Data Objects</b></a></td><td align="right"><a accesskey="n" href="libgimp-gimpbrushes.html"><b>gimpbrushes >></b></a></td></tr></table></body></html>
|