← Back to branch summary

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

« back to all changes in this revision

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

  • 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/html/libgimp-gimpbuffer.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
5
<title>gimpbuffer</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
 
7
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
 
8
<link rel="up" href="libgimp-general.html" title="Functions not Related to Specific Images">
 
9
<link rel="prev" href="libgimp-gimpenums.html" title="gimpenums">
 
10
<link rel="next" href="libgimp-gimpcontext.html" title="gimpcontext">
 
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
<link rel="part" href="libgimp.html" title="Part&#160;I.&#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 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;II.&#160;GIMP User Interface Library">
 
19
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
 
20
<link rel="index" href="libgimp-index.html" title="Index">
 
21
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
 
22
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
 
23
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
 
24
</head>
 
25
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
26
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
27
<tr valign="middle">
 
28
<td><a accesskey="p" href="libgimp-gimpenums.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
29
<td><a accesskey="u" href="libgimp-general.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
30
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
31
<th width="100%" align="center">GIMP Library Reference Manual</th>
 
32
<td><a accesskey="n" href="libgimp-gimpcontext.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
33
</tr>
 
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2571405" class="shortcut">Top</a>
 
35
                  &#160;|&#160;
 
36
                  <a href="#id2559491" class="shortcut">Description</a></nobr></td></tr>
 
37
</table>
 
38
<div class="refentry" lang="en">
 
39
<a name="libgimp-gimpbuffer"></a><div class="titlepage"></div>
 
40
<div class="refnamediv"><table width="100%"><tr>
 
41
<td valign="top">
 
42
<h2>
 
43
<a name="id2571405"></a><span class="refentrytitle">gimpbuffer</span>
 
44
</h2>
 
45
<p>gimpbuffer</p>
 
46
</td>
 
47
<td valign="top" align="right"></td>
 
48
</tr></table></div>
 
49
<div class="refsynopsisdiv">
 
50
<h2>Synopsis</h2>
 
51
<pre class="synopsis">
 
52
 
 
53
 
 
54
 
 
55
gchar**             <a href="libgimp-gimpbuffer.html#gimp-buffers-get-list">gimp_buffers_get_list</a>               (const gchar *filter,
 
56
                                                         gint *num_buffers);
 
57
gchar*              <a href="libgimp-gimpbuffer.html#gimp-buffer-rename">gimp_buffer_rename</a>                  (const gchar *buffer_name,
 
58
                                                         const gchar *new_name);
 
59
gboolean            <a href="libgimp-gimpbuffer.html#gimp-buffer-delete">gimp_buffer_delete</a>                  (const gchar *buffer_name);
 
60
gint                <a href="libgimp-gimpbuffer.html#gimp-buffer-get-width">gimp_buffer_get_width</a>               (const gchar *buffer_name);
 
61
gint                <a href="libgimp-gimpbuffer.html#gimp-buffer-get-height">gimp_buffer_get_height</a>              (const gchar *buffer_name);
 
62
gint                <a href="libgimp-gimpbuffer.html#gimp-buffer-get-bytes">gimp_buffer_get_bytes</a>               (const gchar *buffer_name);
 
63
<a
 
64
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageBaseType"
 
65
>GimpImageBaseType</a>   <a href="libgimp-gimpbuffer.html#gimp-buffer-get-image-type">gimp_buffer_get_image_type</a>          (const gchar *buffer_name);
 
66
</pre>
 
67
</div>
 
68
<div class="refsect1" lang="en">
 
69
<a name="id2559491"></a><h2>Description</h2>
 
70
<p>
 
71
 
 
72
</p>
 
73
</div>
 
74
<div class="refsect1" lang="en">
 
75
<a name="id2559507"></a><h2>Details</h2>
 
76
<div class="refsect2" lang="en">
 
77
<a name="id2559517"></a><h3>
 
78
<a name="gimp-buffers-get-list"></a>gimp_buffers_get_list ()</h3>
 
79
<a class="indexterm" name="id2559531"></a><pre class="programlisting">gchar**             gimp_buffers_get_list               (const gchar *filter,
 
80
                                                         gint *num_buffers);</pre>
 
81
<p>
 
82
Retrieve a complete listing of the available buffers.
 
83
</p>
 
84
<p>
 
85
This procedure returns a complete listing of available named
 
86
buffers.</p>
 
