← Back to branch summary

~ubuntu-branches/ubuntu/maverick/gimp/maverick-updates

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/html/libgimp-gimpbrush.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2005-12-09 19:44:52 UTC
  • Revision ID: james.westby@ubuntu.com-20051209194452-yggpemjlofpjqyf4
Tags: upstream-2.2.9
Import upstream version 2.2.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/html/libgimp-gimpbrush.html
 
1
<html>
 
2
<head>
 
3
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
4
<title>gimpbrush</title>
 
5
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
6
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
 
7
<link rel="up" href="libgimp-data.html" title="Data Objects">
 
8
<link rel="prev" href="libgimp-data.html" title="Data Objects">
 
9
<link rel="next" href="libgimp-gimpbrushes.html" title="gimpbrushes">
 
10
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
 
11
<link rel="stylesheet" href="style.css" type="text/css">
 
12
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
 
13
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;GIMP Library">
 
14
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
 
15
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
 
16
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
 
17
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
 
18
<link rel="part" href="libgimpui.html" title="Part&#160;III.&#160;GIMP User Interface Library">
 
19
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
 
20
</head>
 
21
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
22
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
 
23
<td><a accesskey="p" href="libgimp-data.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
24
<td><a accesskey="u" href="libgimp-data.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
25
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
26
<th width="100%" align="center">GIMP Library Reference Manual</th>
 
27
<td><a accesskey="n" href="libgimp-gimpbrushes.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
28
</tr></table>
 
29
<div class="refentry" lang="en">
 
30
<a name="libgimp-gimpbrush"></a><div class="titlepage"></div>
 
31
<div class="refnamediv"><table width="100%"><tr>
 
32
<td valign="top">
 
33
<h2><span class="refentrytitle">gimpbrush</span></h2>
 
34
<p>gimpbrush &#8212; Functions operating on a single brush.</p>
 
35
</td>
 
36
<td valign="top" align="right"></td>
 
37
</tr></table></div>
 
38
<div class="refsynopsisdiv">
 
39
<h2>Synopsis</h2>
 
40
<pre class="synopsis">
 
41
 
 
42
 
 
43
 
 
44
gchar*      <a href="libgimp-gimpbrush.html#gimp-brush-new">gimp_brush_new</a>                  (const gchar *name);
 
45
gchar*      <a href="libgimp-gimpbrush.html#gimp-brush-duplicate">gimp_brush_duplicate</a>            (const gchar *name);
 
46
gchar*      <a href="libgimp-gimpbrush.html#gimp-brush-rename">gimp_brush_rename</a>               (const gchar *name,
 
47
                                             const gchar *new_name);
 
48
gboolean    <a href="libgimp-gimpbrush.html#gimp-brush-delete">gimp_brush_delete</a>               (const gchar *name);
 
49
gboolean    <a href="libgimp-gimpbrush.html#gimp-brush-get-info">gimp_brush_get_info</a>             (const gchar *name,
 
50
                                             gint *width,
 
51
                                             gint *height,
 
52
                                             gint *mask_bpp,
 
53
                                             gint *color_bpp);
 
54
gboolean    <a href="libgimp-gimpbrush.html#gimp-brush-get-pixels">gimp_brush_get_pixels</a>           (const gchar *name,
 
55
                                             gint *width,
 
56
                                             gint *height,
 
57
                                             gint *mask_bpp,
 
58
                                             gint *num_mask_bytes,
 
59
                                             guint8 **mask_bytes,
 
60
                                             gint *color_bpp,
 
61
                                             gint *num_color_bytes,
 
62
                                             guint8 **color_bytes);
 
63
gboolean    <a href="libgimp-gimpbrush.html#gimp-brush-get-spacing">gimp_brush_get_spacing</a>          (const gchar *name,
 
64
                                             gint *spacing);
 
65
gboolean    <a href="libgimp-gimpbrush.html#gimp-brush-set-spacing">gimp_brush_set_spacing</a>          (const gchar *name,
 
66
                                             gint spacing);
 
67
</pre>
 
68
</div>
 
69
<div class="refsect1" lang="en">
 
70
<a name="id2618407"></a><h2>Description</h2>
 
71
<p>
 
72
Functions operating on a single brush.
 
73
</p>
 
74
</div>
 
75
<div class="refsect1" lang="en">
 
76
<a name="id2618418"></a><h2>Details</h2>
 
77
<div class="refsect2" lang="en">
 
