libexo-1-dev 0.10.7-1 / usr / share / gtk-doc / html / exo-1 / exo-Extensions-to-gdk-pixbuf.html

This file is indexed.

/usr/share/gtk-doc/html/exo-1/exo-Extensions-to-gdk-pixbuf.html is in libexo-1-dev 0.10.7-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Extensions to gdk-pixbuf: Exo Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Exo Reference Manual">
<link rel="up" href="exo-extensions.html" title="Part VI. Extensions to existing frameworks">
<link rel="prev" href="exo-extensions.html" title="Part VI. Extensions to existing frameworks">
<link rel="next" href="exo-Extensions-to-GObject.html" title="Extensions to GObject">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#exo-Extensions-to-gdk-pixbuf.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="exo-extensions.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="exo-extensions.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="exo-Extensions-to-GObject.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="exo-Extensions-to-gdk-pixbuf"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="exo-Extensions-to-gdk-pixbuf.top_of_page"></a>Extensions to gdk-pixbuf</span></h2>
<p>Extensions to gdk-pixbuf — Miscelleanous extensions to the gdk-pixbuf library</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="exo-Extensions-to-gdk-pixbuf.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GdkPixbuf</span> *
</td>
<td class="function_name">
<a class="link" href="exo-Extensions-to-gdk-pixbuf.html#exo-gdk-pixbuf-colorize" title="exo_gdk_pixbuf_colorize ()">exo_gdk_pixbuf_colorize</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkPixbuf</span> *
</td>
<td class="function_name">
<a class="link" href="exo-Extensions-to-gdk-pixbuf.html#exo-gdk-pixbuf-frame" title="exo_gdk_pixbuf_frame ()">exo_gdk_pixbuf_frame</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkPixbuf</span> *
</td>
<td class="function_name">
<a class="link" href="exo-Extensions-to-gdk-pixbuf.html#exo-gdk-pixbuf-lucent" title="exo_gdk_pixbuf_lucent ()">exo_gdk_pixbuf_lucent</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkPixbuf</span> *
</td>
<td class="function_name">
<a class="link" href="exo-Extensions-to-gdk-pixbuf.html#exo-gdk-pixbuf-spotlight" title="exo_gdk_pixbuf_spotlight ()">exo_gdk_pixbuf_spotlight</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkPixbuf</span> *
</td>
<td class="function_name">
<a class="link" href="exo-Extensions-to-gdk-pixbuf.html#exo-gdk-pixbuf-scale-down" title="exo_gdk_pixbuf_scale_down ()">exo_gdk_pixbuf_scale_down</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkPixbuf</span> *
</td>
<td class="function_name">
<a class="link" href="exo-Extensions-to-gdk-pixbuf.html#exo-gdk-pixbuf-scale-ratio" title="exo_gdk_pixbuf_scale_ratio ()">exo_gdk_pixbuf_scale_ratio</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkPixbuf</span> *
</td>
<td class="function_name">
<a class="link" href="exo-Extensions-to-gdk-pixbuf.html#exo-gdk-pixbuf-new-from-file-at-max-size" title="exo_gdk_pixbuf_new_from_file_at_max_size ()">exo_gdk_pixbuf_new_from_file_at_max_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="exo-Extensions-to-gdk-pixbuf.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;exo/exo.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="exo-Extensions-to-gdk-pixbuf.description"></a><h2>Description</h2>
<p>This facility includes several functions to extend the basic functionality
provided by the gdk-pixbuf library.</p>
</div>
<div class="refsect1">
<a name="exo-Extensions-to-gdk-pixbuf.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="exo-gdk-pixbuf-colorize"></a><h3>exo_gdk_pixbuf_colorize ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> *
exo_gdk_pixbuf_colorize (<em class="parameter"><code>const <span class="type">GdkPixbuf</span> *source</code></em>,
                         <em class="parameter"><code>const <a href="http://developer.gnome.org/gdk2/gdk3-Colors.html#GdkColor"><span class="type">GdkColor</span></a> *color</code></em>);</pre>
