Files
gimp/devel-docs/libgimp/html/libgimp-gimpbrush.html
2010-08-11 01:23:08 -04:00

1215 lines
39 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.73.2">
<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.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimp.html" title="Part&#160;I.&#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 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;II.&#160;GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="libgimp-index.html" title="Index">
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
</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="#id2616886" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2702091" 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="id2616886"></a><span class="refentrytitle">gimpbrush</span>
</h2>
<p>gimpbrush &#8212; 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">
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a class="link" href="libgimp-gimpbrush.html#gimp-brush-new">gimp_brush_new</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a class="link" href="libgimp-gimpbrush.html#gimp-brush-duplicate">gimp_brush_duplicate</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a class="link" href="libgimp-gimpbrush.html#gimp-brush-rename">gimp_brush_rename</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *new_name);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-delete">gimp_brush_delete</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-get-info">gimp_brush_get_info</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *height,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *mask_bpp,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *color_bpp);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-get-pixels">gimp_brush_get_pixels</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *height,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *mask_bpp,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *num_mask_bytes,
<a
href="../glib/glib-Basic-Types.html#guint8"
>guint8</a> **mask_bytes,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *color_bpp,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *num_color_bytes,
<a
href="../glib/glib-Basic-Types.html#guint8"
>guint8</a> **color_bytes);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-get-spacing">gimp_brush_get_spacing</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *spacing);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-set-spacing">gimp_brush_set_spacing</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> spacing);
<a class="link" href="libgimp-gimpenums.html#GimpBrushGeneratedShape">GimpBrushGeneratedShape</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-get-shape">gimp_brush_get_shape</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a class="link" href="libgimp-gimpenums.html#GimpBrushGeneratedShape">GimpBrushGeneratedShape</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-set-shape">gimp_brush_set_shape</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a class="link" href="libgimp-gimpenums.html#GimpBrushGeneratedShape">GimpBrushGeneratedShape</a> shape_in);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-get-spikes">gimp_brush_get_spikes</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-set-spikes">gimp_brush_set_spikes</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> spikes_in);
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-get-angle">gimp_brush_get_angle</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-set-angle">gimp_brush_set_angle</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> angle_in);
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-get-radius">gimp_brush_get_radius</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-set-radius">gimp_brush_set_radius</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> radius_in);
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-get-aspect-ratio">gimp_brush_get_aspect_ratio</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-set-aspect-ratio">gimp_brush_set_aspect_ratio</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> aspect_ratio_in);
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-get-hardness">gimp_brush_get_hardness</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-set-hardness">gimp_brush_set_hardness</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> hardness_in);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-is-generated">gimp_brush_is_generated</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpbrush.html#gimp-brush-is-editable">gimp_brush_is_editable</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2702091"></a><h2>Description</h2>
<p>
Functions operating on a single brush.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2702106"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2702117"></a><h3>
<a name="gimp-brush-new"></a>gimp_brush_new ()</h3>
<a class="indexterm" name="id2702132"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_brush_new (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *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><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The requested name of the new brush.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The actual new brush name.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2702203"></a><h3>
<a name="gimp-brush-duplicate"></a>gimp_brush_duplicate ()</h3>
<a class="indexterm" name="id2702216"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_brush_duplicate (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *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><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The name of the brush's copy.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2702288"></a><h3>
<a name="gimp-brush-rename"></a>gimp_brush_rename ()</h3>
<a class="indexterm" name="id2702302"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_brush_rename (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *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><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_name</code></em>&#160;:</span></p></td>
<td> The new name of the brush.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The actual new name of the brush.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2702395"></a><h3>
<a name="gimp-brush-delete"></a>gimp_brush_delete ()</h3>
<a class="indexterm" name="id2702409"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_brush_delete (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *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><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2689827"></a><h3>
<a name="gimp-brush-get-info"></a>gimp_brush_get_info ()</h3>
<a class="indexterm" name="id2689841"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_brush_get_info (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *height,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *mask_bpp,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *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><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></p></td>
<td> The brush width.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></p></td>
<td> The brush height.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mask_bpp</code></em>&#160;:</span></p></td>
<td> The brush mask bpp.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>color_bpp</code></em>&#160;:</span></p></td>
<td> The brush color bpp.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2690001"></a><h3>
<a name="gimp-brush-get-pixels"></a>gimp_brush_get_pixels ()</h3>
<a class="indexterm" name="id2690014"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_brush_get_pixels (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *height,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *mask_bpp,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *num_mask_bytes,
<a
href="../glib/glib-Basic-Types.html#guint8"
>guint8</a> **mask_bytes,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *color_bpp,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *num_color_bytes,
<a
href="../glib/glib-Basic-Types.html#guint8"
>guint8</a> **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><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></p></td>
<td> The brush width.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></p></td>
<td> The brush height.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mask_bpp</code></em>&#160;:</span></p></td>
<td> The brush mask bpp.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num_mask_bytes</code></em>&#160;:</span></p></td>
<td> Length of brush mask data.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mask_bytes</code></em>&#160;:</span></p></td>
<td> The brush mask data.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>color_bpp</code></em>&#160;:</span></p></td>
<td> The brush color bpp.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num_color_bytes</code></em>&#160;:</span></p></td>
<td> Length of brush color data.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>color_bytes</code></em>&#160;:</span></p></td>
<td> The brush color data.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2690258"></a><h3>
<a name="gimp-brush-get-spacing"></a>gimp_brush_get_spacing ()</h3>
<a class="indexterm" name="id2690271"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_brush_get_spacing (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *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><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></p></td>
<td> The brush spacing.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2690366"></a><h3>
<a name="gimp-brush-set-spacing"></a>gimp_brush_set_spacing ()</h3>
<a class="indexterm" name="id2690380"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_brush_set_spacing (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> 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><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></p></td>
<td> The brush spacing.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2690474"></a><h3>
<a name="gimp-brush-get-shape"></a>gimp_brush_get_shape ()</h3>
<a class="indexterm" name="id2690487"></a><pre class="programlisting"><a class="link" href="libgimp-gimpenums.html#GimpBrushGeneratedShape">GimpBrushGeneratedShape</a> gimp_brush_get_shape (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
Get the shape of a generated brush.
</p>
<p>
This procedure gets the shape value for a generated brush. If called
for any other type of brush, it does not succeed. The current
possibilities are Circle (GIMP_BRUSH_GENERATED_CIRCLE), Square
(GIMP_BRUSH_GENERATED_SQUARE), and Diamond
(GIMP_BRUSH_GENERATED_DIAMOND). Other shapes are likely to be added
in the future.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The brush shape.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2690562"></a><h3>
<a name="gimp-brush-set-shape"></a>gimp_brush_set_shape ()</h3>
<a class="indexterm" name="id2690575"></a><pre class="programlisting"><a class="link" href="libgimp-gimpenums.html#GimpBrushGeneratedShape">GimpBrushGeneratedShape</a> gimp_brush_set_shape (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a class="link" href="libgimp-gimpenums.html#GimpBrushGeneratedShape">GimpBrushGeneratedShape</a> shape_in);</pre>
<p>
Set the shape of a generated brush.
</p>
<p>
This procedure sets the shape value for a generated brush. If called
for any other type of brush, it does not succeed. The current
possibilities are Circle (GIMP_BRUSH_GENERATED_CIRCLE), Square
(GIMP_BRUSH_GENERATED_SQUARE), and Diamond
(GIMP_BRUSH_GENERATED_DIAMOND). Other shapes are likely to be added
in the future.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>shape_in</code></em>&#160;:</span></p></td>
<td> The brush shape.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The brush shape actually assigned.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2690670"></a><h3>
<a name="gimp-brush-get-spikes"></a>gimp_brush_get_spikes ()</h3>
<a class="indexterm" name="id2690684"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gimp_brush_get_spikes (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
Get the number of spikes for a generated brush.
</p>
<p>
This procedure gets the number of spikes for a generated brush. If
called for any other type of brush, it does not succeed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The number of spikes on the brush.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2690757"></a><h3>
<a name="gimp-brush-set-spikes"></a>gimp_brush_set_spikes ()</h3>
<a class="indexterm" name="id2690771"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gimp_brush_set_spikes (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> spikes_in);</pre>
<p>
Set the number of spikes for a generated brush.
</p>
<p>
This procedure sets the number of spikes for a generated brush. If
called for any other type of brush, it does not succeed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>spikes_in</code></em>&#160;:</span></p></td>
<td> The desired number of spikes.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The number of spikes actually assigned.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2690866"></a><h3>
<a name="gimp-brush-get-angle"></a>gimp_brush_get_angle ()</h3>
<a class="indexterm" name="id2690879"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> gimp_brush_get_angle (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
Get the rotation angle of a generated brush.
</p>
<p>
This procedure gets the angle of rotation for a generated brush. If
called for any other type of brush, it does not succeed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The rotation angle of the brush.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2690953"></a><h3>
<a name="gimp-brush-set-angle"></a>gimp_brush_set_angle ()</h3>
<a class="indexterm" name="id2690966"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> gimp_brush_set_angle (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> angle_in);</pre>
<p>
Set the rotation angle of a generated brush.
</p>
<p>
This procedure sets the rotation angle for a generated brush. If
called for any other type of brush, it does not succeed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>angle_in</code></em>&#160;:</span></p></td>
<td> The desired brush rotation angle.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The brush rotation angle actually assigned.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2691061"></a><h3>
<a name="gimp-brush-get-radius"></a>gimp_brush_get_radius ()</h3>
<a class="indexterm" name="id2691075"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> gimp_brush_get_radius (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
Get the radius of a generated brush.
</p>
<p>
This procedure gets the radius value for a generated brush. If
called for any other type of brush, it does not succeed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The radius of the brush in pixels.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2691147"></a><h3>
<a name="gimp-brush-set-radius"></a>gimp_brush_set_radius ()</h3>
<a class="indexterm" name="id2691161"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> gimp_brush_set_radius (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> radius_in);</pre>
<p>
Set the radius of a generated brush.
</p>
<p>
This procedure sets the radius for a generated brush. If called for
any other type of brush, it does not succeed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>radius_in</code></em>&#160;:</span></p></td>
<td> The desired brush radius.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The brush radius actually assigned.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2691254"></a><h3>
<a name="gimp-brush-get-aspect-ratio"></a>gimp_brush_get_aspect_ratio ()</h3>
<a class="indexterm" name="id2691268"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> gimp_brush_get_aspect_ratio (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
Get the aspect ratio of a generated brush.
</p>
<p>
This procedure gets the aspect ratio of a generated brush. If called
for any other type of brush, it does not succeed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The aspect ratio of the brush.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2691341"></a><h3>
<a name="gimp-brush-set-aspect-ratio"></a>gimp_brush_set_aspect_ratio ()</h3>
<a class="indexterm" name="id2691355"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> gimp_brush_set_aspect_ratio (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> aspect_ratio_in);</pre>
<p>
Set the aspect ratio of a generated brush.
</p>
<p>
This procedure sets the aspect ratio for a generated brush. If
called for any other type of brush, it does not succeed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>aspect_ratio_in</code></em>&#160;:</span></p></td>
<td> The desired brush aspect ratio.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The brush aspect ratio actually assigned.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2691450"></a><h3>
<a name="gimp-brush-get-hardness"></a>gimp_brush_get_hardness ()</h3>
<a class="indexterm" name="id2691464"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> gimp_brush_get_hardness (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
Get the hardness of a generated brush.
</p>
<p>
This procedure gets the hardness of a generated brush. The hardness
of a brush is the amount its intensity fades at the outside edge. If
called for any other type of brush, the function does not succeed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The hardness of the brush.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2691539"></a><h3>
<a name="gimp-brush-set-hardness"></a>gimp_brush_set_hardness ()</h3>
<a class="indexterm" name="id2691552"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> gimp_brush_set_hardness (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> hardness_in);</pre>
<p>
Set the hardness of a generated brush.
</p>
<p>
This procedure sets the hardness for a generated brush. If called
for any other type of brush, it does not succeed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>hardness_in</code></em>&#160;:</span></p></td>
<td> The desired brush hardness.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The brush hardness actually assigned.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2691647"></a><h3>
<a name="gimp-brush-is-generated"></a>gimp_brush_is_generated ()</h3>
<a class="indexterm" name="id2691661"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_brush_is_generated (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
Tests if brush is generated
</p>
<p>
Returns TRUE if this brush is parametric, FALSE for other types</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE if the brush is generated.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2691732"></a><h3>
<a name="gimp-brush-is-editable"></a>gimp_brush_is_editable ()</h3>
<a class="indexterm" name="id2691746"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_brush_is_editable (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
Tests if brush can be edited
</p>
<p>
Returns TRUE if you have permission to change the brush</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The brush name.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE if the brush can be edited.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
</div>
</div>
</body>
</html>