← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimpbrush.xml
22
22
 
23
23
 
24
24
 
25
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-brush-new">gimp_brush_new</link>                  (const <link linkend="gchar">gchar</link> *name);
26
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-brush-duplicate">gimp_brush_duplicate</link>            (const <link linkend="gchar">gchar</link> *name);
27
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-brush-rename">gimp_brush_rename</link>               (const <link linkend="gchar">gchar</link> *name,
28
 
                                             const <link linkend="gchar">gchar</link> *new_name);
29
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-brush-delete">gimp_brush_delete</link>               (const <link linkend="gchar">gchar</link> *name);
30
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-brush-get-info">gimp_brush_get_info</link>             (const <link linkend="gchar">gchar</link> *name,
31
 
                                             <link linkend="gint">gint</link> *width,
32
 
                                             <link linkend="gint">gint</link> *height,
33
 
                                             <link linkend="gint">gint</link> *mask_bpp,
34
 
                                             <link linkend="gint">gint</link> *color_bpp);
35
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-brush-get-pixels">gimp_brush_get_pixels</link>           (const <link linkend="gchar">gchar</link> *name,
36
 
                                             <link linkend="gint">gint</link> *width,
37
 
                                             <link linkend="gint">gint</link> *height,
38
 
                                             <link linkend="gint">gint</link> *mask_bpp,
39
 
                                             <link linkend="gint">gint</link> *num_mask_bytes,
40
 
                                             <link linkend="guint8">guint8</link> **mask_bytes,
41
 
                                             <link linkend="gint">gint</link> *color_bpp,
42
 
                                             <link linkend="gint">gint</link> *num_color_bytes,
43
 
                                             <link linkend="guint8">guint8</link> **color_bytes);
44
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-brush-get-spacing">gimp_brush_get_spacing</link>          (const <link linkend="gchar">gchar</link> *name,
45
 
                                             <link linkend="gint">gint</link> *spacing);
46
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-brush-set-spacing">gimp_brush_set_spacing</link>          (const <link linkend="gchar">gchar</link> *name,
47
 
                                             <link linkend="gint">gint</link> spacing);
 
25
<link linkend="gchar">gchar</link>*              <link linkend="gimp-brush-new">gimp_brush_new</link>                      (const <link linkend="gchar">gchar</link> *name);
 
26
<link linkend="gchar">gchar</link>*              <link linkend="gimp-brush-duplicate">gimp_brush_duplicate</link>                (const <link linkend="gchar">gchar</link> *name);
 
27
<link linkend="gchar">gchar</link>*              <link linkend="gimp-brush-rename">gimp_brush_rename</link>                   (const <link linkend="gchar">gchar</link> *name,
 
28
                                                         const <link linkend="gchar">gchar</link> *new_name);
 
29
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-brush-delete">gimp_brush_delete</link>                   (const <link linkend="gchar">gchar</link> *name);
 
30
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-brush-get-info">gimp_brush_get_info</link>                 (const <link linkend="gchar">gchar</link> *name,
 
31
                                                         <link linkend="gint">gint</link> *width,
 
32
                                                         <link linkend="gint">gint</link> *height,
 
33
                                                         <link linkend="gint">gint</link> *mask_bpp,
 
34
                                                         <link linkend="gint">gint</link> *color_bpp);
 
35
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-brush-get-pixels">gimp_brush_get_pixels</link>               (const <link linkend="gchar">gchar</link> *name,
 
36
                                                         <link linkend="gint">gint</link> *width,
 
37
                                                         <link linkend="gint">gint</link> *height,
 
38
                                                         <link linkend="gint">gint</link> *mask_bpp,
 
39
                                                         <link linkend="gint">gint</link> *num_mask_bytes,
 
40
                                                         <link linkend="guint8">guint8</link> **mask_bytes,
 
41
                                                         <link linkend="gint">gint</link> *color_bpp,
 
42
                                                         <link linkend="gint">gint</link> *num_color_bytes,
 
43
                                                         <link linkend="guint8">guint8</link> **color_bytes);
 
44
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-brush-get-spacing">gimp_brush_get_spacing</link>              (const <link linkend="gchar">gchar</link> *name,
 
