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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimppatterns</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-gimppattern.html" title="gimppattern">
<link rel="next" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<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-gimppattern.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-selectors.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="#id2625655" class="shortcut">Top</a>
 | 
<a href="#id2639864" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimppatterns"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2625655"></a><span class="refentrytitle">gimppatterns</span>
</h2>
<p>gimppatterns — Functions relating to patterns.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
gboolean <a href="libgimp-gimppatterns.html#gimp-patterns-refresh">gimp_patterns_refresh</a> (void);
gchar** <a href="libgimp-gimppatterns.html#gimp-patterns-get-list">gimp_patterns_get_list</a> (const gchar *filter,
gint *num_patterns);
gchar* <a href="libgimp-gimppatterns.html#gimp-patterns-get-pattern">gimp_patterns_get_pattern</a> (gint *width,
gint *height);
gboolean <a href="libgimp-gimppatterns.html#gimp-patterns-set-pattern">gimp_patterns_set_pattern</a> (const gchar *name);
gchar* <a href="libgimp-gimppatterns.html#gimp-patterns-get-pattern-data">gimp_patterns_get_pattern_data</a> (const gchar *name,
gint *width,
gint *height,
gint *mask_bpp,
gint *length,
guint8 **mask_data);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2639864"></a><h2>Description</h2>
<p>
Functions relating to patterns.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2639880"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2639890"></a><h3>
<a name="gimp-patterns-refresh"></a>gimp_patterns_refresh ()</h3>
<a class="indexterm" name="id2639901"></a><pre class="programlisting">gboolean gimp_patterns_refresh (void);</pre>
<p>
Refresh current patterns. This function always succeeds.
</p>
<p>
This procedure retrieves all patterns currently in the user's
pattern path and updates all pattern dialogs accordingly.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2639537"></a><h3>
<a name="gimp-patterns-get-list"></a>gimp_patterns_get_list ()</h3>
<a class="indexterm" name="id2639548"></a><pre class="programlisting">gchar** gimp_patterns_get_list (const gchar *filter,
gint *num_patterns);</pre>
<p>
Retrieve a complete listing of the available patterns.
</p>
<p>
This procedure returns a complete listing of available GIMP
patterns. Each name returned can be used as input to the
'gimp_context_set_pattern'.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>filter</code></em> :</span></td>
<td> An optional regular expression used to filter the list.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>num_patterns</code></em> :</span></td>
<td> The number of patterns in the pattern list.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The list of pattern names.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2639636"></a><h3>
<a name="gimp-patterns-get-pattern"></a>gimp_patterns_get_pattern ()</h3>
<a class="indexterm" name="id2639649"></a><pre class="programlisting">gchar* gimp_patterns_get_pattern (gint *width,
gint *height);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_patterns_get_pattern</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-get-pattern"><code class="function">gimp_context_get_pattern()</code></a>
instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em> :</span></td>
<td> The pattern width.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em> :</span></td>
<td> The pattern height.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The pattern name.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2640192"></a><h3>
<a name="gimp-patterns-set-pattern"></a>gimp_patterns_set_pattern ()</h3>
<a class="indexterm" name="id2640206"></a><pre class="programlisting">gboolean gimp_patterns_set_pattern (const gchar *name);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_patterns_set_pattern</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-set-pattern"><code class="function">gimp_context_set_pattern()</code></a> instead.</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 pattern 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>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2640285"></a><h3>
<a name="gimp-patterns-get-pattern-data"></a>gimp_patterns_get_pattern_data ()</h3>
<a class="indexterm" name="id2640298"></a><pre class="programlisting">gchar* gimp_patterns_get_pattern_data (const gchar *name,
gint *width,
gint *height,
gint *mask_bpp,
gint *length,
guint8 **mask_data);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_patterns_get_pattern_data</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a href="libgimp-gimppattern.html#gimp-pattern-get-pixels"><code class="function">gimp_pattern_get_pixels()</code></a> instead.</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 pattern name (\"\" means currently active pattern).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em> :</span></td>
<td> The pattern width.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em> :</span></td>
<td> The pattern height.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>mask_bpp</code></em> :</span></td>
<td> Pattern bytes per pixel.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>length</code></em> :</span></td>
<td> Length of pattern mask data.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>mask_data</code></em> :</span></td>
<td> The pattern mask data.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The pattern name.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|
