4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gimpbrushes</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
7
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
8
8
<link rel="up" href="libgimp-data.html" title="Data Objects">
9
9
<link rel="prev" href="libgimp-gimpbrush.html" title="gimpbrush">
10
10
<link rel="next" href="libgimp-gimpfonts.html" title="gimpfonts">
11
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="gimpdefinitions.html" title="Part I. GIMP Constants">
14
<link rel="part" href="libgimp.html" title="Part II. GIMP Library">
13
<link rel="part" href="libgimp.html" title="Part I. GIMP Library">
15
14
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
16
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
15
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
17
16
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
18
17
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
19
<link rel="part" href="libgimpui.html" title="Part III. GIMP User Interface Library">
18
<link rel="part" href="libgimpui.html" title="Part II. GIMP User Interface Library">
20
19
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
20
<link rel="index" href="libgimp-index.html" title="Index">
21
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
22
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
23
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
22
25
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
23
26
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
28
31
<th width="100%" align="center">GIMP Library Reference Manual</th>
29
32
<td><a accesskey="n" href="libgimp-gimpfonts.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2476426" class="shortcut">Top</a>
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2599801" class="shortcut">Top</a>
33
<a href="#id2630883" class="shortcut">Description</a></nobr></td></tr>
36
<a href="#id2674115" class="shortcut">Description</a></nobr></td></tr>
35
38
<div class="refentry" lang="en">
36
39
<a name="libgimp-gimpbrushes"></a><div class="titlepage"></div>
37
40
<div class="refnamediv"><table width="100%"><tr>
40
<a name="id2476426"></a><span class="refentrytitle">gimpbrushes</span>
43
<a name="id2599801"></a><span class="refentrytitle">gimpbrushes</span>
42
45
<p>gimpbrushes — Functions for manipulating brushes.</p>
52
gboolean <a href="libgimp-gimpbrushes.html#gimp-brushes-refresh">gimp_brushes_refresh</a> (void);
53
gchar** <a href="libgimp-gimpbrushes.html#gimp-brushes-get-list">gimp_brushes_get_list</a> (const gchar *filter,
55
gchar* <a href="libgimp-gimpbrushes.html#gimp-brushes-get-brush">gimp_brushes_get_brush</a> (gint *width,
58
gboolean <a href="libgimp-gimpbrushes.html#gimp-brushes-set-brush">gimp_brushes_set_brush</a> (const gchar *name);
59
gdouble <a href="libgimp-gimpbrushes.html#gimp-brushes-get-opacity">gimp_brushes_get_opacity</a> (void);
60
gboolean <a href="libgimp-gimpbrushes.html#gimp-brushes-set-opacity">gimp_brushes_set_opacity</a> (gdouble opacity);
61
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> <a href="libgimp-gimpbrushes.html#gimp-brushes-get-paint-mode">gimp_brushes_get_paint_mode</a>
63
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);
64
gint <a href="libgimp-gimpbrushes.html#gimp-brushes-get-spacing">gimp_brushes_get_spacing</a> (void);
65
gboolean <a href="libgimp-gimpbrushes.html#gimp-brushes-set-spacing">gimp_brushes_set_spacing</a> (gint spacing);
66
gchar* <a href="libgimp-gimpbrushes.html#gimp-brushes-get-brush-data">gimp_brushes_get_brush_data</a> (const gchar *name,
69
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> *paint_mode,
55
gboolean <a href="libgimp-gimpbrushes.html#gimp-brushes-refresh">gimp_brushes_refresh</a> (void);
56
gchar** <a href="libgimp-gimpbrushes.html#gimp-brushes-get-list">gimp_brushes_get_list</a> (const gchar *filter,
58
gchar* <a href="libgimp-gimpbrushes.html#gimp-brushes-get-brush">gimp_brushes_get_brush</a> (gint *width,
61
gboolean <a href="libgimp-gimpbrushes.html#gimp-brushes-set-brush">gimp_brushes_set_brush</a> (const gchar *name);
62
gdouble <a href="libgimp-gimpbrushes.html#gimp-brushes-get-opacity">gimp_brushes_get_opacity</a> (void);
63
gboolean <a href="libgimp-gimpbrushes.html#gimp-brushes-set-opacity">gimp_brushes_set_opacity</a> (gdouble opacity);
64
<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);
65
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);
66
gint <a href="libgimp-gimpbrushes.html#gimp-brushes-get-spacing">gimp_brushes_get_spacing</a> (void);
67
gboolean <a href="libgimp-gimpbrushes.html#gimp-brushes-set-spacing">gimp_brushes_set_spacing</a> (gint spacing);
68
gchar* <a href="libgimp-gimpbrushes.html#gimp-brushes-get-brush-data">gimp_brushes_get_brush_data</a> (const gchar *name,
71
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> *paint_mode,
76
78
<div class="refsect1" lang="en">
77
<a name="id2630883"></a><h2>Description</h2>
79
<a name="id2674115"></a><h2>Description</h2>
79
81
Functions related to getting and setting brushes.
82
84
<div class="refsect1" lang="en">
83
<a name="id2630900"></a><h2>Details</h2>
85
<a name="id2674132"></a><h2>Details</h2>
84
86
<div class="refsect2" lang="en">
85
<a name="id2630910"></a><h3>
87
<a name="id2674142"></a><h3>
86
88
<a name="gimp-brushes-refresh"></a>gimp_brushes_refresh ()</h3>
87
<a class="indexterm" name="id2630922"></a><pre class="programlisting">gboolean gimp_brushes_refresh (void);</pre>
89
<a class="indexterm" name="id2674153"></a><pre class="programlisting">gboolean gimp_brushes_refresh (void);</pre>
89
91
Refresh current brushes. This function always succeeds.
108
109
<div class="refsect2" lang="en">
109
<a name="id2630967"></a><h3>
110
<a name="id2674199"></a><h3>
110
111
<a name="gimp-brushes-get-list"></a>gimp_brushes_get_list ()</h3>
111
<a class="indexterm" name="id2630978"></a><pre class="programlisting">gchar** gimp_brushes_get_list (const gchar *filter,
112
gint *num_brushes);</pre>
112
<a class="indexterm" name="id2674210"></a><pre class="programlisting">gchar** gimp_brushes_get_list (const gchar *filter,
113
gint *num_brushes);</pre>
114
115
Retrieve a complete listing of the available brushes.
117
118
This procedure returns a complete listing of available GIMP brushes.
118
119
Each name returned can be used as input to the
119
'gimp_context_set_brush' procedure.</p>
120
<a href="libgimp-gimpcontext.html#gimp-context-set-brush"><code class="function">gimp_context_set_brush()</code></a> procedure.</p>
124
125
<col align="left" valign="top">
128
<span class="term"><em class="parameter"><code>filter</code></em> :</span></td>
128
<td><span class="term"><em class="parameter"><code>filter</code></em> :</span></td>
129
129
<td> An optional regular expression used to filter the list.
134
<span class="term"><em class="parameter"><code>num_brushes</code></em> :</span></td>
133
<td><span class="term"><em class="parameter"><code>num_brushes</code></em> :</span></td>
135
134
<td> The number of brushes in the brush list.
140
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
138
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
141
139
<td> The list of brush names.
148
146
<div class="refsect2" lang="en">
149
<a name="id2631066"></a><h3>
147
<a name="id2670202"></a><h3>
150
148
<a name="gimp-brushes-get-brush"></a>gimp_brushes_get_brush ()</h3>
151
<a class="indexterm" name="id2631080"></a><pre class="programlisting">gchar* gimp_brushes_get_brush (gint *width,
153
gint *spacing);</pre>
149
<a class="indexterm" name="id2670216"></a><pre class="programlisting">gchar* gimp_brushes_get_brush (gint *width,
151
gint *spacing);</pre>
154
152
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
155
153
<h3 class="title">Warning</h3>
156
154
<p><code class="literal">gimp_brushes_get_brush</code> is deprecated and should not be used in newly-written code.</p>
164
162
<col align="left" valign="top">
168
<span class="term"><em class="parameter"><code>width</code></em> :</span></td>
165
<td><span class="term"><em class="parameter"><code>width</code></em> :</span></td>
169
166
<td> The brush width.
174
<span class="term"><em class="parameter"><code>height</code></em> :</span></td>
170
<td><span class="term"><em class="parameter"><code>height</code></em> :</span></td>
175
171
<td> The brush height.
180
<span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
175
<td><span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
181
176
<td> The brush spacing.
186
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
180
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
187
181
<td> The brush name.
194
188
<div class="refsect2" lang="en">
195
<a name="id2628568"></a><h3>
189
<a name="id2670338"></a><h3>
196
190
<a name="gimp-brushes-set-brush"></a>gimp_brushes_set_brush ()</h3>
197
<a class="indexterm" name="id2628582"></a><pre class="programlisting">gboolean gimp_brushes_set_brush (const gchar *name);</pre>
191
<a class="indexterm" name="id2670351"></a><pre class="programlisting">gboolean gimp_brushes_set_brush (const gchar *name);</pre>
198
192
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
199
193
<h3 class="title">Warning</h3>
200
194
<p><code class="literal">gimp_brushes_set_brush</code> is deprecated and should not be used in newly-written code.</p>
226
218
<div class="refsect2" lang="en">
227
<a name="id2628662"></a><h3>
219
<a name="id2675917"></a><h3>
228
220
<a name="gimp-brushes-get-opacity"></a>gimp_brushes_get_opacity ()</h3>
229
<a class="indexterm" name="id2628675"></a><pre class="programlisting">gdouble gimp_brushes_get_opacity (void);</pre>
221
<a class="indexterm" name="id2675930"></a><pre class="programlisting">gdouble gimp_brushes_get_opacity (void);</pre>
230
222
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
231
223
<h3 class="title">Warning</h3>
232
224
<p><code class="literal">gimp_brushes_get_opacity</code> is deprecated and should not be used in newly-written code.</p>
250
241
<div class="refsect2" lang="en">
251
<a name="id2628736"></a><h3>
242
<a name="id2675990"></a><h3>
252
243
<a name="gimp-brushes-set-opacity"></a>gimp_brushes_set_opacity ()</h3>
253
<a class="indexterm" name="id2628749"></a><pre class="programlisting">gboolean gimp_brushes_set_opacity (gdouble opacity);</pre>
244
<a class="indexterm" name="id2676004"></a><pre class="programlisting">gboolean gimp_brushes_set_opacity (gdouble opacity);</pre>
254
245
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
255
246
<h3 class="title">Warning</h3>
256
247
<p><code class="literal">gimp_brushes_set_opacity</code> is deprecated and should not be used in newly-written code.</p>
282
271
<div class="refsect2" lang="en">
283
<a name="id2627331"></a><h3>
272
<a name="id2676084"></a><h3>
284
273
<a name="gimp-brushes-get-paint-mode"></a>gimp_brushes_get_paint_mode ()</h3>
285
<a class="indexterm" name="id2627345"></a><pre class="programlisting"><a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> gimp_brushes_get_paint_mode
274
<a class="indexterm" name="id2676097"></a><pre class="programlisting"><a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> gimp_brushes_get_paint_mode (void);</pre>
287
275
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
288
276
<h3 class="title">Warning</h3>
289
277
<p><code class="literal">gimp_brushes_get_paint_mode</code> is deprecated and should not be used in newly-written code.</p>
292
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>
280
This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-get-paint-mode"><code class="function">gimp_context_get_paint_mode()</code></a> instead.</p>
296
284
<div class="variablelist"><table border="0">
297
285
<col align="left" valign="top">
300
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
287
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
301
288
<td> The paint mode.
307
294
<div class="refsect2" lang="en">
308
<a name="id2627405"></a><h3>
295
<a name="id2676156"></a><h3>
309
296
<a name="gimp-brushes-set-paint-mode"></a>gimp_brushes_set_paint_mode ()</h3>
310
<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>
297
<a class="indexterm" name="id2674986"></a><pre class="programlisting">gboolean gimp_brushes_set_paint_mode (<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> paint_mode);</pre>
311
298
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
312
299
<h3 class="title">Warning</h3>
313
300
<p><code class="literal">gimp_brushes_set_paint_mode</code> is deprecated and should not be used in newly-written code.</p>
339
324
<div class="refsect2" lang="en">
340
<a name="id2627499"></a><h3>
325
<a name="id2675065"></a><h3>
341
326
<a name="gimp-brushes-get-spacing"></a>gimp_brushes_get_spacing ()</h3>
342
<a class="indexterm" name="id2627512"></a><pre class="programlisting">gint gimp_brushes_get_spacing (void);</pre>
327
<a class="indexterm" name="id2675078"></a><pre class="programlisting">gint gimp_brushes_get_spacing (void);</pre>
343
328
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
344
329
<h3 class="title">Warning</h3>
345
330
<p><code class="literal">gimp_brushes_get_spacing</code> is deprecated and should not be used in newly-written code.</p>
363
347
<div class="refsect2" lang="en">
364
<a name="id2629081"></a><h3>
348
<a name="id2675139"></a><h3>
365
349
<a name="gimp-brushes-set-spacing"></a>gimp_brushes_set_spacing ()</h3>
366
<a class="indexterm" name="id2629095"></a><pre class="programlisting">gboolean gimp_brushes_set_spacing (gint spacing);</pre>
350
<a class="indexterm" name="id2675152"></a><pre class="programlisting">gboolean gimp_brushes_set_spacing (gint spacing);</pre>
367
351
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
368
352
<h3 class="title">Warning</h3>
369
353
<p><code class="literal">gimp_brushes_set_spacing</code> is deprecated and should not be used in newly-written code.</p>
395
377
<div class="refsect2" lang="en">
396
<a name="id2629175"></a><h3>
378
<a name="id2675232"></a><h3>
397
379
<a name="gimp-brushes-get-brush-data"></a>gimp_brushes_get_brush_data ()</h3>
398
<a class="indexterm" name="id2629188"></a><pre class="programlisting">gchar* gimp_brushes_get_brush_data (const gchar *name,
401
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> *paint_mode,
405
guint8 **mask_data);</pre>
380
<a class="indexterm" name="id2675246"></a><pre class="programlisting">gchar* gimp_brushes_get_brush_data (const gchar *name,
383
<a href="libgimp-gimpenums.html#GimpLayerModeEffects">GimpLayerModeEffects</a> *paint_mode,
387
guint8 **mask_data);</pre>
406
388
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
407
389
<h3 class="title">Warning</h3>
408
390
<p><code class="literal">gimp_brushes_get_brush_data</code> is deprecated and should not be used in newly-written code.</p>
416
398
<col align="left" valign="top">
420
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
401
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
421
402
<td> The brush name (\"\" means current active brush).
426
<span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
406
<td><span class="term"><em class="parameter"><code>opacity</code></em> :</span></td>
427
407
<td> The brush opacity.
432
<span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
411
<td><span class="term"><em class="parameter"><code>spacing</code></em> :</span></td>
433
412
<td> The brush spacing.
438
<span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
416
<td><span class="term"><em class="parameter"><code>paint_mode</code></em> :</span></td>
439
417
<td> The paint mode.
444
<span class="term"><em class="parameter"><code>width</code></em> :</span></td>
421
<td><span class="term"><em class="parameter"><code>width</code></em> :</span></td>
445
422
<td> The brush width.
450
<span class="term"><em class="parameter"><code>height</code></em> :</span></td>
426
<td><span class="term"><em class="parameter"><code>height</code></em> :</span></td>
451
427
<td> The brush height.
456
<span class="term"><em class="parameter"><code>length</code></em> :</span></td>
431
<td><span class="term"><em class="parameter"><code>length</code></em> :</span></td>
457
432
<td> Length of brush mask data.
462
<span class="term"><em class="parameter"><code>mask_data</code></em> :</span></td>
436
<td><span class="term"><em class="parameter"><code>mask_data</code></em> :</span></td>
463
437
<td> The brush mask data.
468
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
441
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
469
442
<td> The brush name.
added
removed
devel-docs/libgimp/html/libgimp-gimpbrushes.html
