109 lines
17 KiB
HTML
109 lines
17 KiB
HTML
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpbrushes</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-gimpbrush.html" title="gimpbrush"><link rel="next" href="libgimp-gimpfonts.html" title="gimpfonts"><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-gimpbrush.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-gimpfonts.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-gimpbrushes"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">gimpbrushes</span></h2><p>gimpbrushes — Functions for manipulating brushes.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
|
||
|
||
|
||
|
||
gboolean <a href="libgimp-gimpbrushes.html#gimp-brushes-refresh">gimp_brushes_refresh</a> (void);
|
||
gchar** <a href="libgimp-gimpbrushes.html#gimp-brushes-get-list">gimp_brushes_get_list</a> (const gchar *filter,
|
||
gint *num_brushes);
|
||
gchar* <a href="libgimp-gimpbrushes.html#gimp-brushes-get-brush">gimp_brushes_get_brush</a> (gint *width,
|
||
gint *height,
|
||
gint *spacing);
|
||
gboolean <a href="libgimp-gimpbrushes.html#gimp-brushes-set-brush">gimp_brushes_set_brush</a> (const gchar *name);
|
||
gdouble <a href="libgimp-gimpbrushes.html#gimp-brushes-get-opacity">gimp_brushes_get_opacity</a> (void);
|
||
gboolean <a href="libgimp-gimpbrushes.html#gimp-brushes-set-opacity">gimp_brushes_set_opacity</a> (gdouble opacity);
|
||
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> <a href="libgimp-gimpbrushes.html#gimp-brushes-get-paint-mode">gimp_brushes_get_paint_mode</a>
|
||
(void);
|
||
gboolean <a href="libgimp-gimpbrushes.html#gimp-brushes-set-paint-mode">gimp_brushes_set_paint_mode</a> (<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);
|
||
gint <a href="libgimp-gimpbrushes.html#gimp-brushes-get-spacing">gimp_brushes_get_spacing</a> (void);
|
||
gboolean <a href="libgimp-gimpbrushes.html#gimp-brushes-set-spacing">gimp_brushes_set_spacing</a> (gint spacing);
|
||
gchar* <a href="libgimp-gimpbrushes.html#gimp-brushes-get-brush-data">gimp_brushes_get_brush_data</a> (const gchar *name,
|
||
gdouble *opacity,
|
||
gint *spacing,
|
||
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> *paint_mode,
|
||
gint *width,
|
||
gint *height,
|
||
gint *length,
|
||
guint8 **mask_data);
|
||
</pre></div><div class="refsect1" lang="en"><a name="id2644525"></a><h2>Description</h2><p>
|
||
Functions related to getting and setting brushes.
|
||
</p></div><div class="refsect1" lang="en"><a name="id2644536"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2644541"></a><h3><a name="gimp-brushes-refresh"></a>gimp_brushes_refresh ()</h3><a class="indexterm" name="id2644549"></a><pre class="programlisting">gboolean gimp_brushes_refresh (void);</pre><p>
|
||
Refresh current brushes. This function always succeeds.
|
||
</p><p>
|
||
This procedure retrieves all brushes currently in the user's brush
|
||
path and updates the brush dialogs accordingly.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2645385"></a><h3><a name="gimp-brushes-get-list"></a>gimp_brushes_get_list ()</h3><a class="indexterm" name="id2645394"></a><pre class="programlisting">gchar** gimp_brushes_get_list (const gchar *filter,
|
||
gint *num_brushes);</pre><p>
|
||
Retrieve a complete listing of the available brushes.
|
||
</p><p>
|
||
This procedure returns a complete listing of available GIMP brushes.
|
||
Each name returned can be used as input to the
|
||
'gimp_context_set_brush' procedure.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>filter</tt></i> :</span></td><td> An optional regular expression used to filter the list.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>num_brushes</tt></i> :</span></td><td> The number of brushes in the brush list.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The list of brush names.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2645466"></a><h3><a name="gimp-brushes-get-brush"></a>gimp_brushes_get_brush ()</h3><a class="indexterm" name="id2645474"></a><pre class="programlisting">gchar* gimp_brushes_get_brush (gint *width,
|
||
gint *height,
|
||
gint *spacing);</pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><tt class="literal">gimp_brushes_get_brush</tt> is deprecated and should not be used in newly-written code.</p></div><p>
|
||
This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-get-brush"><tt class="function">gimp_context_get_brush()</tt></a> instead.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><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>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> The brush name.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2646372"></a><h3><a name="gimp-brushes-set-brush"></a>gimp_brushes_set_brush ()</h3><a class="indexterm" name="id2646381"></a><pre class="programlisting">gboolean gimp_brushes_set_brush (const gchar *name);</pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><tt class="literal">gimp_brushes_set_brush</tt> is deprecated and should not be used in newly-written code.</p></div><p>
|
||
This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-set-brush"><tt class="function">gimp_context_set_brush()</tt></a> instead.</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></div><hr><div class="refsect2" lang="en"><a name="id2646443"></a><h3><a name="gimp-brushes-get-opacity"></a>gimp_brushes_get_opacity ()</h3><a class="indexterm" name="id2646452"></a><pre class="programlisting">gdouble gimp_brushes_get_opacity (void);</pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><tt class="literal">gimp_brushes_get_opacity</tt> is deprecated and should not be used in newly-written code.</p></div><p>
|
||
This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-get-opacity"><tt class="function">gimp_context_get_opacity()</tt></a> instead.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The brush opacity.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2646499"></a><h3><a name="gimp-brushes-set-opacity"></a>gimp_brushes_set_opacity ()</h3><a class="indexterm" name="id2646508"></a><pre class="programlisting">gboolean gimp_brushes_set_opacity (gdouble opacity);</pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><tt class="literal">gimp_brushes_set_opacity</tt> is deprecated and should not be used in newly-written code.</p></div><p>
|
||
This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-set-opacity"><tt class="function">gimp_context_set_opacity()</tt></a> instead.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>opacity</tt></i> :</span></td><td> The brush opacity.
|
||
</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></div><hr><div class="refsect2" lang="en"><a name="id2645661"></a><h3><a name="gimp-brushes-get-paint-mode"></a>gimp_brushes_get_paint_mode ()</h3><a class="indexterm" name="id2645670"></a><pre class="programlisting"><a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> gimp_brushes_get_paint_mode
|
||
(void);</pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><tt class="literal">gimp_brushes_get_paint_mode</tt> is deprecated and should not be used in newly-written code.</p></div><p>
|
||
This procedure isdeprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-get-paint-mode"><tt class="function">gimp_context_get_paint_mode()</tt></a> instead.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The paint mode.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2645718"></a><h3><a name="gimp-brushes-set-paint-mode"></a>gimp_brushes_set_paint_mode ()</h3><a class="indexterm" name="id2645726"></a><pre class="programlisting">gboolean gimp_brushes_set_paint_mode (<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);</pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><tt class="literal">gimp_brushes_set_paint_mode</tt> is deprecated and should not be used in newly-written code.</p></div><p>
|
||
This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-set-paint-mode"><tt class="function">gimp_context_set_paint_mode()</tt></a> instead.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>paint_mode</tt></i> :</span></td><td> The paint mode.
|
||
</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></div><hr><div class="refsect2" lang="en"><a name="id2645789"></a><h3><a name="gimp-brushes-get-spacing"></a>gimp_brushes_get_spacing ()</h3><a class="indexterm" name="id2645798"></a><pre class="programlisting">gint gimp_brushes_get_spacing (void);</pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><tt class="literal">gimp_brushes_get_spacing</tt> is deprecated and should not be used in newly-written code.</p></div><p>
|
||
This procedure is deprecated! Use <a href="libgimp-gimpbrush.html#gimp-brush-get-spacing"><tt class="function">gimp_brush_get_spacing()</tt></a> instead.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The brush spacing.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2645845"></a><h3><a name="gimp-brushes-set-spacing"></a>gimp_brushes_set_spacing ()</h3><a class="indexterm" name="id2645854"></a><pre class="programlisting">gboolean gimp_brushes_set_spacing (gint spacing);</pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><tt class="literal">gimp_brushes_set_spacing</tt> is deprecated and should not be used in newly-written code.</p></div><p>
|
||
This procedure is deprecated! Use <a href="libgimp-gimpbrush.html#gimp-brush-set-spacing"><tt class="function">gimp_brush_set_spacing()</tt></a> instead.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><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></div><hr><div class="refsect2" lang="en"><a name="id2645917"></a><h3><a name="gimp-brushes-get-brush-data"></a>gimp_brushes_get_brush_data ()</h3><a class="indexterm" name="id2652373"></a><pre class="programlisting">gchar* gimp_brushes_get_brush_data (const gchar *name,
|
||
gdouble *opacity,
|
||
gint *spacing,
|
||
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> *paint_mode,
|
||
gint *width,
|
||
gint *height,
|
||
gint *length,
|
||
guint8 **mask_data);</pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><tt class="literal">gimp_brushes_get_brush_data</tt> is deprecated and should not be used in newly-written code.</p></div><p>
|
||
This procedure is deprecated! Use <a href="libgimp-gimpbrush.html#gimp-brush-get-pixels"><tt class="function">gimp_brush_get_pixels()</tt></a> instead.</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 (\"\" means current active brush).
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>opacity</tt></i> :</span></td><td> The brush opacity.
|
||
</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"><i class="parameter"><tt>paint_mode</tt></i> :</span></td><td> The paint mode.
|
||
</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>length</tt></i> :</span></td><td> Length of brush mask data.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>mask_data</tt></i> :</span></td><td> The brush mask data.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The brush name.
|
||
</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-gimpbrush.html"><b><< gimpbrush</b></a></td><td align="right"><a accesskey="n" href="libgimp-gimpfonts.html"><b>gimpfonts >></b></a></td></tr></table></body></html>
|