45
                                                         <link linkend="gint">gint</link> *spacing);
 
46
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-brush-set-spacing">gimp_brush_set_spacing</link>              (const <link linkend="gchar">gchar</link> *name,
 
47
                                                         <link linkend="gint">gint</link> spacing);
 
48
<link linkend="GimpBrushGeneratedShape">GimpBrushGeneratedShape</link> <link linkend="gimp-brush-get-shape">gimp_brush_get_shape</link>            (const <link linkend="gchar">gchar</link> *name);
 
49
<link linkend="GimpBrushGeneratedShape">GimpBrushGeneratedShape</link> <link linkend="gimp-brush-set-shape">gimp_brush_set_shape</link>            (const <link linkend="gchar">gchar</link> *name,
 
50
                                                         <link linkend="GimpBrushGeneratedShape">GimpBrushGeneratedShape</link> shape_in);
 
51
<link linkend="gint">gint</link>                <link linkend="gimp-brush-get-spikes">gimp_brush_get_spikes</link>               (const <link linkend="gchar">gchar</link> *name);
 
52
<link linkend="gint">gint</link>                <link linkend="gimp-brush-set-spikes">gimp_brush_set_spikes</link>               (const <link linkend="gchar">gchar</link> *name,
 
53
                                                         <link linkend="gint">gint</link> spikes_in);
 
54
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-brush-get-angle">gimp_brush_get_angle</link>                (const <link linkend="gchar">gchar</link> *name);
 
55
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-brush-set-angle">gimp_brush_set_angle</link>                (const <link linkend="gchar">gchar</link> *name,
 
56
                                                         <link linkend="gdouble">gdouble</link> angle_in);
 
57
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-brush-get-radius">gimp_brush_get_radius</link>               (const <link linkend="gchar">gchar</link> *name);
 
58
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-brush-set-radius">gimp_brush_set_radius</link>               (const <link linkend="gchar">gchar</link> *name,
 
59
                                                         <link linkend="gdouble">gdouble</link> radius_in);
 
60
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-brush-get-aspect-ratio">gimp_brush_get_aspect_ratio</link>         (const <link linkend="gchar">gchar</link> *name);
 
61
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-brush-set-aspect-ratio">gimp_brush_set_aspect_ratio</link>         (const <link linkend="gchar">gchar</link> *name,
 
62
                                                         <link linkend="gdouble">gdouble</link> aspect_ratio_in);
 
63
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-brush-get-hardness">gimp_brush_get_hardness</link>             (const <link linkend="gchar">gchar</link> *name);
 
64
<link linkend="gdouble">gdouble</link>             <link linkend="gimp-brush-set-hardness">gimp_brush_set_hardness</link>             (const <link linkend="gchar">gchar</link> *name,
 
65
                                                         <link linkend="gdouble">gdouble</link> hardness_in);
 
66
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-brush-is-generated">gimp_brush_is_generated</link>             (const <link linkend="gchar">gchar</link> *name);
 
67
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-brush-is-editable">gimp_brush_is_editable</link>              (const <link linkend="gchar">gchar</link> *name);
48
68
</synopsis>
49
69
</refsynopsisdiv>
50
70
 
67
87
<title role="details.title">Details</title>
68
88
<refsect2>
69
89
<title><anchor id="gimp-brush-new" role="function" condition="since:GIMP 2.2"/>gimp_brush_new ()</title>
70
 
<indexterm role="GIMP 2.2"><primary>gimp_brush_new</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_brush_new                  (const <link linkend="gchar">gchar</link> *name);</programlisting>
 
90
<indexterm role="GIMP 2.2"><primary>gimp_brush_new</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_brush_new                      (const <link linkend="gchar">gchar</link> *name);</programlisting>
71
91
<para>
72
92
Creates a new brush
73
93
</para>
82
102
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The actual new brush name.
83
103
 
84
104
</simpara></listitem></varlistentry>
85
 
</variablelist><para>Since  GIMP 2.2
 
105
</variablelist><para role="since">Since  GIMP 2.2
86
106
</para></refsect2>
87
107
<refsect2>
88
108
<title><anchor id="gimp-brush-duplicate" role="function" condition="since:GIMP 2.2"/>gimp_brush_duplicate ()</title>
89
 
