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
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libgimp-gimpbrush">
<refmeta>
<refentrytitle role="top_of_page">gimpbrush</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpbrush</refname>
<refpurpose>Functions operating on a single brush.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="gchar">gchar</link>* <link linkend="gimp-brush-new">gimp_brush_new</link> (const <link linkend="gchar">gchar</link> *name);
<link linkend="gchar">gchar</link>* <link linkend="gimp-brush-duplicate">gimp_brush_duplicate</link> (const <link linkend="gchar">gchar</link> *name);
<link linkend="gchar">gchar</link>* <link linkend="gimp-brush-rename">gimp_brush_rename</link> (const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *new_name);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-brush-delete">gimp_brush_delete</link> (const <link linkend="gchar">gchar</link> *name);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-brush-get-info">gimp_brush_get_info</link> (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> *width,
<link linkend="gint">gint</link> *height,
<link linkend="gint">gint</link> *mask_bpp,
<link linkend="gint">gint</link> *color_bpp);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-brush-get-pixels">gimp_brush_get_pixels</link> (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> *width,
<link linkend="gint">gint</link> *height,
<link linkend="gint">gint</link> *mask_bpp,
<link linkend="gint">gint</link> *num_mask_bytes,
<link linkend="guint8">guint8</link> **mask_bytes,
<link linkend="gint">gint</link> *color_bpp,
<link linkend="gint">gint</link> *num_color_bytes,
<link linkend="guint8">guint8</link> **color_bytes);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-brush-get-spacing">gimp_brush_get_spacing</link> (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> *spacing);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-brush-set-spacing">gimp_brush_set_spacing</link> (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> spacing);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Functions operating on a single brush.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-brush-new" role="function" condition="since:GIMP 2.2"/>gimp_brush_new ()</title>
<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>
<para>
Creates a new brush
</para>
<para>
This procedure creates a new, uninitialized brush</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The requested name of the new brush.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The actual new brush name.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-brush-duplicate" role="function" condition="since:GIMP 2.2"/>gimp_brush_duplicate ()</title>
<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>
<para>
Duplicates a brush
</para>
<para>
This procedure creates an identical brush by a different name</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The brush name.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The name of the brush's copy.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-brush-rename" role="function" condition="since:GIMP 2.2"/>gimp_brush_rename ()</title>
<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,
const <link linkend="gchar">gchar</link> *new_name);</programlisting>
<para>
Rename a brush
</para>
<para>
This procedure renames a brush</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The brush name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_name</parameter> :</term>
<listitem><simpara> The new name of the brush.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The actual new name of the brush.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-brush-delete" role="function" condition="since:GIMP 2.2"/>gimp_brush_delete ()</title>
<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>
<para>
Deletes a brush
</para>
<para>
This procedure deletes a brush</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The brush name.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-brush-get-info" role="function" condition="since:GIMP 2.2"/>gimp_brush_get_info ()</title>
<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,
<link linkend="gint">gint</link> *width,
<link linkend="gint">gint</link> *height,
<link linkend="gint">gint</link> *mask_bpp,
<link linkend="gint">gint</link> *color_bpp);</programlisting>
<para>
Retrieve information about the specified brush.
</para>
<para>
This procedure retrieves information about the specified brush. This
includes the brush name, and the brush extents (width and height).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The brush name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter> :</term>
<listitem><simpara> The brush width.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter> :</term>
<listitem><simpara> The brush height.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mask_bpp</parameter> :</term>
<listitem><simpara> The brush mask bpp.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color_bpp</parameter> :</term>
<listitem><simpara> The brush color bpp.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-brush-get-pixels" role="function" condition="since:GIMP 2.2"/>gimp_brush_get_pixels ()</title>
<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,
<link linkend="gint">gint</link> *width,
<link linkend="gint">gint</link> *height,
<link linkend="gint">gint</link> *mask_bpp,
<link linkend="gint">gint</link> *num_mask_bytes,
<link linkend="guint8">guint8</link> **mask_bytes,
<link linkend="gint">gint</link> *color_bpp,
<link linkend="gint">gint</link> *num_color_bytes,
<link linkend="guint8">guint8</link> **color_bytes);</programlisting>
<para>
Retrieve information about the specified brush.
</para>
<para>
This procedure retrieves information about the specified brush. This
includes the brush extents (width and height) and its pixels data.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The brush name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter> :</term>
<listitem><simpara> The brush width.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter> :</term>
<listitem><simpara> The brush height.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mask_bpp</parameter> :</term>
<listitem><simpara> The brush mask bpp.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>num_mask_bytes</parameter> :</term>
<listitem><simpara> Length of brush mask data.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mask_bytes</parameter> :</term>
<listitem><simpara> The brush mask data.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color_bpp</parameter> :</term>
<listitem><simpara> The brush color bpp.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>num_color_bytes</parameter> :</term>
<listitem><simpara> Length of brush color data.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color_bytes</parameter> :</term>
<listitem><simpara> The brush color data.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-brush-get-spacing" role="function" condition="since:GIMP 2.2"/>gimp_brush_get_spacing ()</title>
<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,
<link linkend="gint">gint</link> *spacing);</programlisting>
<para>
Get the brush spacing.
</para>
<para>
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.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The brush name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>spacing</parameter> :</term>
<listitem><simpara> The brush spacing.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-brush-set-spacing" role="function" condition="since:GIMP 2.2"/>gimp_brush_set_spacing ()</title>
<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,
<link linkend="gint">gint</link> spacing);</programlisting>
<para>
Set the brush spacing.
</para>
<para>
This procedure modifies the spacing setting for the specified brush.
The value should be a integer between 0 and 1000.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The brush name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>spacing</parameter> :</term>
<listitem><simpara> The brush spacing.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
</refsect1>
</refentry>
|
