~ubuntu-branches/ubuntu/intrepid/libcairo/intrepid

« back to all changes in this revision

Viewing changes to doc/public/html/cairo-SVG-Surfaces.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher, Fabien Tassin
  • Date: 2007-12-21 11:46:45 UTC
  • mfrom: (1.1.17 upstream)
  • Revision ID: james.westby@ubuntu.com-20071221114645-v1bx91voavqus4uw
Tags: 1.5.4-0ubuntu1
* debian/rules:
  - updated shlibs version

[ Fabien Tassin ]
* new upstream snapshot: 1.5.4
* Drop patches no longer useful:
  - debian/patches/91_malloc-overflow-fixes.dpatch
  - debian/patches/90_from_git_fix_zero_sized_bitmap_handling.dpatch
  - debian/patches/90_from_git_fix_not_available_glyph_handling.dpatch
* Replace Ubuntu's lcd patch by patch from Freedesktop bug #10301
  - drop debian/patches/02-cairo-1.4.8-lcd-filter-2.dpatch
  - add debian/patches/02-lcd_filter_freedesktop_bug10301.patch
* Move from 16.16 to 24.8 fixed point precision
  - add debian/patches/01-fixed_point_24.8_precision.dpatch
* Add libpixman-1-dev (>= 0.9.4) to Build-deps
  - update debian/control
* Update debian/patches/00list

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=US-ASCII">
5
5
<title>SVG Surfaces</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
7
<link rel="start" href="index.html" title="Cairo: A Vector Graphics Library">
8
8
<link rel="up" href="Surfaces.html" title="Surfaces">
9
9
<link rel="prev" href="cairo-Win32-Surfaces.html" title="Win32 Surfaces">
10
10
<link rel="next" href="cairo-XLib-Surfaces.html" title="XLib Surfaces">
11
 
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="pt01.html" title="Part&#160;I.&#160;Tutorial">
14
14
<link rel="part" href="pt02.html" title="Part&#160;II.&#160;Reference">
30
30
<th width="100%" align="center">Cairo: A Vector Graphics Library</th>
31
31
<td><a accesskey="n" href="cairo-XLib-Surfaces.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
32
32
</tr>
33
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2584708" class="shortcut">Top</a>
 
33
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2623230" class="shortcut">Top</a>
34
34
                  &#160;|&#160;
35
 
                  <a href="#id2643342" class="shortcut">Description</a></nobr></td></tr>
 
35
                  <a href="#id2655251" class="shortcut">Description</a></nobr></td></tr>
36
36
</table>
37
37
<div class="refentry" lang="en">
38
38
<a name="cairo-SVG-Surfaces"></a><div class="titlepage"></div>
39
39
<div class="refnamediv"><table width="100%"><tr>
40
40
<td valign="top">
41
41
<h2>
42
 
<a name="id2584708"></a><span class="refentrytitle">SVG Surfaces</span>
 
42
<a name="id2623230"></a><span class="refentrytitle">SVG Surfaces</span>
43
43
</h2>
44
44
<p>SVG Surfaces &#8212; Rendering SVG documents</p>
45
45
</td>
51
51
 
52
52
 
53
53
 
54
 