<indexterm role="GIMP 2.2"><primary>gimp_brush_duplicate</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_brush_duplicate            (const <link linkend="gchar">gchar</link> *name);</programlisting>
 
109
<indexterm role="GIMP 2.2"><primary>gimp_brush_duplicate</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_brush_duplicate                (const <link linkend="gchar">gchar</link> *name);</programlisting>
90
110
<para>
91
111
Duplicates a brush
92
112
</para>
101
121
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The name of the brush's copy.
102
122
 
103
123
</simpara></listitem></varlistentry>
104
 
</variablelist><para>Since  GIMP 2.2
 
124
</variablelist><para role="since">Since  GIMP 2.2
105
125
</para></refsect2>
106
126
<refsect2>
107
127
<title><anchor id="gimp-brush-rename" role="function" condition="since:GIMP 2.2"/>gimp_brush_rename ()</title>
108
 
<indexterm role="GIMP 2.2"><primary>gimp_brush_rename</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_brush_rename               (const <link linkend="gchar">gchar</link> *name,
109
 
                                             const <link linkend="gchar">gchar</link> *new_name);</programlisting>
 
128
<indexterm role="GIMP 2.2"><primary>gimp_brush_rename</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_brush_rename                   (const <link linkend="gchar">gchar</link> *name,
 
129
                                                         const <link linkend="gchar">gchar</link> *new_name);</programlisting>
110
130
<para>
111
131
Rename a brush
112
132
</para>
124
144
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The actual new name of the brush.
125
145
 
126
146
</simpara></listitem></varlistentry>
127
 
</variablelist><para>Since  GIMP 2.2
 
147
</variablelist><para role="since">Since  GIMP 2.2
128
148
</para></refsect2>
129
149
<refsect2>
130
150
<title><anchor id="gimp-brush-delete" role="function" condition="since:GIMP 2.2"/>gimp_brush_delete ()</title>
131
 
<indexterm role="GIMP 2.2"><primary>gimp_brush_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_brush_delete               (const <link linkend="gchar">gchar</link> *name);</programlisting>
 
151
<indexterm role="GIMP 2.2"><primary>gimp_brush_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_brush_delete                   (const <link linkend="gchar">gchar</link> *name);</programlisting>
132
152
<para>
133
153
Deletes a brush
134
154
</para>
143
163
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
144
164
 
145
165
</simpara></listitem></varlistentry>
146
 
</variablelist><para>Since  GIMP 2.2
 
166
</variablelist><para role="since">Since  GIMP 2.2
147
167
</para></refsect2>
148
168
<refsect2>
149
169
<title><anchor id="gimp-brush-get-info" role="function" condition="since:GIMP 2.2"/>gimp_brush_get_info ()</title>
150
 
<indexterm role="GIMP 2.2"><primary>gimp_brush_get_info</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_brush_get_info             (const <link linkend="gchar">gchar</link> *name,
151
 
                                             <link linkend="gint">gint</link> *width,
152
 
                                             <link linkend="gint">gint</link> *height,
153
 
                                             <link linkend="gint">gint</link> *mask_bpp,
154
 
                                             <link linkend="gint">gint</link> *color_bpp);</programlisting>
 
170
<indexterm role="GIMP 2.2"><primary>gimp_brush_get_info</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_brush_get_info                 (const <link linkend="gchar">gchar</link> *name,
 
171
                                                         <link linkend="gint">gint</link> *width,
 
172
                                                         <link linkend="gint">gint</link> *height,
 
173
                                                         <link linkend="gint">gint</link> *mask_bpp,
 
174
                                                         <link linkend="gint">gint</link> *color_bpp);</programlisting>
155
175
<para>
156
176
Retrieve information about the specified brush.
157
177
</para>
179
199
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
180
200
 
181
201
</simpara></listitem></varlistentry>
182
 
</variablelist><para>Since  GIMP 2.2
 
202
</variablelist><para role="since">Since  GIMP 2.2
183
203
</para></refsect2>
184
204
<refsect2>
185
205
<title><anchor id="gimp-brush-get-pixels" role="function" condition="since:GIMP 2.2"/>gimp_brush_get_pixels ()</title>
186
 