<p>Creates a new <span class="type">GdkPixbuf</span> based on <em class="parameter"><code>source</code></em>
, which is
colorized to <em class="parameter"><code>color</code></em>
.</p>
<p>The caller is responsible to free the returned object
using <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when no longer needed.</p>
<div class="refsect3">
<a name="id-1.7.3.6.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>the source <span class="type">GdkPixbuf</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>the new color.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.6.2.7"></a><h4>Returns</h4>
<p> the colorized <span class="type">GdkPixbuf</span>.</p>
</div>
<p class="since">Since: 0.3.1.3</p>
</div>
<hr>
<div class="refsect2">
<a name="exo-gdk-pixbuf-frame"></a><h3>exo_gdk_pixbuf_frame ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> *
exo_gdk_pixbuf_frame (<em class="parameter"><code>const <span class="type">GdkPixbuf</span> *source</code></em>,
                      <em class="parameter"><code>const <span class="type">GdkPixbuf</span> *frame</code></em>,
                      <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> left_offset</code></em>,
                      <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> top_offset</code></em>,
                      <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> right_offset</code></em>,
                      <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> bottom_offset</code></em>);</pre>
<p>Embeds <em class="parameter"><code>source</code></em>
 in <em class="parameter"><code>frame</code></em>
 and returns the result as new <span class="type">GdkPixbuf</span>.</p>
<p>The caller is responsible to free the returned <span class="type">GdkPixbuf</span> using <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.</p>
<div class="refsect3">
<a name="id-1.7.3.6.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>the source <span class="type">GdkPixbuf</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>frame</p></td>
<td class="parameter_description"><p>the frame <span class="type">GdkPixbuf</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>left_offset</p></td>
<td class="parameter_description"><p>the left frame offset.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>top_offset</p></td>
<td class="parameter_description"><p>the top frame offset.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>right_offset</p></td>
<td class="parameter_description"><p>the right frame offset.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>bottom_offset</p></td>
<td class="parameter_description"><p>the bottom frame offset.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.6.3.7"></a><h4>Returns</h4>
<p> the framed version of <em class="parameter"><code>source</code></em>
.</p>
</div>
<p class="since">Since: 0.3.1.9</p>
</div>
<hr>
<div class="refsect2">
<a name="exo-gdk-pixbuf-lucent"></a><h3>exo_gdk_pixbuf_lucent ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> *
exo_gdk_pixbuf_lucent (<em class="parameter"><code>const <span class="type">GdkPixbuf</span> *source</code></em>,
                       <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> percent</code></em>);</pre>
<p>Returns a version of <em class="parameter"><code>source</code></em>
, whose pixels translucency is
<em class="parameter"><code>percent</code></em>
 of the original <em class="parameter"><code>source</code></em>
 pixels.</p>
<p>The caller is responsible to free the returned object
using <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when no longer needed.</p>
<div class="refsect3">
<a name="id-1.7.3.6.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>the source <span class="type">GdkPixbuf</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>percent</p></td>
<td class="parameter_description"><p>the percentage of translucency.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.6.4.7"></a><h4>Returns</h4>
<p> a translucent version of <em class="parameter"><code>source</code></em>
.</p>
</div>
<p class="since">Since: 0.3.1.3</p>
</div>
<hr>
<div class="refsect2">
<a name="exo-gdk-pixbuf-spotlight"></a><h3>exo_gdk_pixbuf_spotlight ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> *
exo_gdk_pixbuf_spotlight (<em class="parameter"><code>const <span class="type">GdkPixbuf</span> *source</code></em>);</pre>
<p>Creates a lightened version of <em class="parameter"><code>source</code></em>
, suitable for
prelit state display of icons.</p>
<p>The caller is responsible to free the returned
pixbuf using <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function"><GTKDOCLINK HREF="g-object-unref"><code class="function">g_object_unref()</code></a></code></GTKDOCLINK>.</p>
<div class="refsect3">
<a name="id-1.7.3.6.5.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>the source <span class="type">GdkPixbuf</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.6.5.7"></a><h4>Returns</h4>
<p> the lightened version of <em class="parameter"><code>source</code></em>
.</p>
</div>
<p class="since">Since: 0.3.1.3</p>
</div>
<hr>
<div class="refsect2">
<a name="exo-gdk-pixbuf-scale-down"></a><h3>exo_gdk_pixbuf_scale_down ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> *
exo_gdk_pixbuf_scale_down (<em class="parameter"><code><span class="type">GdkPixbuf</span> *source</code></em>,
                           <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> preserve_aspect_ratio</code></em>,
                           <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> dest_width</code></em>,
                           <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> dest_height</code></em>);</pre>
<p>Scales down the <em class="parameter"><code>source</code></em>
 to fit into the given <em class="parameter"><code>width</code></em>
 and
<em class="parameter"><code>height</code></em>
. If <em class="parameter"><code>aspect_ratio</code></em>
 is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> then the aspect ratio
