479 lines
18 KiB
HTML
479 lines
18 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>gimpbrushes</title>
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.68.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.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-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>
|
|
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2476426" class="shortcut">Top</a>
|
|
 | 
|
|
<a href="#id2630883" class="shortcut">Description</a></nobr></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>
|
|
<a name="id2476426"></a><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="id2630883"></a><h2>Description</h2>
|
|
<p>
|
|
Functions related to getting and setting brushes.
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2630900"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2630910"></a><h3>
|
|
<a name="gimp-brushes-refresh"></a>gimp_brushes_refresh ()</h3>
|
|
<a class="indexterm" name="id2630922"></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="id2630967"></a><h3>
|
|
<a name="gimp-brushes-get-list"></a>gimp_brushes_get_list ()</h3>
|
|
<a class="indexterm" name="id2630978"></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"><em class="parameter"><code>filter</code></em> :</span></td>
|
|
<td> An optional regular expression used to filter the list.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>num_brushes</code></em> :</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="id2631066"></a><h3>
|
|
<a name="gimp-brushes-get-brush"></a>gimp_brushes_get_brush ()</h3>
|
|
<a class="indexterm" name="id2631080"></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><code class="literal">gimp_brushes_get_brush</code> 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"><code class="function">gimp_context_get_brush()</code></a> instead.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<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>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> The brush name.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2628568"></a><h3>
|
|
<a name="gimp-brushes-set-brush"></a>gimp_brushes_set_brush ()</h3>
|
|
<a class="indexterm" name="id2628582"></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><code class="literal">gimp_brushes_set_brush</code> 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"><code class="function">gimp_context_set_brush()</code></a> instead.</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>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2628662"></a><h3>
|
|
<a name="gimp-brushes-get-opacity"></a>gimp_brushes_get_opacity ()</h3>
|
|
<a class="indexterm" name="id2628675"></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><code class="literal">gimp_brushes_get_opacity</code> 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"><code class="function">gimp_context_get_opacity()</code></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="id2628736"></a><h3>
|
|
<a name="gimp-brushes-set-opacity"></a>gimp_brushes_set_opacity ()</h3>
|
|
<a class="indexterm" name="id2628749"></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><code class="literal">gimp_brushes_set_opacity</code> 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"><code class="function">gimp_context_set_opacity()</code></a> instead.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>opacity</code></em> :</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="id2627331"></a><h3>
|
|
<a name="gimp-brushes-get-paint-mode"></a>gimp_brushes_get_paint_mode ()</h3>
|
|
<a class="indexterm" name="id2627345"></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><code class="literal">gimp_brushes_get_paint_mode</code> 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"><code class="function">gimp_context_get_paint_mode()</code></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="id2627405"></a><h3>
|
|
<a name="gimp-brushes-set-paint-mode"></a>gimp_brushes_set_paint_mode ()</h3>
|
|
<a class="indexterm" name="id2627419"></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><code class="literal">gimp_brushes_set_paint_mode</code> 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"><code class="function">gimp_context_set_paint_mode()</code></a> instead.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>paint_mode</code></em> :</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="id2627499"></a><h3>
|
|
<a name="gimp-brushes-get-spacing"></a>gimp_brushes_get_spacing ()</h3>
|
|
<a class="indexterm" name="id2627512"></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><code class="literal">gimp_brushes_get_spacing</code> 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"><code class="function">gimp_brush_get_spacing()</code></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="id2629081"></a><h3>
|
|
<a name="gimp-brushes-set-spacing"></a>gimp_brushes_set_spacing ()</h3>
|
|
<a class="indexterm" name="id2629095"></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><code class="literal">gimp_brushes_set_spacing</code> 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"><code class="function">gimp_brush_set_spacing()</code></a> instead.</p>
|
|
<p>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<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>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2629175"></a><h3>
|
|
<a name="gimp-brushes-get-brush-data"></a>gimp_brushes_get_brush_data ()</h3>
|
|
<a class="indexterm" name="id2629188"></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><code class="literal">gimp_brushes_get_brush_data</code> 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"><code class="function">gimp_brush_get_pixels()</code></a> instead.</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 (\"\" means current active brush).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
|
|
<td> The brush opacity.
|
|
</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"><em class="parameter"><code>paint_mode</code></em> :</span></td>
|
|
<td> The paint mode.
|
|
</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>length</code></em> :</span></td>
|
|
<td> Length of brush mask data.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<span class="term"><em class="parameter"><code>mask_data</code></em> :</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>
|
|
</body>
|
|
</html>
|