78
<a name="id2618424"></a><h3>
 
79
<a name="gimp-brush-new"></a>gimp_brush_new ()</h3>
 
80
<a class="indexterm" name="id2618433"></a><pre class="programlisting">gchar*      gimp_brush_new                  (const gchar *name);</pre>
 
81
<p>
 
82
Creates a new brush
 
83
</p>
 
84
<p>
 
85
This procedure creates a new, uninitialized brush</p>
 
86
<p>
 
87
 
 
88
</p>
 
89
<div class="variablelist"><table border="0">
 
90
<col align="left" valign="top">
 
91
<tbody>
 
92
<tr>
 
93
<td>
 
94
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
95
<td> The requested name of the new brush.
 
96
</td>
 
97
</tr>
 
98
<tr>
 
99
<td>
 
100
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
101
<td> The actual new brush name.
 
102
 
 
103
</td>
 
104
</tr>
 
105
</tbody>
 
106
</table></div>
 
107
<p>Since  GIMP 2.2
 
108
</p>
 
109
</div>
 
110
<hr>
 
111
<div class="refsect2" lang="en">
 
112
<a name="id2618501"></a><h3>
 
113
<a name="gimp-brush-duplicate"></a>gimp_brush_duplicate ()</h3>
 
114
<a class="indexterm" name="id2618510"></a><pre class="programlisting">gchar*      gimp_brush_duplicate            (const gchar *name);</pre>
 
115
<p>
 
116
Duplicates a brush
 
117
</p>
 
118
<p>
 
119
This procedure creates an identical brush by a different name</p>
 
120
<p>
 
121
 
 
122
</p>
 
123
<div class="variablelist"><table border="0">
 
124
<col align="left" valign="top">
 
125
<tbody>
 
126
<tr>
 
127
<td>
 
128
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
129
<td> The brush name.
 
130
</td>
 
131
</tr>
 
132
<tr>
 
133
<td>
 
134
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
135
<td> The name of the brush's copy.
 
136
 
 
137
</td>
 
138
</tr>
 
139
</tbody>
 
140
</table></div>
 
141
<p>Since  GIMP 2.2
 
142
</p>
 
143
</div>
 
144
<hr>
 
145
<div class="refsect2" lang="en">
 
146
<a name="id2618578"></a><h3>
 
147
<a name="gimp-brush-rename"></a>gimp_brush_rename ()</h3>
 
148
<a class="indexterm" name="id2618587"></a><pre class="programlisting">gchar*      gimp_brush_rename               (const gchar *name,
 
149
                                             const gchar *new_name);</pre>
 
150
<p>
 
151
Rename a brush
 
152
</p>
 
153
<p>
 
154
This procedure renames a brush</p>
 
155
<p>
 
156
 
 
157
</p>
 
158
<div class="variablelist"><table border="0">
 
159
<col align="left" valign="top">
 
160
<tbody>
 
161
<tr>
 
162
<td>
 
163
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
164
<td> The brush name.
 
165
</td>
 
166
</tr>
 
167
<tr>
 
168
<td>
 
169
<span class="term"><em class="parameter"><code>new_name</code></em>&#160;:</span></td>
 
170
<td> The new name of the brush.
 
171
</td>
 
172
</tr>
 
173
<tr>
 
174
<td>
 
175
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
176
<td> The actual new name of the brush.
 
177
 
 
178
</td>
 
179
</tr>
 
180
</tbody>
 
181
</table></div>
 
182
<p>Since  GIMP 2.2
 
183
</p>
 
184
</div>
 
185
<hr>
 
186
<div class="refsect2" lang="en">
 
187
<a name="id2616277"></a><h3>
 
188
<a name="gimp-brush-delete"></a>gimp_brush_delete ()</h3>
 
189
<a class="indexterm" name="id2616286"></a><pre class="programlisting">gboolean    gimp_brush_delete               (const gchar *name);</pre>
 
190
<p>
 
191
Deletes a brush
 
192
</p>
 
193
<p>
 
194
This procedure deletes a brush</p>
 
195
<p>
 
196
 
 
197
</p>
 
198
<div class="variablelist"><table border="0">
 
199
<col align="left" valign="top">
 
200
<tbody>
 
201
<tr>
 
202
<td>
 
203
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
204
<td> The brush name.
 
205
</td>
 
206
</tr>
 
207
<tr>
 
208
<td>
 
209
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
210
<td> TRUE on success.
 
