~ubuntu-branches/debian/squeeze/librsvg/squeeze

« back to all changes in this revision

Viewing changes to doc/html/rsvg-GdkPixbuf.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2010-05-01 14:23:09 UTC
  • mfrom: (1.1.22 upstream) (25.1.2 sid)
  • Revision ID: james.westby@ubuntu.com-20100501142309-f0otyldu6gyratt9
Tags: 2.26.3-1
New upstream bugfix release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>Rendering SVGs with GdkPixbuf</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
 
<link rel="start" href="index.html" title="RSVG Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
 
7
<link rel="home" href="index.html" title="RSVG Reference Manual">
8
8
<link rel="up" href="pt04.html" title="Part IV.  Using RSVG with GdkPixbuf">
9
9
<link rel="prev" href="pt04.html" title="Part IV.  Using RSVG with GdkPixbuf">
10
10
<link rel="next" href="ix01.html" title="Index">
11
 
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="rsvg.html" title="Part I. RSVG Overview">
14
14
<link rel="part" href="pt02.html" title="Part II.  Using RSVG">
25
25
<th width="100%" align="center">RSVG Reference Manual</th>
26
26
<td><a accesskey="n" href="ix01.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
27
27
</tr>
28
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#rsvg-GdkPixbuf.synopsis" class="shortcut">Top</a>
29
 
                   | 
30
 
                  <a href="#rsvg-GdkPixbuf.description" class="shortcut">Description</a></nobr></td></tr>
 
28
<tr><td colspan="5" class="shortcuts">
 
29
<a href="#rsvg-GdkPixbuf.synopsis" class="shortcut">Top</a>
 
30
                 | 
 
31
                <a href="#rsvg-GdkPixbuf.description" class="shortcut">Description</a>
 
32
</td></tr>
31
33
</table>
32
 
<div class="refentry" lang="en">
 
34
<div class="refentry" title="Rendering SVGs with GdkPixbuf">
33
35
<a name="rsvg-GdkPixbuf"></a><div class="titlepage"></div>
34
36
<div class="refnamediv"><table width="100%"><tr>
35
37
<td valign="top">
40
42
</td>
41
43
<td valign="top" align="right"></td>
42
44
</tr></table></div>
43
 
<div class="refsynopsisdiv">
 
45
<div class="refsynopsisdiv" title="Synopsis">
44
46
<a name="rsvg-GdkPixbuf.synopsis"></a><h2>Synopsis</h2>
45
47
<pre class="synopsis">
46
 
GdkPixbuf*          <a class="link" href="rsvg-GdkPixbuf.html#rsvg-handle-get-pixbuf" title="rsvg_handle_get_pixbuf ()">rsvg_handle_get_pixbuf</a>              (RsvgHandle *handle);
47
 