87
<p>
 
88
 
 
89
</p>
 
90
<div class="variablelist"><table border="0">
 
91
<col align="left" valign="top">
 
92
<tbody>
 
93
<tr>
 
94
<td><span class="term"><em class="parameter"><code>filter</code></em>&#160;:</span></td>
 
95
<td> An optional regular expression used to filter the list.
 
96
</td>
 
97
</tr>
 
98
<tr>
 
99
<td><span class="term"><em class="parameter"><code>num_buffers</code></em>&#160;:</span></td>
 
100
<td> The number of buffers.
 
101
</td>
 
102
</tr>
 
103
<tr>
 
104
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
105
<td> The list of buffer names.
 
106
 
 
107
</td>
 
108
</tr>
 
109
</tbody>
 
110
</table></div>
 
111
<p class="since">Since  GIMP 2.4
 
112
</p>
 
113
</div>
 
114
<hr>
 
115
<div class="refsect2" lang="en">
 
116
<a name="id2567110"></a><h3>
 
117
<a name="gimp-buffer-rename"></a>gimp_buffer_rename ()</h3>
 
118
<a class="indexterm" name="id2567124"></a><pre class="programlisting">gchar*              gimp_buffer_rename                  (const gchar *buffer_name,
 
119
                                                         const gchar *new_name);</pre>
 
120
<p>
 
121
Renames a named buffer.
 
122
</p>
 
123
<p>
 
124
This procedure renames a named buffer.</p>
 
125
<p>
 
126
 
 
127
</p>
 
128
<div class="variablelist"><table border="0">
 
129
<col align="left" valign="top">
 
130
<tbody>
 
131
<tr>
 
132
<td><span class="term"><em class="parameter"><code>buffer_name</code></em>&#160;:</span></td>
 
133
<td> The buffer name.
 
134
</td>
 
135
</tr>
 
136
<tr>
 
137
<td><span class="term"><em class="parameter"><code>new_name</code></em>&#160;:</span></td>
 
138
<td> The buffer's new name.
 
139
</td>
 
140
</tr>
 
141
<tr>
 
142
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
143
<td> The real name given to the buffer.
 
144
 
 
145
</td>
 
146
</tr>
 
147
</tbody>
 
148
</table></div>
 
149
<p class="since">Since  GIMP 2.4
 
150
</p>
 
151
</div>
 
152
<hr>
 
153
<div class="refsect2" lang="en">
 
154
<a name="id2564874"></a><h3>
 
155
<a name="gimp-buffer-delete"></a>gimp_buffer_delete ()</h3>
 
156
<a class="indexterm" name="id2564889"></a><pre class="programlisting">gboolean            gimp_buffer_delete                  (const gchar *buffer_name);</pre>
 
157
<p>
 
158
Deletes a named buffer.
 
159
</p>
 
160
<p>
 
161
This procedure deletes a named buffer.</p>
 
162
<p>
 
163
 
 
164
</p>
 
165
<div class="variablelist"><table border="0">
 
166
<col align="left" valign="top">
 
167
<tbody>
 
168
<tr>
 
169
<td><span class="term"><em class="parameter"><code>buffer_name</code></em>&#160;:</span></td>
 
170
<td> The buffer name.
 
171
</td>
 
172
</tr>
 
173
<tr>
 
174
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
175
<td> TRUE on success.
 
176
 
 
177
</td>
 
178
</tr>
 
179
</tbody>
 
180
</table></div>
 
181
<p class="since">Since  GIMP 2.4
 
182
</p>
 
183
</div>
 
184
<hr>
 
185
<div class="refsect2" lang="en">
 
186
<a name="id2564960"></a><h3>
 
187
<a name="gimp-buffer-get-width"></a>gimp_buffer_get_width ()</h3>
 
188
<a class="indexterm" name="id2564973"></a><pre class="programlisting">gint                gimp_buffer_get_width               (const gchar *buffer_name);</pre>
 
189
<p>
 
190
Retrieves the specified buffer's width.
 
191
</p>
 
192
<p>
 
193
This procedure retrieves the specified named buffer's width.</p>
 
194
<p>
 
195
 
 
196
</p>
 
197
<div class="variablelist"><table border="0">
 
198
<col align="left" valign="top">
 
199
<tbody>
 
200
<tr>
 