<a href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a>*    <a href="cairo-SVG-Surfaces.html#cairo-svg-surface-create">cairo_svg_surface_create</a>            (const char *filename,
 
54
<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a>*    <a class="link" href="cairo-SVG-Surfaces.html#cairo-svg-surface-create">cairo_svg_surface_create</a>            (const char *filename,
55
55
                                                         double width_in_points,
56
56
                                                         double height_in_points);
57
 
<a href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a>*    <a href="cairo-SVG-Surfaces.html#cairo-svg-surface-create-for-stream">cairo_svg_surface_create_for_stream</a> (<a href="cairo-PNG-Support.html#cairo-write-func-t">cairo_write_func_t</a> write_func,
 
57
<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a>*    <a class="link" href="cairo-SVG-Surfaces.html#cairo-svg-surface-create-for-stream">cairo_svg_surface_create_for_stream</a> (<a class="link" href="cairo-PNG-Support.html#cairo-write-func-t">cairo_write_func_t</a> write_func,
58
58
                                                         void *closure,
59
59
                                                         double width_in_points,
60
60
                                                         double height_in_points);
61
 
void                <a href="cairo-SVG-Surfaces.html#cairo-svg-surface-restrict-to-version">cairo_svg_surface_restrict_to_version</a>
62
 
                                                        (<a href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface,
63
 
                                                         <a href="cairo-SVG-Surfaces.html#cairo-svg-version-t">cairo_svg_version_t</a> version);
64
 
enum                <a href="cairo-SVG-Surfaces.html#cairo-svg-version-t">cairo_svg_version_t</a>;
65
 
void                <a href="cairo-SVG-Surfaces.html#cairo-svg-get-versions">cairo_svg_get_versions</a>              (<a href="cairo-SVG-Surfaces.html#cairo-svg-version-t">cairo_svg_version_t</a> const **versions,
 
61
void                <a class="link" href="cairo-SVG-Surfaces.html#cairo-svg-surface-restrict-to-version">cairo_svg_surface_restrict_to_version</a>
 
62
                                                        (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface,
 
63
                                                         <a class="link" href="cairo-SVG-Surfaces.html#cairo-svg-version-t">cairo_svg_version_t</a> version);
 
64
enum                <a class="link" href="cairo-SVG-Surfaces.html#cairo-svg-version-t">cairo_svg_version_t</a>;
 
65
void                <a class="link" href="cairo-SVG-Surfaces.html#cairo-svg-get-versions">cairo_svg_get_versions</a>              (<a class="link" href="cairo-SVG-Surfaces.html#cairo-svg-version-t">cairo_svg_version_t</a> const **versions,
66
66
                                                         int *num_versions);
67
 
const char*         <a href="cairo-SVG-Surfaces.html#cairo-svg-version-to-string">cairo_svg_version_to_string</a>         (<a href="cairo-SVG-Surfaces.html#cairo-svg-version-t">cairo_svg_version_t</a> version);
 
67
const char*         <a class="link" href="cairo-SVG-Surfaces.html#cairo-svg-version-to-string">cairo_svg_version_to_string</a>         (<a class="link" href="cairo-SVG-Surfaces.html#cairo-svg-version-t">cairo_svg_version_t</a> version);
68
68
</pre>
69
69
</div>
70
70
<div class="refsect1" lang="en">
71
 
<a name="id2643342"></a><h2>Description</h2>
 
71
<a name="id2655251"></a><h2>Description</h2>
72
72
<p>
73
73
 
74
74
</p>
75
75
</div>
76
76
<div class="refsect1" lang="en">
77
 
<a name="id2643358"></a><h2>Details</h2>
 
77
<a name="id2655267"></a><h2>Details</h2>
78
78
<div class="refsect2" lang="en">
79
 
<a name="id2643368"></a><h3>
 
79
<a name="id2655278"></a><h3>
80
80
<a name="cairo-svg-surface-create"></a>cairo_svg_surface_create ()</h3>
81
 
<a class="indexterm" name="id2643382"></a><pre class="programlisting"><a href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a>*    cairo_svg_surface_create            (const char *filename,
 
81
<a class="indexterm" name="id2655291"></a><pre class="programlisting"><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a>*    cairo_svg_surface_create            (const char *filename,
82
82
                                                         double width_in_points,
83
83
                                                         double height_in_points);</pre>
84
84
<p>
91
91
<col align="left" valign="top">
92
92
<tbody>
93
93
<tr>
94
 
<td><span class="term"><em class="parameter"><code>filename</code></em>&#160;:</span></td>
 
94
<td><p><span class="term"><em class="parameter"><code>filename</code></em>&#160;:</span></p></td>
95
95
<td> a filename for the SVG output (must be writable)
96
96
</td>
97
97
</tr>
98
98
<tr>
99
 
<td><span class="term"><em class="parameter"><code>width_in_points</code></em>&#160;:</span></td>
 
99
<td><p><span class="term"><em class="parameter"><code>width_in_points</code></em>&#160;:</span></p></td>
100
100
<td> width of the surface, in points (1 point == 1/72.0 inch)
101
101
</td>
102
102
</tr>
103
103
<tr>
104
 
<td><span class="term"><em class="parameter"><code>height_in_points</code></em>&#160;:</span></td>
 
104
<td><p><span class="term"><em class="parameter"><code>height_in_points</code></em>&#160;:</span></p></td>
105
105
<td> height of the surface, in points (1 point == 1/72.0 inch)
106
106
</td>
107
107
</tr>
108
108
<tr>
109
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
109
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
110
110
<td> a pointer to the newly created surface. The caller
111
111
owns the surface and should call cairo_surface_destroy when done
112
112
with it.
113
113
 
114
114
This function always returns a valid pointer, but it will return a
115
115
pointer to a "nil" surface if an error such as out of memory
116
 
occurs. You can use <a href="cairo-cairo-surface-t.html#cairo-surface-status"><code class="function">cairo_surface_status()</code></a> to check for this.
 
116
occurs. You can use <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-status"><code class="function">cairo_surface_status()</code></a> to check for this.
117
117
 
118
118
</td>
119
119
</tr>
124
124
</div>
125
125
<hr>
126
126
<div class="refsect2" lang="en">
127
 
<a name="id2643514"></a><h3>
 
127
<a name="id2655424"></a><h3>
128
128
<a name="cairo-svg-surface-create-for-stream"></a>cairo_svg_surface_create_for_stream ()</h3>
129
 
<a class="indexterm" name="id2643528"></a><pre class="programlisting"><a href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a>*    cairo_svg_surface_create_for_stream (<a href="cairo-PNG-Support.html#cairo-write-func-t">cairo_write_func_t</a> write_func,
 
129
<a class="indexterm" name="id2655437"></a><pre class="programlisting"><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a>*    cairo_svg_surface_create_for_stream (<a class="link" href="cairo-PNG-Support.html#cairo-write-func-t">cairo_write_func_t</a> write_func,
130
130
                                                         void *closure,
131
131
                                                         double width_in_points,
132
132
                                                         double height_in_points);</pre>
140
140
<col align="left" valign="top">
141
141
<tbody>
142
142
<tr>
143
 
<td><span class="term"><em class="parameter"><code>write_func</code></em>&#160;:</span></td>
144
 
<td> a <a href="cairo-PNG-Support.html#cairo-write-func-t"><span class="type">cairo_write_func_t</span></a> to accept the output data
 
143
<td><p><span class="term"><em class="parameter"><code>write_func</code></em>&#160;:</span></p></td>
 
144
<td> a <a class="link" href="cairo-PNG-Support.html#cairo-write-func-t"><span class="type">cairo_write_func_t</span></a> to accept the output data
145
145
</td>
146
146
</tr>
147
147
<tr>
148
 
<td><span class="term"><em class="parameter"><code>closure</code></em>&#160;:</span></td>
 
148
<td><p><span class="term"><em class="parameter"><code>closure</code></em>&#160;:</span></p></td>
149
149
<td> the closure argument for <em class="parameter"><code>write_func</code></em>
150
150
</td>
151
151
</tr>
152
152
<tr>
153
 
<td><span class="term"><em class="parameter"><code>width_in_points</code></em>&#160;:</span></td>
 
153
<td><p><span class="term"><em class="parameter"><code>width_in_points</code></em>&#160;:</span></p></td>
154
154
<td> width of the surface, in points (1 point == 1/72.0 inch)
155
155
</td>
156
156
</tr>
157
157
<tr>
158
 
<td><span class="term"><em class="parameter"><code>height_in_points</code></em>&#160;:</span></td>
 
158
<td><p><span class="term"><em class="parameter"><code>height_in_points</code></em>&#160;:</span></p></td>
159
159
<td> height of the surface, in points (1 point == 1/72.0 inch)
160
160
</td>
161
161
</tr>
162
162
<tr>
163
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
163
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
164
164
<td> a pointer to the newly created surface. The caller
165
165
owns the surface and should call cairo_surface_destroy when done
166
166
with it.
167
167
 
168
168
This function always returns a valid pointer, but it will return a
169
169
pointer to a "nil" surface if an error such as out of memory
170
 
occurs. You can use <a href="cairo-cairo-surface-t.html#cairo-surface-status"><code class="function">cairo_surface_status()</code></a> to check for this.
 
170
occurs. You can use <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-status"><code class="function">cairo_surface_status()</code></a> to check for this.
171
171
 
172
172
</td>
173
173
</tr>
178
178
</div>
179
179
<hr>
180
180
<div class="refsect2" lang="en">
181
 
<a name="id2643700"></a><h3>
 
181
<a name="id2655609"></a><h3>
182
182
<a name="cairo-svg-surface-restrict-to-version"></a>cairo_svg_surface_restrict_to_version ()</h3>
183
 
<a class="indexterm" name="id2643713"></a><pre class="programlisting">void                cairo_svg_surface_restrict_to_version
184
 
                                                        (<a href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface,
185
 
                                                         <a href="cairo-SVG-Surfaces.html#cairo-svg-version-t">cairo_svg_version_t</a> version);</pre>
 
183
<a class="indexterm" name="id2655623"></a><pre class="programlisting">void                cairo_svg_surface_restrict_to_version
 
184
                                                        (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface,
 
185
                                                         <a class="link" href="cairo-SVG-Surfaces.html#cairo-svg-version-t">cairo_svg_version_t</a> version);</pre>
186
186
<p>
187
 
Restricts the generated SVG file to <em class="parameter"><code>version</code></em>. See <a href="cairo-SVG-Surfaces.html#cairo-svg-get-versions"><code class="function">cairo_svg_get_versions()</code></a>
 
187
Restricts the generated SVG file to <em class="parameter"><code>version</code></em>. See <a class="link" href="cairo-SVG-Surfaces.html#cairo-svg-get-versions"><code class="function">cairo_svg_get_versions()</code></a>
188
188
for a list of available version values that can be used here.
189
189
</p>
190
190
<p>
199
199
<col align="left" valign="top">
200
200
<tbody>
201
201
<tr>
202
 
<td><span class="term"><em class="parameter"><code>surface</code></em>&#160;:</span></td>
203
 
<td> a SVG <a href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>
 
202
<td><p><span class="term"><em class="parameter"><code>surface</code></em>&#160;:</span></p></td>
 
203
<td> a SVG <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>
204
204
</td>
205
205
</tr>
206
206
<tr>
207
 
<td><span class="term"><em class="parameter"><code>version</code></em>&#160;:</span></td>
 
207
<td><p><span class="term"><em class="parameter"><code>version</code></em>&#160;:</span></p></td>
208
208
<td> SVG version
209
209
</td>
210
210
</tr>
215
215
</div>
216
216
<hr>
217
217
<div class="refsect2" lang="en">
218
 
<a name="id2643822"></a><h3>
 
218
<a name="id2655734"></a><h3>
219
219
<a name="cairo-svg-version-t"></a>enum cairo_svg_version_t</h3>
220
 
<a class="indexterm" name="id2643835"></a><pre class="programlisting">typedef enum _cairo_svg_version {
 
220
<a class="indexterm" name="id2661408"></a><pre class="programlisting">typedef enum _cairo_svg_version {
221
221
    CAIRO_SVG_VERSION_1_1,
222
222
    CAIRO_SVG_VERSION_1_2
223
223
} cairo_svg_version_t;
224
224
</pre>
225
225
<p>
226
 
<a href="cairo-SVG-Surfaces.html#cairo-svg-version-t"><span class="type">cairo_svg_version_t</span></a> is used to describe the version number of the SVG
 
226
<a class="link" href="cairo-SVG-Surfaces.html#cairo-svg-version-t"><span class="type">cairo_svg_version_t</span></a> is used to describe the version number of the SVG
227
227
specification that a generated SVG file will conform to.</p>
228
228
<p>
229
229
 
232
232
<col align="left" valign="top">
233
233
<tbody>
234
234
<tr>
235
 
<td><span class="term"><a name="CAIRO-SVG-VERSION-1-1:CAPS"></a><code class="literal">CAIRO_SVG_VERSION_1_1</code></span></td>
 
235
<td><p><span class="term"><a name="CAIRO-SVG-VERSION-1-1:CAPS"></a><code class="literal">CAIRO_SVG_VERSION_1_1</code></span></p></td>
236
236
<td> The version 1.1 of the SVG specification.
237
237
</td>
238
238
</tr>
239
239
<tr>
240
 
<td><span class="term"><a name="CAIRO-SVG-VERSION-1-2:CAPS"></a><code class="literal">CAIRO_SVG_VERSION_1_2</code></span></td>
 
240
<td><p><span class="term"><a name="CAIRO-SVG-VERSION-1-2:CAPS"></a><code class="literal">CAIRO_SVG_VERSION_1_2</code></span></p></td>
241
241
<td> The version 1.2 of the SVG specification.
242
242
</td>
243
243
</tr>
246
246
</div>
247
247
<hr>
248
248
<div class="refsect2" lang="en">
249
 
<a name="id2644186"></a><h3>
 
249
<a name="id2661484"></a><h3>
250
250
<a name="cairo-svg-get-versions"></a>cairo_svg_get_versions ()</h3>
251
 
<a class="indexterm" name="id2644199"></a><pre class="programlisting">void                cairo_svg_get_versions              (<a href="cairo-SVG-Surfaces.html#cairo-svg-version-t">cairo_svg_version_t</a> const **versions,
 
251
<a class="indexterm" name="id2661497"></a><pre class="programlisting">void                cairo_svg_get_versions              (<a class="link" href="cairo-SVG-Surfaces.html#cairo-svg-version-t">cairo_svg_version_t</a> const **versions,
252
252
                                                         int *num_versions);</pre>
253
253
<p>
254
254
Used to retrieve the list of supported versions. See
255
 
<a href="cairo-SVG-Surfaces.html#cairo-svg-surface-restrict-to-version"><code class="function">cairo_svg_surface_restrict_to_version()</code></a>.</p>
 
255
<a class="link" href="cairo-SVG-Surfaces.html#cairo-svg-surface-restrict-to-version"><code class="function">cairo_svg_surface_restrict_to_version()</code></a>.</p>
256
256
<p>
257
257
 
258
258
</p>
260
260
<col align="left" valign="top">
261
261
<tbody>
262
262
<tr>
263
 
<td><span class="term"><em class="parameter"><code>versions</code></em>&#160;:</span></td>
 
263
<td><p><span class="term"><em class="parameter"><code>versions</code></em>&#160;:</span></p></td>
264
264
<td> supported version list
265
265
</td>
266
266
</tr>
267
267
<tr>
268
 
<td><span class="term"><em class="parameter"><code>num_versions</code></em>&#160;:</span></td>
 
268
<td><p><span class="term"><em class="parameter"><code>num_versions</code></em>&#160;:</span></p></td>
269
269
<td> list length
270
270
</td>
271
271
</tr>
276
276
</div>
277
277
<hr>
278
278
<div class="refsect2" lang="en">
279
 
<a name="id2644289"></a><h3>
 
279
<a name="id2661586"></a><h3>
280
280
<a name="cairo-svg-version-to-string"></a>cairo_svg_version_to_string ()</h3>
281
 
<a class="indexterm" name="id2644302"></a><pre class="programlisting">const char*         cairo_svg_version_to_string         (<a href="cairo-SVG-Surfaces.html#cairo-svg-version-t">cairo_svg_version_t</a> version);</pre>
 
281
<a class="indexterm" name="id2661600"></a><pre class="programlisting">const char*         cairo_svg_version_to_string         (<a class="link" href="cairo-SVG-Surfaces.html#cairo-svg-version-t">cairo_svg_version_t</a> version);</pre>
282
282
<p>
283
283
Get the string representation of the given <em class="parameter"><code>version</code></em> id. This function
284
 
will return NULL if <em class="parameter"><code>version</code></em> isn't valid. See <a href="cairo-SVG-Surfaces.html#cairo-svg-get-versions"><code class="function">cairo_svg_get_versions()</code></a>
 
284
will return NULL if <em class="parameter"><code>version</code></em> isn't valid. See <a class="link" href="cairo-SVG-Surfaces.html#cairo-svg-get-versions"><code class="function">cairo_svg_get_versions()</code></a>
285
285
for a way to get the list of valid version ids.</p>
286
286
<p>
287
287
 
290
290
<col align="left" valign="top">
291
291
<tbody>
292
292
<tr>
293
 
<td><span class="term"><em class="parameter"><code>version</code></em>&#160;:</span></td>
 
293
<td><p><span class="term"><em class="parameter"><code>version</code></em>&#160;:</span></p></td>
294
294
<td> a version id
295
295
</td>
296
296
</tr>
297
297
<tr>
298
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
298
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
299
299
<td> the string associated to given version.
300
300
 
301
301
</td>
306
306
</p>
307
307
</div>
308
308
</div>
 
309
<div class="refsect1" lang="en">
 
310
<a name="id2661693"></a><div class="refsect2" lang="en"><a name="id2661694"></a></div>
 
311
<hr>
 
312
<div class="refsect2" lang="en"><a name="id2661695"></a></div>
 
313
</div>
309
314
</div>
310
315
</body>
311
316
</html>