211
 
 
212
</td>
 
213
</tr>
 
214
</tbody>
 
215
</table></div>
 
216
<p>Since  GIMP 2.2
 
217
</p>
 
218
</div>
 
219
<hr>
 
220
<div class="refsect2" lang="en">
 
221
<a name="id2616352"></a><h3>
 
222
<a name="gimp-brush-get-info"></a>gimp_brush_get_info ()</h3>
 
223
<a class="indexterm" name="id2616361"></a><pre class="programlisting">gboolean    gimp_brush_get_info             (const gchar *name,
 
224
                                             gint *width,
 
225
                                             gint *height,
 
226
                                             gint *mask_bpp,
 
227
                                             gint *color_bpp);</pre>
 
228
<p>
 
229
Retrieve information about the specified brush.
 
230
</p>
 
231
<p>
 
232
This procedure retrieves information about the specified brush. This
 
233
includes the brush name, and the brush extents (width and height).</p>
 
234
<p>
 
235
 
 
236
</p>
 
237
<div class="variablelist"><table border="0">
 
238
<col align="left" valign="top">
 
239
<tbody>
 
240
<tr>
 
241
<td>
 
242
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
243
<td> The brush name.
 
244
</td>
 
245
</tr>
 
246
<tr>
 
247
<td>
 
248
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
 
249
<td> The brush width.
 
250
</td>
 
251
</tr>
 
252
<tr>
 
253
<td>
 
254
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
 
255
<td> The brush height.
 
256
</td>
 
257
</tr>
 
258
<tr>
 
259
<td>
 
260
<span class="term"><em class="parameter"><code>mask_bpp</code></em>&#160;:</span></td>
 
261
<td> The brush mask bpp.
 
262
</td>
 
263
</tr>
 
264
<tr>
 
265
<td>
 
266
<span class="term"><em class="parameter"><code>color_bpp</code></em>&#160;:</span></td>
 
267
<td> The brush color bpp.
 
268
</td>
 
269
</tr>
 
270
<tr>
 
271
<td>
 
272
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
273
<td> TRUE on success.
 
274
 
 
275
</td>
 
276
</tr>
 
277
</tbody>
 
278
</table></div>
 
279
<p>Since  GIMP 2.2
 
280
</p>
 
281
</div>
 
282
<hr>
 
283
<div class="refsect2" lang="en">
 
284
<a name="id2616514"></a><h3>
 
285
<a name="gimp-brush-get-pixels"></a>gimp_brush_get_pixels ()</h3>
 
286
<a class="indexterm" name="id2616523"></a><pre class="programlisting">gboolean    gimp_brush_get_pixels           (const gchar *name,
 
287
                                             gint *width,
 
288
                                             gint *height,
 
289
                                             gint *mask_bpp,
 
290
                                             gint *num_mask_bytes,
 
291
                                             guint8 **mask_bytes,
 
292
                                             gint *color_bpp,
 
293
                                             gint *num_color_bytes,
 
294
                                             guint8 **color_bytes);</pre>
 
295
<p>
 
296
Retrieve information about the specified brush.
 
297
</p>
 
298
<p>
 
299
This procedure retrieves information about the specified brush. This
 
300
includes the brush extents (width and height) and its pixels data.</p>
 
301
<p>
 
302
 
 
303
</p>
 
304
<div class="variablelist"><table border="0">
 
305
<col align="left" valign="top">
 
306
<tbody>
 
307
<tr>
 
308
<td>
 
309
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
310
<td> The brush name.
 
311
</td>
 
312
</tr>
 
313
<tr>
 
314
<td>
 
315
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
 
316
<td> The brush width.
 
317
</td>
 
318
</tr>
 
319
<tr>
 
320
<td>
 
321
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
 
322
<td> The brush height.
 
323
</td>
 
324
</tr>
 
325
<tr>
 
326
<td>
 
327
<span class="term"><em class="parameter"><code>mask_bpp</code></em>&#160;:</span></td>
 
328
<td> The brush mask bpp.
 
329
</td>
 
330
</tr>
 
331
<tr>
 
332
<td>
 
333
<span class="term"><em class="parameter"><code>num_mask_bytes</code></em>&#160;:</span></td>
 
334
<td> Length of brush mask data.
 
335
</td>
 
336
</tr>
 
337
<tr>
 
338
<td>
 
339
<span class="term"><em class="parameter"><code>mask_bytes</code></em>&#160;:</span></td>
 