<indexterm role="GIMP 2.2"><primary>gimp_brush_get_pixels</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_brush_get_pixels           (const <link linkend="gchar">gchar</link> *name,
187
 
                                             <link linkend="gint">gint</link> *width,
188
 
                                             <link linkend="gint">gint</link> *height,
189
 
                                             <link linkend="gint">gint</link> *mask_bpp,
190
 
                                             <link linkend="gint">gint</link> *num_mask_bytes,
191
 
                                             <link linkend="guint8">guint8</link> **mask_bytes,
192
 
                                             <link linkend="gint">gint</link> *color_bpp,
193
 
                                             <link linkend="gint">gint</link> *num_color_bytes,
194
 
                                             <link linkend="guint8">guint8</link> **color_bytes);</programlisting>
 
206
<indexterm role="GIMP 2.2"><primary>gimp_brush_get_pixels</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_brush_get_pixels               (const <link linkend="gchar">gchar</link> *name,
 
207
                                                         <link linkend="gint">gint</link> *width,
 
208
                                                         <link linkend="gint">gint</link> *height,
 
209
                                                         <link linkend="gint">gint</link> *mask_bpp,
 
210
                                                         <link linkend="gint">gint</link> *num_mask_bytes,
 
211
                                                         <link linkend="guint8">guint8</link> **mask_bytes,
 
212
                                                         <link linkend="gint">gint</link> *color_bpp,
 
213
                                                         <link linkend="gint">gint</link> *num_color_bytes,
 
214
                                                         <link linkend="guint8">guint8</link> **color_bytes);</programlisting>
195
215
<para>
196
216
Retrieve information about the specified brush.
197
217
</para>
231
251
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
232
252
 
233
253
</simpara></listitem></varlistentry>
234
 
</variablelist><para>Since  GIMP 2.2
 
254
</variablelist><para role="since">Since  GIMP 2.2
235
255
</para></refsect2>
236
256
<refsect2>
237
257
<title><anchor id="gimp-brush-get-spacing" role="function" condition="since:GIMP 2.2"/>gimp_brush_get_spacing ()</title>
238
 
<indexterm role="GIMP 2.2"><primary>gimp_brush_get_spacing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_brush_get_spacing          (const <link linkend="gchar">gchar</link> *name,
239
 
                                             <link linkend="gint">gint</link> *spacing);</programlisting>
 
258
<indexterm role="GIMP 2.2"><primary>gimp_brush_get_spacing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_brush_get_spacing              (const <link linkend="gchar">gchar</link> *name,
 
259
                                                         <link linkend="gint">gint</link> *spacing);</programlisting>
240
260
<para>
241
261
Get the brush spacing.
242
262
</para>
256
276
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
257
277
 
258
278
</simpara></listitem></varlistentry>
259
 
</variablelist><para>Since  GIMP 2.2
 
279
</variablelist><para role="since">Since  GIMP 2.2
260
280
</para></refsect2>
261
281
<refsect2>
262
 
<title><anchor id="gimp-brush-set-spacing" role="function" condition="since:GIMP 2.2"/>gimp_brush_set_spacing ()</title>
263
 
<indexterm role="GIMP 2.2"><primary>gimp_brush_set_spacing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_brush_set_spacing          (const <link linkend="gchar">gchar</link> *name,
264
 
                                             <link linkend="gint">gint</link> spacing);</programlisting>
 
282
<title><anchor id="gimp-brush-set-spacing" role="function" condition="since:GIMP 2.4"/>gimp_brush_set_spacing ()</title>
 
283
<indexterm role="GIMP 2.4"><primary>gimp_brush_set_spacing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_brush_set_spacing              (const <link linkend="gchar">gchar</link> *name,
 
284
                                                         <link linkend="gint">gint</link> spacing);</programlisting>
265
285
<para>
266
286
Set the brush spacing.
267
287
</para>
280
300
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE on success.
281
301
 
282
302
</simpara></listitem></varlistentry>
283
 
</variablelist><para>Since  GIMP 2.2
 
303
</variablelist><para role="since">Since  GIMP 2.4
 
304
</para></refsect2>
 
305
<refsect2>
 