GdkPixbuf*          <a class="link" href="rsvg-GdkPixbuf.html#rsvg-handle-get-pixbuf-sub" title="rsvg_handle_get_pixbuf_sub ()">rsvg_handle_get_pixbuf_sub</a>          (RsvgHandle *handle,
 
48
<a
 
49
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
50
>GdkPixbuf</a> *         <a class="link" href="rsvg-GdkPixbuf.html#rsvg-handle-get-pixbuf" title="rsvg_handle_get_pixbuf ()">rsvg_handle_get_pixbuf</a>              (RsvgHandle *handle);
 
51
<a
 
52
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
53
>GdkPixbuf</a> *         <a class="link" href="rsvg-GdkPixbuf.html#rsvg-handle-get-pixbuf-sub" title="rsvg_handle_get_pixbuf_sub ()">rsvg_handle_get_pixbuf_sub</a>          (RsvgHandle *handle,
48
54
                                                         const char *id);
49
 
GdkPixbuf*          <a class="link" href="rsvg-GdkPixbuf.html#rsvg-pixbuf-from-file" title="rsvg_pixbuf_from_file ()">rsvg_pixbuf_from_file</a>               (const gchar *file_name,
50
 
                                                         GError **error);
51
 
GdkPixbuf*          <a class="link" href="rsvg-GdkPixbuf.html#rsvg-pixbuf-from-file-at-zoom" title="rsvg_pixbuf_from_file_at_zoom ()">rsvg_pixbuf_from_file_at_zoom</a>       (const gchar *file_name,
52
 
                                                         double x_zoom,
53
 
                                                         double y_zoom,
54
 
                                                         GError **error);
55
 
GdkPixbuf*          <a class="link" href="rsvg-GdkPixbuf.html#rsvg-pixbuf-from-file-at-size" title="rsvg_pixbuf_from_file_at_size ()">rsvg_pixbuf_from_file_at_size</a>       (const gchar *file_name,
56
 
                                                         gint width,
57
 
                                                         gint height,
58
 
                                                         GError **error);
59
 
GdkPixbuf*          <a class="link" href="rsvg-GdkPixbuf.html#rsvg-pixbuf-from-file-at-max-size" title="rsvg_pixbuf_from_file_at_max_size ()">rsvg_pixbuf_from_file_at_max_size</a>   (const gchar *file_name,
60
 
                                                         gint max_width,
61
 
                                                         gint max_height,
62
 
                                                         GError **error);
63
 
GdkPixbuf*          <a class="link" href="rsvg-GdkPixbuf.html#rsvg-pixbuf-from-file-at-zoom-with-max" title="rsvg_pixbuf_from_file_at_zoom_with_max ()">rsvg_pixbuf_from_file_at_zoom_with_max</a>
64
 
                                                        (const gchar *file_name,
65
 
                                                         double x_zoom,
66
 
                                                         double y_zoom,
67
 
                                                         gint max_width,
68
 
                                                         gint max_height,
69
 
                                                         GError **error);
 
55
<a
 
56
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
57
>GdkPixbuf</a> *         <a class="link" href="rsvg-GdkPixbuf.html#rsvg-pixbuf-from-file" title="rsvg_pixbuf_from_file ()">rsvg_pixbuf_from_file</a>               (const <a
 
58
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
59
>gchar</a> *file_name,
 
60
                                                         <a
 
61
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
 
62
>GError</a> **error);
 
63
<a
 
64
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
65
>GdkPixbuf</a> *         <a class="link" href="rsvg-GdkPixbuf.html#rsvg-pixbuf-from-file-at-zoom" title="rsvg_pixbuf_from_file_at_zoom ()">rsvg_pixbuf_from_file_at_zoom</a>       (const <a
 
66
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
67
>gchar</a> *file_name,
 
68
                                                         double x_zoom,
 
69
                                                         double y_zoom,
 
70
                                                         <a
 
71
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
 
72
>GError</a> **error);
 
73
<a
 
74
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
75
>GdkPixbuf</a> *         <a class="link" href="rsvg-GdkPixbuf.html#rsvg-pixbuf-from-file-at-size" title="rsvg_pixbuf_from_file_at_size ()">rsvg_pixbuf_from_file_at_size</a>       (const <a
 
76
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
77
>gchar</a> *file_name,
 
78
                                                         <a
 
79
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 
80
>gint</a> width,
 
81
                                                         <a
 
82
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 
83
>gint</a> height,
 
84
                                                         <a
 
85
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
 
86
>GError</a> **error);
 
87
<a
 
88
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
89
>GdkPixbuf</a> *         <a class="link" href="rsvg-GdkPixbuf.html#rsvg-pixbuf-from-file-at-max-size" title="rsvg_pixbuf_from_file_at_max_size ()">rsvg_pixbuf_from_file_at_max_size</a>   (const <a
 
90
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
91
>gchar</a> *file_name,
 
92
                                                         <a
 
93
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 
94
>gint</a> max_width,
 
95
                                                         <a
 
96
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 
97
>gint</a> max_height,
 
98
                                                         <a
 
99
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
 
100
>GError</a> **error);
 
101
<a
 
102
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
103
>GdkPixbuf</a> *         <a class="link" href="rsvg-GdkPixbuf.html#rsvg-pixbuf-from-file-at-zoom-with-max" title="rsvg_pixbuf_from_file_at_zoom_with_max ()">rsvg_pixbuf_from_file_at_zoom_with_max</a>
 
104
                                                        (const <a
 
105
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
106
>gchar</a> *file_name,
 
107
                                                         double x_zoom,
 
108
                                                         double y_zoom,
 
109
                                                         <a
 
110
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 
111
>gint</a> max_width,
 
112
                                                         <a
 
113
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 
114
>gint</a> max_height,
 
115
                                                         <a
 
116
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
 
117
>GError</a> **error);
70
118
</pre>
71
119
</div>
72
 
<div class="refsect1" lang="en">
 
120
<div class="refsect1" title="Description">
73
121
<a name="rsvg-GdkPixbuf.description"></a><h2>Description</h2>
74
122
<p>
75
123
GdkPixbuf is a library for image loading and manipulation. It is part of the cross-platform GTK+ widget toolkit.
76
124
</p>
77
125
</div>
78
 
<div class="refsect1" lang="en">
 
126
<div class="refsect1" title="Details">
79
127
<a name="rsvg-GdkPixbuf.details"></a><h2>Details</h2>
80
 
<div class="refsect2" lang="en">
 
128
<div class="refsect2" title="rsvg_handle_get_pixbuf ()">
81
129
<a name="rsvg-handle-get-pixbuf"></a><h3>rsvg_handle_get_pixbuf ()</h3>
82
 
<pre class="programlisting">GdkPixbuf*          rsvg_handle_get_pixbuf              (RsvgHandle *handle);</pre>
 
130
<pre class="programlisting"><a
 
131
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
132
>GdkPixbuf</a> *         rsvg_handle_get_pixbuf              (RsvgHandle *handle);</pre>
83
133
<p>
84
134
Returns the pixbuf loaded by <span class="type">handle</span>.  The pixbuf returned will be reffed, so
85
135
the caller of this function must assume that ref.  If insufficient data has
87
137
will be returned.  Note that the pixbuf may not be complete until
88
138
<em class="parameter"><code>rsvg_handle_close</code></em> has been called.</p>
89
139
<p>
90
 
 
91
140
</p>
92
141
<div class="variablelist"><table border="0">
93
142
<col align="left" valign="top">
106
155
</table></div>
107
156
</div>
108
157
<hr>
109
 
<div class="refsect2" lang="en">
 
158
<div class="refsect2" title="rsvg_handle_get_pixbuf_sub ()">
110
159
<a name="rsvg-handle-get-pixbuf-sub"></a><h3>rsvg_handle_get_pixbuf_sub ()</h3>
111
 
<pre class="programlisting">GdkPixbuf*          rsvg_handle_get_pixbuf_sub          (RsvgHandle *handle,
 
160
<pre class="programlisting"><a
 
161
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
162
>GdkPixbuf</a> *         rsvg_handle_get_pixbuf_sub          (RsvgHandle *handle,
112
163
                                                         const char *id);</pre>
113
164
<p>
114
165
Returns the pixbuf loaded by <span class="type">handle</span>.  The pixbuf returned will be reffed, so
117
168
will be returned.  Note that the pixbuf may not be complete until
118
169
<em class="parameter"><code>rsvg_handle_close</code></em> has been called.</p>
119
170
<p>
120
 
 
121
171
</p>
122
172
<div class="variablelist"><table border="0">
123
173
<col align="left" valign="top">
142
192
</tr>
143
193
</tbody>
144
194
</table></div>
145
 
<p class="since">Since  2.14
146
 
</p>
 
195
<p class="since">Since 2.14</p>
147
196
</div>
148
197
<hr>
149
 
<div class="refsect2" lang="en">
 
198
<div class="refsect2" title="rsvg_pixbuf_from_file ()">
150
199
<a name="rsvg-pixbuf-from-file"></a><h3>rsvg_pixbuf_from_file ()</h3>
151
 
<pre class="programlisting">GdkPixbuf*          rsvg_pixbuf_from_file               (const gchar *file_name,
152
 
                                                         GError **error);</pre>
153
 
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
200
<pre class="programlisting"><a
 
201
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
202
>GdkPixbuf</a> *         rsvg_pixbuf_from_file               (const <a
 
203
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
204
>gchar</a> *file_name,
 
205
                                                         <a
 
206
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
 
207
>GError</a> **error);</pre>
 
208
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
154
209
<h3 class="title">Warning</h3>
155
210
<p><code class="literal">rsvg_pixbuf_from_file</code> is deprecated and should not be used in newly-written code. Set up a cairo matrix and use <a class="link" href="rsvg-Core-API.html#rsvg-handle-new-from-file" title="rsvg_handle_new_from_file ()"><code class="function">rsvg_handle_new_from_file()</code></a> + <a class="link" href="rsvg-Cairo.html#rsvg-handle-render-cairo" title="rsvg_handle_render_cairo ()"><code class="function">rsvg_handle_render_cairo()</code></a> instead.</p>
156
211
</div>
157
212
<p>
158
 
Loads a new <span class="type">GdkPixbuf</span> from <em class="parameter"><code>file_name</code></em> and returns it.  The caller must
 
213
Loads a new <a
 
214
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
215
><span class="type">GdkPixbuf</span></a> from <em class="parameter"><code>file_name</code></em> and returns it.  The caller must
159
216
assume the reference to the reurned pixbuf. If an error occurred, <em class="parameter"><code>error</code></em> is
160
217
set and <code class="literal">NULL</code> is returned.</p>
161
218
<p>
162
 
 
163
219
</p>
164
220
<div class="variablelist"><table border="0">
165
221
<col align="left" valign="top">
176
232
</tr>
177
233
<tr>
178
234
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
179
 
<td> A newly allocated <span class="type">GdkPixbuf</span>, or <code class="literal">NULL</code>
 
235
<td> A newly allocated <a
 
236
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
237
><span class="type">GdkPixbuf</span></a>, or <code class="literal">NULL</code>
180
238
</td>
181
239
</tr>
182
240
</tbody>
183
241
</table></div>
184
242
</div>
185
243
<hr>
186
 
<div class="refsect2" lang="en">
 
244
<div class="refsect2" title="rsvg_pixbuf_from_file_at_zoom ()">
187
245
<a name="rsvg-pixbuf-from-file-at-zoom"></a><h3>rsvg_pixbuf_from_file_at_zoom ()</h3>
188
 
<pre class="programlisting">GdkPixbuf*          rsvg_pixbuf_from_file_at_zoom       (const gchar *file_name,
 
246
<pre class="programlisting"><a
 
247
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
248
>GdkPixbuf</a> *         rsvg_pixbuf_from_file_at_zoom       (const <a
 
249
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
250
>gchar</a> *file_name,
189
251
                                                         double x_zoom,
190
252
                                                         double y_zoom,
191
 
                                                         GError **error);</pre>
192
 
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
253
                                                         <a
 
254
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
 
255
>GError</a> **error);</pre>
 
256
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
193
257
<h3 class="title">Warning</h3>
194
258
<p><code class="literal">rsvg_pixbuf_from_file_at_zoom</code> is deprecated and should not be used in newly-written code. Set up a cairo matrix and use <a class="link" href="rsvg-Core-API.html#rsvg-handle-new-from-file" title="rsvg_handle_new_from_file ()"><code class="function">rsvg_handle_new_from_file()</code></a> + <a class="link" href="rsvg-Cairo.html#rsvg-handle-render-cairo" title="rsvg_handle_render_cairo ()"><code class="function">rsvg_handle_render_cairo()</code></a> instead.</p>
195
259
</div>
196
260
<p>
197
 
Loads a new <span class="type">GdkPixbuf</span> from <em class="parameter"><code>file_name</code></em> and returns it.  This pixbuf is scaled
 
261
Loads a new <a
 
262
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
263
><span class="type">GdkPixbuf</span></a> from <em class="parameter"><code>file_name</code></em> and returns it.  This pixbuf is scaled
198
264
from the size indicated by the file by a factor of <em class="parameter"><code>x_zoom</code></em> and <em class="parameter"><code>y_zoom</code></em>.  The
199
265
caller must assume the reference to the returned pixbuf. If an error
200
266
occurred, <em class="parameter"><code>error</code></em> is set and <code class="literal">NULL</code> is returned.</p>
201
267
<p>
202
 
 
203
268
</p>
204
269
<div class="variablelist"><table border="0">
205
270
<col align="left" valign="top">
226
291
</tr>
227
292
<tr>
228
293
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
229
 
<td> A newly allocated <span class="type">GdkPixbuf</span>, or <code class="literal">NULL</code>
 
294
<td> A newly allocated <a
 
295
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
296
><span class="type">GdkPixbuf</span></a>, or <code class="literal">NULL</code>
230
297
</td>
231
298
</tr>
232
299
</tbody>
233
300
</table></div>
234
301
</div>
235
302
<hr>
236
 
<div class="refsect2" lang="en">
 
303
<div class="refsect2" title="rsvg_pixbuf_from_file_at_size ()">
237
304
<a name="rsvg-pixbuf-from-file-at-size"></a><h3>rsvg_pixbuf_from_file_at_size ()</h3>
238
 
<pre class="programlisting">GdkPixbuf*          rsvg_pixbuf_from_file_at_size       (const gchar *file_name,
239
 
                                                         gint width,
240
 
                                                         gint height,
241
 
                                                         GError **error);</pre>
242
 
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
305
<pre class="programlisting"><a
 
306
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
307
>GdkPixbuf</a> *         rsvg_pixbuf_from_file_at_size       (const <a
 
308
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
309
>gchar</a> *file_name,
 
310
                                                         <a
 
311
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 
312
>gint</a> width,
 
313
                                                         <a
 
314
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 
315
>gint</a> height,
 
316
                                                         <a
 
317
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
 
318
>GError</a> **error);</pre>
 
319
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
243
320
<h3 class="title">Warning</h3>
244
321
<p><code class="literal">rsvg_pixbuf_from_file_at_size</code> is deprecated and should not be used in newly-written code. Set up a cairo matrix and use <a class="link" href="rsvg-Core-API.html#rsvg-handle-new-from-file" title="rsvg_handle_new_from_file ()"><code class="function">rsvg_handle_new_from_file()</code></a> + <a class="link" href="rsvg-Cairo.html#rsvg-handle-render-cairo" title="rsvg_handle_render_cairo ()"><code class="function">rsvg_handle_render_cairo()</code></a> instead.</p>
245
322
</div>
246
323
<p>
247
 
Loads a new <span class="type">GdkPixbuf</span> from <em class="parameter"><code>file_name</code></em> and returns it.  This pixbuf is scaled
 
324
Loads a new <a
 
325
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
326
><span class="type">GdkPixbuf</span></a> from <em class="parameter"><code>file_name</code></em> and returns it.  This pixbuf is scaled
248
327
from the size indicated to the new size indicated by <em class="parameter"><code>width</code></em> and <em class="parameter"><code>height</code></em>.  If
249
328
either of these are -1, then the default size of the image being loaded is
250
329
used.  The caller must assume the reference to the returned pixbuf. If an
251
330
error occurred, <em class="parameter"><code>error</code></em> is set and <code class="literal">NULL</code> is returned.</p>
252
331
<p>
253
 
 
254
332
</p>
255
333
<div class="variablelist"><table border="0">
256
334
<col align="left" valign="top">
277
355
</tr>
278
356
<tr>
279
357
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
280
 
<td> A newly allocated <span class="type">GdkPixbuf</span>, or <code class="literal">NULL</code>
 
358
<td> A newly allocated <a
 
359
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
360
><span class="type">GdkPixbuf</span></a>, or <code class="literal">NULL</code>
281
361
</td>
282
362
</tr>
283
363
</tbody>
284
364
</table></div>
285
365
</div>
286
366
<hr>
287
 
<div class="refsect2" lang="en">
 
367
<div class="refsect2" title="rsvg_pixbuf_from_file_at_max_size ()">
288
368
<a name="rsvg-pixbuf-from-file-at-max-size"></a><h3>rsvg_pixbuf_from_file_at_max_size ()</h3>
289
 
<pre class="programlisting">GdkPixbuf*          rsvg_pixbuf_from_file_at_max_size   (const gchar *file_name,
290
 
                                                         gint max_width,
291
 
                                                         gint max_height,
292
 
                                                         GError **error);</pre>
293
 
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
369
<pre class="programlisting"><a
 
370
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
371
>GdkPixbuf</a> *         rsvg_pixbuf_from_file_at_max_size   (const <a
 
372
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
373
>gchar</a> *file_name,
 
374
                                                         <a
 
375
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 
376
>gint</a> max_width,
 
377
                                                         <a
 
378
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 
379
>gint</a> max_height,
 
380
                                                         <a
 
381
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
 
382
>GError</a> **error);</pre>
 
383
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
294
384
<h3 class="title">Warning</h3>
295
385
<p><code class="literal">rsvg_pixbuf_from_file_at_max_size</code> is deprecated and should not be used in newly-written code. Set up a cairo matrix and use <a class="link" href="rsvg-Core-API.html#rsvg-handle-new-from-file" title="rsvg_handle_new_from_file ()"><code class="function">rsvg_handle_new_from_file()</code></a> + <a class="link" href="rsvg-Cairo.html#rsvg-handle-render-cairo" title="rsvg_handle_render_cairo ()"><code class="function">rsvg_handle_render_cairo()</code></a> instead.</p>
296
386
</div>
297
387
<p>
298
 
Loads a new <span class="type">GdkPixbuf</span> from <em class="parameter"><code>file_name</code></em> and returns it.  This pixbuf is uniformly
 
388
Loads a new <a
 
389
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
390
><span class="type">GdkPixbuf</span></a> from <em class="parameter"><code>file_name</code></em> and returns it.  This pixbuf is uniformly
299
391
scaled so that the it fits into a rectangle of size max_width * max_height. The
300
392
caller must assume the reference to the returned pixbuf. If an error occurred,
301
393
<em class="parameter"><code>error</code></em> is set and <code class="literal">NULL</code> is returned.</p>
302
394
<p>
303
 
 
304
395
</p>
305
396
<div class="variablelist"><table border="0">
306
397
<col align="left" valign="top">
327
418
</tr>
328
419
<tr>
329
420
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
330
 
<td> A newly allocated <span class="type">GdkPixbuf</span>, or <code class="literal">NULL</code>
 
421
<td> A newly allocated <a
 
422
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
423
><span class="type">GdkPixbuf</span></a>, or <code class="literal">NULL</code>
331
424
</td>
332
425
</tr>
333
426
</tbody>
334
427
</table></div>
335
428
</div>
336
429
<hr>
337
 
<div class="refsect2" lang="en">
 
430
<div class="refsect2" title="rsvg_pixbuf_from_file_at_zoom_with_max ()">
338
431
<a name="rsvg-pixbuf-from-file-at-zoom-with-max"></a><h3>rsvg_pixbuf_from_file_at_zoom_with_max ()</h3>
339
 
<pre class="programlisting">GdkPixbuf*          rsvg_pixbuf_from_file_at_zoom_with_max
340
 
                                                        (const gchar *file_name,
 
432
<pre class="programlisting"><a
 
433
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
434
>GdkPixbuf</a> *         rsvg_pixbuf_from_file_at_zoom_with_max
 
435
                                                        (const <a
 
436
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
437
>gchar</a> *file_name,
341
438
                                                         double x_zoom,
342
439
                                                         double y_zoom,
343
 
                                                         gint max_width,
344
 
                                                         gint max_height,
345
 
                                                         GError **error);</pre>
346
 
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
440
                                                         <a
 
441
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 
442
>gint</a> max_width,
 
443
                                                         <a
 
444
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 
445
>gint</a> max_height,
 
446
                                                         <a
 
447
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
 
448
>GError</a> **error);</pre>
 
449
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
347
450
<h3 class="title">Warning</h3>
348
451
<p><code class="literal">rsvg_pixbuf_from_file_at_zoom_with_max</code> is deprecated and should not be used in newly-written code. Set up a cairo matrix and use <a class="link" href="rsvg-Core-API.html#rsvg-handle-new-from-file" title="rsvg_handle_new_from_file ()"><code class="function">rsvg_handle_new_from_file()</code></a> + <a class="link" href="rsvg-Cairo.html#rsvg-handle-render-cairo" title="rsvg_handle_render_cairo ()"><code class="function">rsvg_handle_render_cairo()</code></a> instead.</p>
349
452
</div>
350
453
<p>
351
 
Loads a new <span class="type">GdkPixbuf</span> from <em class="parameter"><code>file_name</code></em> and returns it.  This pixbuf is scaled
 
454
Loads a new <a
 
455
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
456
><span class="type">GdkPixbuf</span></a> from <em class="parameter"><code>file_name</code></em> and returns it.  This pixbuf is scaled
352
457
from the size indicated by the file by a factor of <em class="parameter"><code>x_zoom</code></em> and <em class="parameter"><code>y_zoom</code></em>. If the
353
458
resulting pixbuf would be larger than max_width/max_heigh it is uniformly scaled
354
459
down to fit in that rectangle. The caller must assume the reference to the
355
460
returned pixbuf. If an error occurred, <em class="parameter"><code>error</code></em> is set and <code class="literal">NULL</code> is returned.</p>
356
461
<p>
357
 
 
358
462
</p>
359
463
<div class="variablelist"><table border="0">
360
464
<col align="left" valign="top">
391
495
</tr>
392
496
<tr>
393
497
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
394
 
<td> A newly allocated <span class="type">GdkPixbuf</span>, or <code class="literal">NULL</code>
 
498
<td> A newly allocated <a
 
499
href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
 
500
><span class="type">GdkPixbuf</span></a>, or <code class="literal">NULL</code>
395
501
</td>
396
502
</tr>
397
503
</tbody>
401
507
</div>
402
508
<div class="footer">
403
509
<hr>
404
 
          Generated by GTK-Doc V1.10</div>
 
510
          Generated by GTK-Doc V1.11</div>
405
511
</body>
406
512
</html>