of <em class="parameter"><code>source</code></em>
 will be preserved.</p>
<p>If <em class="parameter"><code>width</code></em>
 is larger than the width of <em class="parameter"><code>source</code></em>
 and <em class="parameter"><code>height</code></em>

is larger than the height of <em class="parameter"><code>source</code></em>
, a reference to
<em class="parameter"><code>source</code></em>
 will be returned, as it's unneccesary then to
scale down.</p>
<p>The caller is responsible to free the returned <span class="type">GdkPixbuf</span>
using <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when no longer needed.</p>
<div class="refsect3">
<a name="id-1.7.3.6.6.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>the source <span class="type">GdkPixbuf</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>preserve_aspect_ratio</p></td>
<td class="parameter_description"><p><a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to preserve aspect ratio.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dest_width</p></td>
<td class="parameter_description"><p>the max width for the result.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dest_height</p></td>
<td class="parameter_description"><p>the max height for the result.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.6.6.8"></a><h4>Returns</h4>
<p> the resulting <span class="type">GdkPixbuf</span>.</p>
</div>
<p class="since">Since: 0.3.1.1</p>
</div>
<hr>
<div class="refsect2">
<a name="exo-gdk-pixbuf-scale-ratio"></a><h3>exo_gdk_pixbuf_scale_ratio ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> *
exo_gdk_pixbuf_scale_ratio (<em class="parameter"><code><span class="type">GdkPixbuf</span> *source</code></em>,
                            <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> dest_size</code></em>);</pre>
<p>Scales <em class="parameter"><code>source</code></em>
 to <em class="parameter"><code>dest_size</code></em>
 while preserving the aspect ratio of
<em class="parameter"><code>source</code></em>
.</p>
<div class="refsect3">
<a name="id-1.7.3.6.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>The source <span class="type">GdkPixbuf</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dest_size</p></td>
<td class="parameter_description"><p>The target size in pixel.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.6.7.6"></a><h4>Returns</h4>
<p> A newly created <span class="type">GdkPixbuf</span>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="exo-gdk-pixbuf-new-from-file-at-max-size"></a><h3>exo_gdk_pixbuf_new_from_file_at_max_size ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> *
exo_gdk_pixbuf_new_from_file_at_max_size
                               (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
                                <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> max_width</code></em>,
                                <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> max_height</code></em>,
                                <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> preserve_aspect_ratio</code></em>,
                                <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Creates a new <span class="type">GdkPixbuf</span> by loading an image from the file at
<em class="parameter"><code>filename</code></em>
. The file format is detected automatically. If <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is
returned, then <em class="parameter"><code>error</code></em>
 will be set. Possible errors are in the
<span class="type">GDK_PIXBUF_ERROR</span> and <a href="https://developer.gnome.org/glib/unstable/glib-File-Utilities.html#G-FILE-ERROR:CAPS"><span class="type">G_FILE_ERROR</span></a> domains. If the image dimensions
exceed <em class="parameter"><code>max_width</code></em>
 or <em class="parameter"><code>max_height</code></em>
, the image will be scaled down to
fit into the dimensions, optionally preservingthe image's aspect
ratio. The image may still be larger, depending on the loader.</p>
<p>The advantage of using this function over
<code class="function">gdk_pixbuf_new_from_file_at_scale()</code> is that images will never be
scaled up, whichwould otherwise result in ugly images.</p>
<div class="refsect3">
<a name="id-1.7.3.6.8.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>name of the file to load, in the GLib file
name encoding.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>max_width</p></td>
<td class="parameter_description"><p>the maximum width of the loaded image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>max_height</p></td>
<td class="parameter_description"><p>the maximum height of the loaded image.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>preserve_aspect_ratio</p></td>
<td class="parameter_description"><p><a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to preserve the image's aspect ratio
while scaling to fit into <em class="parameter"><code>max_width</code></em>
and <em class="parameter"><code>max_height</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for errors or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.3.6.8.7"></a><h4>Returns</h4>
<p> a newly created <span class="type">GdkPixbuf</span> with a reference count or 1, or
<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if any of several error conditions occurred: the file
could not be opened, there was no loader for the file's format,
there was not enough memory to allocate the buffer for the
image, or the image file contained invalid data.</p>
</div>
<p class="since">Since: 0.3.1.9</p>
</div>
</div>
<div class="refsect1">
<a name="exo-Extensions-to-gdk-pixbuf.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.