1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
|
<!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.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-data.html" title="Data Objects">
<link rel="next" href="libgimp-gimpbrushes.html" title="gimpbrushes">
<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-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="#id2532573" class="shortcut">Top</a>
 | 
<a href="#id2626924" 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="id2532573"></a><span class="refentrytitle">gimpbrush</span>
</h2>
<p>gimpbrush — 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">
gchar* <a href="libgimp-gimpbrush.html#gimp-brush-new">gimp_brush_new</a> (const gchar *name);
gchar* <a href="libgimp-gimpbrush.html#gimp-brush-duplicate">gimp_brush_duplicate</a> (const gchar *name);
gchar* <a href="libgimp-gimpbrush.html#gimp-brush-rename">gimp_brush_rename</a> (const gchar *name,
const gchar *new_name);
gboolean <a href="libgimp-gimpbrush.html#gimp-brush-delete">gimp_brush_delete</a> (const gchar *name);
gboolean <a href="libgimp-gimpbrush.html#gimp-brush-get-info">gimp_brush_get_info</a> (const gchar *name,
gint *width,
gint *height,
gint *mask_bpp,
gint *color_bpp);
gboolean <a href="libgimp-gimpbrush.html#gimp-brush-get-pixels">gimp_brush_get_pixels</a> (const gchar *name,
gint *width,
gint *height,
gint *mask_bpp,
gint *num_mask_bytes,
guint8 **mask_bytes,
gint *color_bpp,
gint *num_color_bytes,
guint8 **color_bytes);
gboolean <a href="libgimp-gimpbrush.html#gimp-brush-get-spacing">gimp_brush_get_spacing</a> (const gchar *name,
gint *spacing);
gboolean <a href="libgimp-gimpbrush.html#gimp-brush-set-spacing">gimp_brush_set_spacing</a> (const gchar *name,
gint spacing);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2626924"></a><h2>Description</h2>
<p>
Functions operating on a single brush.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2626939"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2626950"></a><h3>
<a name="gimp-brush-new"></a>gimp_brush_new ()</h3>
<a class="indexterm" name="id2626965"></a><pre class="programlisting">gchar* gimp_brush_new (const gchar *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>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The requested name of the new brush.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The actual new brush name.
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627033"></a><h3>
<a name="gimp-brush-duplicate"></a>gimp_brush_duplicate ()</h3>
<a class="indexterm" name="id2627047"></a><pre class="programlisting">gchar* gimp_brush_duplicate (const gchar *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>
<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> The name of the brush's copy.
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627116"></a><h3>
<a name="gimp-brush-rename"></a>gimp_brush_rename ()</h3>
<a class="indexterm" name="id2627130"></a><pre class="programlisting">gchar* gimp_brush_rename (const gchar *name,
const gchar *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>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The brush name.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>new_name</code></em> :</span></td>
<td> The new name of the brush.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The actual new name of the brush.
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627220"></a><h3>
<a name="gimp-brush-delete"></a>gimp_brush_delete ()</h3>
<a class="indexterm" name="id2627234"></a><pre class="programlisting">gboolean gimp_brush_delete (const gchar *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>
<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>
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2627865"></a><h3>
<a name="gimp-brush-get-info"></a>gimp_brush_get_info ()</h3>
<a class="indexterm" name="id2627879"></a><pre class="programlisting">gboolean gimp_brush_get_info (const gchar *name,
gint *width,
gint *height,
gint *mask_bpp,
gint *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>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The brush name.
</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>mask_bpp</code></em> :</span></td>
<td> The brush mask bpp.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>color_bpp</code></em> :</span></td>
<td> The brush color bpp.
</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>
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2628034"></a><h3>
<a name="gimp-brush-get-pixels"></a>gimp_brush_get_pixels ()</h3>
<a class="indexterm" name="id2628048"></a><pre class="programlisting">gboolean gimp_brush_get_pixels (const gchar *name,
gint *width,
gint *height,
gint *mask_bpp,
gint *num_mask_bytes,
guint8 **mask_bytes,
gint *color_bpp,
gint *num_color_bytes,
guint8 **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>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The brush name.
</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>mask_bpp</code></em> :</span></td>
<td> The brush mask bpp.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>num_mask_bytes</code></em> :</span></td>
<td> Length of brush mask data.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>mask_bytes</code></em> :</span></td>
<td> The brush mask data.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>color_bpp</code></em> :</span></td>
<td> The brush color bpp.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>num_color_bytes</code></em> :</span></td>
<td> Length of brush color data.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>color_bytes</code></em> :</span></td>
<td> The brush color data.
</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>
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2628287"></a><h3>
<a name="gimp-brush-get-spacing"></a>gimp_brush_get_spacing ()</h3>
<a class="indexterm" name="id2628301"></a><pre class="programlisting">gboolean gimp_brush_get_spacing (const gchar *name,
gint *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>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The brush name.
</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> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2628393"></a><h3>
<a name="gimp-brush-set-spacing"></a>gimp_brush_set_spacing ()</h3>
<a class="indexterm" name="id2628407"></a><pre class="programlisting">gboolean gimp_brush_set_spacing (const gchar *name,
gint 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>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The brush name.
</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> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
</p>
</div>
</div>
</div>
</body>
</html>
|