201
<td><span class="term"><em class="parameter"><code>buffer_name</code></em>&#160;:</span></td>
 
202
<td> The buffer name.
 
203
</td>
 
204
</tr>
 
205
<tr>
 
206
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
207
<td> The buffer width.
 
208
 
 
209
</td>
 
210
</tr>
 
211
</tbody>
 
212
</table></div>
 
213
<p class="since">Since  GIMP 2.4
 
214
</p>
 
215
</div>
 
216
<hr>
 
217
<div class="refsect2" lang="en">
 
218
<a name="id2565045"></a><h3>
 
219
<a name="gimp-buffer-get-height"></a>gimp_buffer_get_height ()</h3>
 
220
<a class="indexterm" name="id2565059"></a><pre class="programlisting">gint                gimp_buffer_get_height              (const gchar *buffer_name);</pre>
 
221
<p>
 
222
Retrieves the specified buffer's height.
 
223
</p>
 
224
<p>
 
225
This procedure retrieves the specified named buffer's height.</p>
 
226
<p>
 
227
 
 
228
</p>
 
229
<div class="variablelist"><table border="0">
 
230
<col align="left" valign="top">
 
231
<tbody>
 
232
<tr>
 
233
<td><span class="term"><em class="parameter"><code>buffer_name</code></em>&#160;:</span></td>
 
234
<td> The buffer name.
 
235
</td>
 
236
</tr>
 
237
<tr>
 
238
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
239
<td> The buffer height.
 
240
 
 
241
</td>
 
242
</tr>
 
243
</tbody>
 
244
</table></div>
 
245
<p class="since">Since  GIMP 2.4
 
246
</p>
 
247
</div>
 
248
<hr>
 
249
<div class="refsect2" lang="en">
 
250
<a name="id2598731"></a><h3>
 
251
<a name="gimp-buffer-get-bytes"></a>gimp_buffer_get_bytes ()</h3>
 
252
<a class="indexterm" name="id2598744"></a><pre class="programlisting">gint                gimp_buffer_get_bytes               (const gchar *buffer_name);</pre>
 
253
<p>
 
254
Retrieves the specified buffer's bytes.
 
255
</p>
 
256
<p>
 
257
This procedure retrieves the specified named buffer's bytes.</p>
 
258
<p>
 
259
 
 
260
</p>
 
261
<div class="variablelist"><table border="0">
 
262
<col align="left" valign="top">
 
263
<tbody>
 
264
<tr>
 
265
<td><span class="term"><em class="parameter"><code>buffer_name</code></em>&#160;:</span></td>
 
266
<td> The buffer name.
 
267
</td>
 
268
</tr>
 
269
<tr>
 
270
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
271
<td> The buffer bpp.
 
272
 
 
273
</td>
 
274
</tr>
 
275
</tbody>
 
276
</table></div>
 
277
<p class="since">Since  GIMP 2.4
 
278
</p>
 
279
</div>
 
280
<hr>
 
281
<div class="refsect2" lang="en">
 
282
<a name="id2598816"></a><h3>
 
283
<a name="gimp-buffer-get-image-type"></a>gimp_buffer_get_image_type ()</h3>
 
284
<a class="indexterm" name="id2598830"></a><pre class="programlisting"><a
 
285
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageBaseType"
 
286
>GimpImageBaseType</a>   gimp_buffer_get_image_type          (const gchar *buffer_name);</pre>
 
287
<p>
 
288
Retrieves the specified buffer's image type.
 
289
</p>
 
290
<p>
 
291
This procedure retrieves the specified named buffer's image type.</p>
 
292
<p>
 
293
 
 
294
</p>
 
295
<div class="variablelist"><table border="0">
 
296
<col align="left" valign="top">
 
297
<tbody>
 
298
<tr>
 
299
<td><span class="term"><em class="parameter"><code>buffer_name</code></em>&#160;:</span></td>
 
300
<td> The buffer name.
 
301
</td>
 
302
</tr>
 
303
<tr>
 
304
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
305
<td> The buffer image type.
 
306
 
 
307
</td>
 
308
</tr>
 
309
</tbody>
 
310
</table></div>
 
311
<p class="since">Since  GIMP 2.4
 
312
</p>
 
313
</div>
 
314
</div>
 
315
</div>
 
316
</body>
 
317
</html>