306
<title><anchor id="gimp-brush-get-shape" role="function" condition="since:GIMP 2.4"/>gimp_brush_get_shape ()</title>
 
307
<indexterm role="GIMP 2.4"><primary>gimp_brush_get_shape</primary></indexterm><programlisting><link linkend="GimpBrushGeneratedShape">GimpBrushGeneratedShape</link> gimp_brush_get_shape            (const <link linkend="gchar">gchar</link> *name);</programlisting>
 
308
<para>
 
309
Get the shape of a generated brush.
 
310
</para>
 
311
<para>
 
312
This procedure gets the shape value for a generated brush. If called
 
313
for any other type of brush, it does not succeed. The current
 
314
possibilities are Circle (GIMP_BRUSH_GENERATED_CIRCLE), Square
 
315
(GIMP_BRUSH_GENERATED_SQUARE), and Diamond
 
316
(GIMP_BRUSH_GENERATED_DIAMOND). Other shapes are likely to be added
 
317
in the future.</para>
 
318
<para>
 
319
 
 
320
</para><variablelist role="params">
 
321
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
322
<listitem><simpara> The brush name.
 
323
</simpara></listitem></varlistentry>
 
324
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The brush shape.
 
325
 
 
326
</simpara></listitem></varlistentry>
 
327
</variablelist><para role="since">Since  GIMP 2.4
 
328
</para></refsect2>
 
329
<refsect2>
 
330
<title><anchor id="gimp-brush-set-shape" role="function" condition="since:GIMP 2.4"/>gimp_brush_set_shape ()</title>
 
331
<indexterm role="GIMP 2.4"><primary>gimp_brush_set_shape</primary></indexterm><programlisting><link linkend="GimpBrushGeneratedShape">GimpBrushGeneratedShape</link> gimp_brush_set_shape            (const <link linkend="gchar">gchar</link> *name,
 
332
                                                         <link linkend="GimpBrushGeneratedShape">GimpBrushGeneratedShape</link> shape_in);</programlisting>
 
333
<para>
 
334
Set the shape of a generated brush.
 
335
</para>
 
336
<para>
 
337
This procedure sets the shape value for a generated brush. If called
 
338
for any other type of brush, it does not succeed. The current
 
339
possibilities are Circle (GIMP_BRUSH_GENERATED_CIRCLE), Square
 
340
(GIMP_BRUSH_GENERATED_SQUARE), and Diamond
 
341
(GIMP_BRUSH_GENERATED_DIAMOND). Other shapes are likely to be added
 
342
in the future.</para>
 
343
<para>
 
344
 
 
345
</para><variablelist role="params">
 
346
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
347
<listitem><simpara> The brush name.
 
348
</simpara></listitem></varlistentry>
 
349
<varlistentry><term><parameter>shape_in</parameter>&nbsp;:</term>
 
350
<listitem><simpara> The brush shape.
 
351
</simpara></listitem></varlistentry>
 
352
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The brush shape actually assigned.
 
353
 
 
354
</simpara></listitem></varlistentry>
 
355
</variablelist><para role="since">Since  GIMP 2.4
 
356
</para></refsect2>
 
357
<refsect2>
 
358
<title><anchor id="gimp-brush-get-spikes" role="function" condition="since:GIMP 2.4"/>gimp_brush_get_spikes ()</title>
 
359
<indexterm role="GIMP 2.4"><primary>gimp_brush_get_spikes</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_brush_get_spikes               (const <link linkend="gchar">gchar</link> *name);</programlisting>
 
360
<para>
 
361
Get the number of spikes for a generated brush.
 
362
</para>
 
363
<para>
 
364
This procedure gets the number of spikes for a generated brush. If
 
365
called for any other type of brush, it does not succeed.</para>
 
366
<para>
 
367
 
 
368
</para><variablelist role="params">
 
369
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
370
<listitem><simpara> The brush name.
 
371
</simpara></listitem></varlistentry>
 
372
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The number of spikes on the brush.
 
373
 
 
374
</simpara></listitem></varlistentry>
 
375
</variablelist><para role="since">Since  GIMP 2.4
 
376
</para></refsect2>
 
377
<refsect2>
 