340
<td> The brush mask data.
 
341
</td>
 
342
</tr>
 
343
<tr>
 
344
<td>
 
345
<span class="term"><em class="parameter"><code>color_bpp</code></em>&#160;:</span></td>
 
346
<td> The brush color bpp.
 
347
</td>
 
348
</tr>
 
349
<tr>
 
350
<td>
 
351
<span class="term"><em class="parameter"><code>num_color_bytes</code></em>&#160;:</span></td>
 
352
<td> Length of brush color data.
 
353
</td>
 
354
</tr>
 
355
<tr>
 
356
<td>
 
357
<span class="term"><em class="parameter"><code>color_bytes</code></em>&#160;:</span></td>
 
358
<td> The brush color data.
 
359
</td>
 
360
</tr>
 
361
<tr>
 
362
<td>
 
363
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
364
<td> TRUE on success.
 
365
 
 
366
</td>
 
367
</tr>
 
368
</tbody>
 
369
</table></div>
 
370
<p>Since  GIMP 2.2
 
371
</p>
 
372
</div>
 
373
<hr>
 
374
<div class="refsect2" lang="en">
 
375
<a name="id2620744"></a><h3>
 
376
<a name="gimp-brush-get-spacing"></a>gimp_brush_get_spacing ()</h3>
 
377
<a class="indexterm" name="id2620753"></a><pre class="programlisting">gboolean    gimp_brush_get_spacing          (const gchar *name,
 
378
                                             gint *spacing);</pre>
 
379
<p>
 
380
Get the brush spacing.
 
381
</p>
 
382
<p>
 
383
This procedure returns the spacing setting for the specified brush.
 
384
The return value is an integer between 0 and 1000 which represents
 
385
percentage of the maximum of the width and height of the mask.</p>
 
386
<p>
 
387
 
 
388
</p>
 
389
<div class="variablelist"><table border="0">
 
390
<col align="left" valign="top">
 
391
<tbody>
 
392
<tr>
 
393
<td>
 
394
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
395
<td> The brush name.
 
396
</td>
 
397
</tr>
 
398
<tr>
 
399
<td>
 
400
<span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></td>
 
401
<td> The brush spacing.
 
402
</td>
 
403
</tr>
 
404
<tr>
 
405
<td>
 
406
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
407
<td> TRUE on success.
 
408
 
 
409
</td>
 
410
</tr>
 
411
</tbody>
 
412
</table></div>
 
413
<p>Since  GIMP 2.2
 
414
</p>
 
415
</div>
 
416
<hr>
 
417
<div class="refsect2" lang="en">
 
418
<a name="id2620844"></a><h3>
 
419
<a name="gimp-brush-set-spacing"></a>gimp_brush_set_spacing ()</h3>
 
420
<a class="indexterm" name="id2620853"></a><pre class="programlisting">gboolean    gimp_brush_set_spacing          (const gchar *name,
 
421
                                             gint spacing);</pre>
 
422
<p>
 
423
Set the brush spacing.
 
424
</p>
 
425
<p>
 
426
This procedure modifies the spacing setting for the specified brush.
 
427
The value should be a integer between 0 and 1000.</p>
 
428
<p>
 
429
 
 
430
</p>
 
431
<div class="variablelist"><table border="0">
 
432
<col align="left" valign="top">
 
433
<tbody>
 
434
<tr>
 
435
<td>
 
436
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
437
<td> The brush name.
 
438
</td>
 
439
</tr>
 
440
<tr>
 
441
<td>
 
442
<span class="term"><em class="parameter"><code>spacing</code></em>&#160;:</span></td>
 
443
<td> The brush spacing.
 
444
</td>
 
445
</tr>
 
446
<tr>
 
447
<td>
 
448
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
449
<td> TRUE on success.
 
450
 
 
451
</td>
 
452
</tr>
 
453
</tbody>
 
454
</table></div>
 
455
<p>Since  GIMP 2.2
 
456
</p>
 
457
</div>
 
458
</div>
 
459
</div>
 
460
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
 
461
<td align="left"><a accesskey="p" href="libgimp-data.html"><b>&lt;&lt;&#160;Data Objects</b></a></td>
 
462
<td align="right"><a accesskey="n" href="libgimp-gimpbrushes.html"><b>gimpbrushes&#160;&gt;&gt;</b></a></td>
 
463
</tr></table>
 
464
</body>
 
465
</html>