File: libgimp-gimppattern.html

package info (click to toggle)
gimp 2.2.13-1etch4
  • links: PTS
  • area: main
  • in suites: etch
  • size: 94,832 kB
  • ctags: 47,113
  • sloc: ansic: 524,858; xml: 36,798; lisp: 9,870; sh: 9,409; makefile: 7,923; python: 2,674; perl: 2,589; yacc: 520; lex: 334
file content (201 lines) | stat: -rw-r--r-- 7,098 bytes parent folder | download | duplicates (2)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimppattern</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-gimppalettes.html" title="gimppalettes">
<link rel="next" href="libgimp-gimppatterns.html" title="gimppatterns">
<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&#160;I.&#160;GIMP Constants">
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;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&#160;III.&#160;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-gimppalettes.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-gimppatterns.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="#id2570347" class="shortcut">Top</a>
                  &#160;|&#160;
                  <a href="#id2638571" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimppattern"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2570347"></a><span class="refentrytitle">gimppattern</span>
</h2>
<p>gimppattern &#8212; Functions operating on a single pattern.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">



gboolean    <a href="libgimp-gimppattern.html#gimp-pattern-get-info">gimp_pattern_get_info</a>           (const gchar *name,
                                             gint *width,
                                             gint *height,
                                             gint *bpp);
gboolean    <a href="libgimp-gimppattern.html#gimp-pattern-get-pixels">gimp_pattern_get_pixels</a>         (const gchar *name,
                                             gint *width,
                                             gint *height,
                                             gint *bpp,
                                             gint *num_color_bytes,
                                             guint8 **color_bytes);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2638571"></a><h2>Description</h2>
<p>
Functions operating on a single pattern.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2638587"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2638597"></a><h3>
<a name="gimp-pattern-get-info"></a>gimp_pattern_get_info ()</h3>
<a class="indexterm" name="id2638610"></a><pre class="programlisting">gboolean    gimp_pattern_get_info           (const gchar *name,
                                             gint *width,
                                             gint *height,
                                             gint *bpp);</pre>
<p>
Retrieve information about the specified pattern.
</p>
<p>
This procedure retrieves information about the specified pattern.
This includes the pattern 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>&#160;:</span></td>
<td> The pattern name.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td> The pattern width.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> The pattern height.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>bpp</code></em>&#160;:</span></td>
<td> The pattern bpp.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</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="id2640838"></a><h3>
<a name="gimp-pattern-get-pixels"></a>gimp_pattern_get_pixels ()</h3>
<a class="indexterm" name="id2640852"></a><pre class="programlisting">gboolean    gimp_pattern_get_pixels         (const gchar *name,
                                             gint *width,
                                             gint *height,
                                             gint *bpp,
                                             gint *num_color_bytes,
                                             guint8 **color_bytes);</pre>
<p>
Retrieve information about the specified pattern (including pixels).
</p>
<p>
This procedure retrieves information about the specified. This
includes the pattern extents (width and height), its bpp and its
pixel 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>&#160;:</span></td>
<td> The pattern name.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td> The pattern width.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> The pattern height.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>bpp</code></em>&#160;:</span></td>
<td> The pattern bpp.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>num_color_bytes</code></em>&#160;:</span></td>
<td> Number of pattern bytes.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>color_bytes</code></em>&#160;:</span></td>
<td> The pattern data.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE on success.

</td>
</tr>
</tbody>
</table></div>
<p>Since  GIMP 2.2
</p>
</div>
</div>
</div>
</body>
</html>