378
<title><anchor id="gimp-brush-set-spikes" role="function" condition="since:GIMP 2.4"/>gimp_brush_set_spikes ()</title>
 
379
<indexterm role="GIMP 2.4"><primary>gimp_brush_set_spikes</primary></indexterm><programlisting><link linkend="gint">gint</link>                gimp_brush_set_spikes               (const <link linkend="gchar">gchar</link> *name,
 
380
                                                         <link linkend="gint">gint</link> spikes_in);</programlisting>
 
381
<para>
 
382
Set the number of spikes for a generated brush.
 
383
</para>
 
384
<para>
 
385
This procedure sets the number of spikes for a generated brush. If
 
386
called for any other type of brush, it does not succeed.</para>
 
387
<para>
 
388
 
 
389
</para><variablelist role="params">
 
390
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
391
<listitem><simpara> The brush name.
 
392
</simpara></listitem></varlistentry>
 
393
<varlistentry><term><parameter>spikes_in</parameter>&nbsp;:</term>
 
394
<listitem><simpara> The desired number of spikes.
 
395
</simpara></listitem></varlistentry>
 
396
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The number of spikes actually assigned.
 
397
 
 
398
</simpara></listitem></varlistentry>
 
399
</variablelist><para role="since">Since  GIMP 2.4
 
400
</para></refsect2>
 
401
<refsect2>
 
402
<title><anchor id="gimp-brush-get-angle" role="function" condition="since:GIMP 2.4"/>gimp_brush_get_angle ()</title>
 
403
<indexterm role="GIMP 2.4"><primary>gimp_brush_get_angle</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_brush_get_angle                (const <link linkend="gchar">gchar</link> *name);</programlisting>
 
404
<para>
 
405
Get the rotation angle of a generated brush.
 
406
</para>
 
407
<para>
 
408
This procedure gets the angle of rotation for a generated brush. If
 
409
called for any other type of brush, it does not succeed.</para>
 
410
<para>
 
411
 
 
412
</para><variablelist role="params">
 
413
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
414
<listitem><simpara> The brush name.
 
415
</simpara></listitem></varlistentry>
 
416
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The rotation angle of the brush.
 
417
 
 
418
</simpara></listitem></varlistentry>
 
419
</variablelist><para role="since">Since  GIMP 2.4
 
420
</para></refsect2>
 
421
<refsect2>
 
422
<title><anchor id="gimp-brush-set-angle" role="function" condition="since:GIMP 2.4"/>gimp_brush_set_angle ()</title>
 
423
<indexterm role="GIMP 2.4"><primary>gimp_brush_set_angle</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_brush_set_angle                (const <link linkend="gchar">gchar</link> *name,
 
424
                                                         <link linkend="gdouble">gdouble</link> angle_in);</programlisting>
 
425
<para>
 
426
Set the rotation angle of a generated brush.
 
427
</para>
 
428
<para>
 
429
This procedure sets the rotation angle for a generated brush. If
 
430
called for any other type of brush, it does not succeed.</para>
 
431
<para>
 
432
 
 
433
</para><variablelist role="params">
 
434
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
435
<listitem><simpara> The brush name.
 
436
</simpara></listitem></varlistentry>
 
437
<varlistentry><term><parameter>angle_in</parameter>&nbsp;:</term>
 
438
<listitem><simpara> The desired brush rotation angle.
 
439
</simpara></listitem></varlistentry>
 
440
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The brush rotation angle actually assigned.
 
441
 
 
442
</simpara></listitem></varlistentry>
 
443
</variablelist><para role="since">Since  GIMP 2.4
 
444
</para></refsect2>
 
445
<refsect2>
 
446
<title><anchor id="gimp-brush-get-radius" role="function" condition="since:GIMP 2.4"/>gimp_brush_get_radius ()</title>
 
447
<indexterm role="GIMP 2.4"><primary>gimp_brush_get_radius</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_brush_get_radius               (const <link linkend="gchar">gchar</link> *name);</programlisting>
 
448
<para>
 
449
Get the radius of a generated brush.
 
450
</para>
 
451
<para>
 
452
This procedure gets the radius value for a generated brush. If
 
