callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Imported Upstream version 2.2.14

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:17:12 -04:00
parent 70ad8213cf
commit a2f097051e
490 changed files with 35329 additions and 58398 deletions
Download Patch File Download Diff File Expand all files Collapse all files

140
devel-docs/libgimp/html/libgimp-gimpbrushes.html
View File

@ -3,7 +3,7 @@
<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">
<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-gimpbrush.html" title="gimpbrush">
@ -28,16 +28,16 @@
<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>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2559208" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2630883" class="shortcut">Description</a></nobr></td></tr>
<a href="#id2662827" 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>
<a name="id2559208"></a><span class="refentrytitle">gimpbrushes</span>
</h2>
<p>gimpbrushes &#8212; Functions for manipulating brushes.</p>
</td>
@ -74,17 +74,17 @@ gchar* <a href="libgimp-gimpbrushes.html#gimp-brushes-get-brush-data">gimp_
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2630883"></a><h2>Description</h2>
<a name="id2662827"></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>
<a name="id2662844"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2630910"></a><h3>
<a name="id2662854"></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>
<a class="indexterm" name="id2662866"></a><pre class="programlisting">gboolean gimp_brushes_refresh (void);</pre>
<p>
Refresh current brushes. This function always succeeds.
</p>
@ -97,8 +97,7 @@ path and updates the brush dialogs accordingly.</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>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr></tbody>
@ -106,9 +105,9 @@ path and updates the brush dialogs accordingly.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630967"></a><h3>
<a name="id2662911"></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,
<a class="indexterm" name="id2662922"></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.
@ -124,20 +123,17 @@ Each name returned can be used as input to the
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>filter</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>filter</code></em>&#160;:</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>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>num_brushes</code></em>&#160;:</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>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The list of brush names.
</td>
</tr>
@ -146,9 +142,9 @@ Each name returned can be used as input to the
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2631066"></a><h3>
<a name="id2663830"></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,
<a class="indexterm" name="id2663843"></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;">
@ -164,26 +160,22 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td> The brush width.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> The brush height.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></td>
<td> The brush spacing.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The brush name.
</td>
</tr>
@ -192,9 +184,9 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2628568"></a><h3>
<a name="id2663965"></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>
<a class="indexterm" name="id2663979"></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>
@ -208,14 +200,12 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The brush name.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
@ -224,9 +214,9 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2628662"></a><h3>
<a name="id2660247"></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>
<a class="indexterm" name="id2660260"></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>
@ -239,8 +229,7 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The brush opacity.
</td>
</tr></tbody>
@ -248,9 +237,9 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2628736"></a><h3>
<a name="id2660321"></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>
<a class="indexterm" name="id2660334"></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>
@ -264,14 +253,12 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></td>
<td> The brush opacity.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
@ -280,9 +267,9 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627331"></a><h3>
<a name="id2660414"></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
<a class="indexterm" name="id2660427"></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>
@ -296,8 +283,7 @@ This procedure isdeprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The paint mode.
</td>
</tr></tbody>
@ -305,9 +291,9 @@ This procedure isdeprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627405"></a><h3>
<a name="id2660488"></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>
<a class="indexterm" name="id2660502"></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>
@ -321,14 +307,12 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>paint_mode</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>paint_mode</code></em>&#160;:</span></td>
<td> The paint mode.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
@ -337,9 +321,9 @@ This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627499"></a><h3>
<a name="id2660582"></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>
<a class="indexterm" name="id2660595"></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>
@ -352,8 +336,7 @@ This procedure is deprecated! Use <a href="libgimp-gimpbrush.html#gimp-brush-get
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The brush spacing.
</td>
</tr></tbody>
@ -361,9 +344,9 @@ This procedure is deprecated! Use <a href="libgimp-gimpbrush.html#gimp-brush-get
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2629081"></a><h3>
<a name="id2664879"></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>
<a class="indexterm" name="id2664892"></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>
@ -377,14 +360,12 @@ This procedure is deprecated! Use <a href="libgimp-gimpbrush.html#gimp-brush-set
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></td>
<td> The brush spacing.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.
</td>
</tr>
@ -393,9 +374,9 @@ This procedure is deprecated! Use <a href="libgimp-gimpbrush.html#gimp-brush-set
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2629175"></a><h3>
<a name="id2664972"></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,
<a class="indexterm" name="id2664986"></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,
@ -416,56 +397,47 @@ This procedure is deprecated! Use <a href="libgimp-gimpbrush.html#gimp-brush-get
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
<td> The brush name (\"\" means current active brush).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></td>
<td> The brush opacity.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></td>
<td> The brush spacing.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>paint_mode</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>paint_mode</code></em>&#160;:</span></td>
<td> The paint mode.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td> The brush width.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> The brush height.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>length</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>length</code></em>&#160;:</span></td>
<td> Length of brush mask data.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>mask_data</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>mask_data</code></em>&#160;:</span></td>
<td> The brush mask data.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The brush name.
</td>
</tr>