453
called for any other type of brush, it does not succeed.</para>
 
454
<para>
 
455
 
 
456
</para><variablelist role="params">
 
457
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
458
<listitem><simpara> The brush name.
 
459
</simpara></listitem></varlistentry>
 
460
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The radius of the brush in pixels.
 
461
 
 
462
</simpara></listitem></varlistentry>
 
463
</variablelist><para role="since">Since  GIMP 2.4
 
464
</para></refsect2>
 
465
<refsect2>
 
466
<title><anchor id="gimp-brush-set-radius" role="function" condition="since:GIMP 2.4"/>gimp_brush_set_radius ()</title>
 
467
<indexterm role="GIMP 2.4"><primary>gimp_brush_set_radius</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_brush_set_radius               (const <link linkend="gchar">gchar</link> *name,
 
468
                                                         <link linkend="gdouble">gdouble</link> radius_in);</programlisting>
 
469
<para>
 
470
Set the radius of a generated brush.
 
471
</para>
 
472
<para>
 
473
This procedure sets the radius for a generated brush. If called for
 
474
any other type of brush, it does not succeed.</para>
 
475
<para>
 
476
 
 
477
</para><variablelist role="params">
 
478
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
479
<listitem><simpara> The brush name.
 
480
</simpara></listitem></varlistentry>
 
481
<varlistentry><term><parameter>radius_in</parameter>&nbsp;:</term>
 
482
<listitem><simpara> The desired brush radius.
 
483
</simpara></listitem></varlistentry>
 
484
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The brush radius actually assigned.
 
485
 
 
486
</simpara></listitem></varlistentry>
 
487
</variablelist><para role="since">Since  GIMP 2.4
 
488
</para></refsect2>
 
489
<refsect2>
 
490
<title><anchor id="gimp-brush-get-aspect-ratio" role="function" condition="since:GIMP 2.4"/>gimp_brush_get_aspect_ratio ()</title>
 
491
<indexterm role="GIMP 2.4"><primary>gimp_brush_get_aspect_ratio</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_brush_get_aspect_ratio         (const <link linkend="gchar">gchar</link> *name);</programlisting>
 
492
<para>
 
493
Get the aspect ratio of a generated brush.
 
494
</para>
 
495
<para>
 
496
This procedure gets the aspect ratio of a generated brush. If called
 
497
for any other type of brush, it does not succeed.</para>
 
498
<para>
 
499
 
 
500
</para><variablelist role="params">
 
501
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
502
<listitem><simpara> The brush name.
 
503
</simpara></listitem></varlistentry>
 
504
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The aspect ratio of the brush.
 
505
 
 
506
</simpara></listitem></varlistentry>
 
507
</variablelist><para role="since">Since  GIMP 2.4
 
508
</para></refsect2>
 
509
<refsect2>
 
510
<title><anchor id="gimp-brush-set-aspect-ratio" role="function" condition="since:GIMP 2.4"/>gimp_brush_set_aspect_ratio ()</title>
 
511
<indexterm role="GIMP 2.4"><primary>gimp_brush_set_aspect_ratio</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_brush_set_aspect_ratio         (const <link linkend="gchar">gchar</link> *name,
 
512
                                                         <link linkend="gdouble">gdouble</link> aspect_ratio_in);</programlisting>
 
513
<para>
 
514
Set the aspect ratio of a generated brush.
 
515
</para>
 
516
<para>
 
517
This procedure sets the aspect ratio for a generated brush. If
 
518
called for any other type of brush, it does not succeed.</para>
 
519
<para>
 
520
 
 
521
</para><variablelist role="params">
 
522
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
523
<listitem><simpara> The brush name.
 
524
</simpara></listitem></varlistentry>
 
525
<varlistentry><term><parameter>aspect_ratio_in</parameter>&nbsp;:</term>
 
526
<listitem><simpara> The desired brush aspect ratio.
 
527
</simpara></listitem></varlistentry>
 
528
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The brush aspect ratio actually assigned.
 
529
 
 
530
</simpara></listitem></varlistentry>
 
531
</variablelist><para role="since">Since  GIMP 2.4
 
532
</para></refsect2>
 
533
<refsect2>
 
534
<title><anchor id="gimp-brush-get-hardness" role="function" condition="since:GIMP 2.4"/>gimp_brush_get_hardness ()</title>
 
535
<indexterm role="GIMP 2.4"><primary>gimp_brush_get_hardness</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_brush_get_hardness             (const <link linkend="gchar">gchar</link> *name);</programlisting>
 
536
<para>
 
537
Get the hardness of a generated brush.
 
538
</para>
 
539
<para>
 
540
This procedure gets the hardness of a generated brush. The hardness
 
541
of a brush is the amount its intensity fades at the outside edge. If
 
542
called for any other type of brush, the function does not succeed.</para>
 
543
<para>
 
544
 
 
545
</para><variablelist role="params">
 
546
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
547
<listitem><simpara> The brush name.
 
548
</simpara></listitem></varlistentry>
 
549
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The hardness of the brush.
 
550
 
 
551
</simpara></listitem></varlistentry>
 
552
</variablelist><para role="since">Since  GIMP 2.4
 
553
</para></refsect2>
 
554
<refsect2>
 
555
<title><anchor id="gimp-brush-set-hardness" role="function" condition="since:GIMP 2.4"/>gimp_brush_set_hardness ()</title>
 
556
<indexterm role="GIMP 2.4"><primary>gimp_brush_set_hardness</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             gimp_brush_set_hardness             (const <link linkend="gchar">gchar</link> *name,
 
557
                                                         <link linkend="gdouble">gdouble</link> hardness_in);</programlisting>
 
558
<para>
 
559
Set the hardness of a generated brush.
 
560
</para>
 
561
<para>
 
562
This procedure sets the hardness for a generated brush. If called
 
563
for any other type of brush, it does not succeed.</para>
 
564
<para>
 
565
 
 
566
</para><variablelist role="params">
 
567
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
568
<listitem><simpara> The brush name.
 
569
</simpara></listitem></varlistentry>
 
570
<varlistentry><term><parameter>hardness_in</parameter>&nbsp;:</term>
 
571
<listitem><simpara> The desired brush hardness.
 
572
</simpara></listitem></varlistentry>
 
573
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The brush hardness actually assigned.
 
574
 
 
575
</simpara></listitem></varlistentry>
 
576
</variablelist><para role="since">Since  GIMP 2.4
 
577
</para></refsect2>
 
578
<refsect2>
 
579
<title><anchor id="gimp-brush-is-generated" role="function" condition="since:GIMP 2.4"/>gimp_brush_is_generated ()</title>
 
580
<indexterm role="GIMP 2.4"><primary>gimp_brush_is_generated</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_brush_is_generated             (const <link linkend="gchar">gchar</link> *name);</programlisting>
 
581
<para>
 
582
Tests if brush is generated
 
583
</para>
 
584
<para>
 
585
Returns TRUE if this brush is parametric, FALSE for other types</para>
 
586
<para>
 
587
 
 
588
</para><variablelist role="params">
 
589
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
590
<listitem><simpara> The brush name.
 
591
</simpara></listitem></varlistentry>
 
592
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if the brush is generated.
 
593
 
 
594
</simpara></listitem></varlistentry>
 
595
</variablelist><para role="since">Since  GIMP 2.4
 
596
</para></refsect2>
 
597
<refsect2>
 
598
<title><anchor id="gimp-brush-is-editable" role="function" condition="since:GIMP 2.4"/>gimp_brush_is_editable ()</title>
 
599
<indexterm role="GIMP 2.4"><primary>gimp_brush_is_editable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_brush_is_editable              (const <link linkend="gchar">gchar</link> *name);</programlisting>
 
600
<para>
 
601
Tests if brush can be edited
 
602
</para>
 
603
<para>
 
604
Returns TRUE if you have permission to change the brush</para>
 
605
<para>
 
606
 
 
607
</para><variablelist role="params">
 
608
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
609
<listitem><simpara> The brush name.
 
610
</simpara></listitem></varlistentry>
 
611
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if the brush can be edited.
 
612
 
 
613
</simpara></listitem></varlistentry>
 
614
</variablelist><para role="since">Since  GIMP 2.4
284
615
</para></refsect2>
285
616
 
286
617
</refsect1>