Mercurial > repos > rliterman > csp2

comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/gtk-doc/html/cairo/cairo-cairo-surface-t.html @ 68:5028fdace37b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 16:23:26 -0400
parents
children
comparison
equal deleted inserted replaced
67:0e9998148a16 68:5028fdace37b
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=UTF-8">
5 <title>cairo_surface_t: Cairo: A Vector Graphics Library</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 <link rel="home" href="index.html" title="Cairo: A Vector Graphics Library">
8 <link rel="up" href="cairo-surfaces.html" title="Surfaces">
9 <link rel="prev" href="cairo-cairo-device-t.html" title="cairo_device_t">
10 <link rel="next" href="cairo-Image-Surfaces.html" title="Image Surfaces">
11 <meta name="generator" content="GTK-Doc V1.27 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#cairo-cairo-surface-t.description" class="shortcut">Description</a></span>
19 </td>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="cairo-surfaces.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="cairo-cairo-device-t.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="cairo-Image-Surfaces.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="cairo-cairo-surface-t"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="cairo-cairo-surface-t.top_of_page"></a>cairo_surface_t</span></h2>
30 <p>cairo_surface_t — Base class for surfaces</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="cairo-cairo-surface-t.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table class="informaltable" width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_return">
39 <col class="functions_name">
40 </colgroup>
41 <tbody>
42 <tr>
43 <td class="function_type">
44 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> *
45 </td>
46 <td class="function_name">
47 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-create-similar" title="cairo_surface_create_similar ()">cairo_surface_create_similar</a> <span class="c_punctuation">()</span>
48 </td>
49 </tr>
50 <tr>
51 <td class="function_type">
52 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> *
53 </td>
54 <td class="function_name">
55 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-create-similar-image" title="cairo_surface_create_similar_image ()">cairo_surface_create_similar_image</a> <span class="c_punctuation">()</span>
56 </td>
57 </tr>
58 <tr>
59 <td class="function_type">
60 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> *
61 </td>
62 <td class="function_name">
63 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-create-for-rectangle" title="cairo_surface_create_for_rectangle ()">cairo_surface_create_for_rectangle</a> <span class="c_punctuation">()</span>
64 </td>
65 </tr>
66 <tr>
67 <td class="function_type">
68 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> *
69 </td>
70 <td class="function_name">
71 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-reference" title="cairo_surface_reference ()">cairo_surface_reference</a> <span class="c_punctuation">()</span>
72 </td>
73 </tr>
74 <tr>
75 <td class="function_type">
76 <span class="returnvalue">void</span>
77 </td>
78 <td class="function_name">
79 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-destroy" title="cairo_surface_destroy ()">cairo_surface_destroy</a> <span class="c_punctuation">()</span>
80 </td>
81 </tr>
82 <tr>
83 <td class="function_type">
84 <a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
85 </td>
86 <td class="function_name">
87 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-status" title="cairo_surface_status ()">cairo_surface_status</a> <span class="c_punctuation">()</span>
88 </td>
89 </tr>
90 <tr>
91 <td class="function_type">
92 <span class="returnvalue">void</span>
93 </td>
94 <td class="function_name">
95 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-finish" title="cairo_surface_finish ()">cairo_surface_finish</a> <span class="c_punctuation">()</span>
96 </td>
97 </tr>
98 <tr>
99 <td class="function_type">
100 <span class="returnvalue">void</span>
101 </td>
102 <td class="function_name">
103 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-flush" title="cairo_surface_flush ()">cairo_surface_flush</a> <span class="c_punctuation">()</span>
104 </td>
105 </tr>
106 <tr>
107 <td class="function_type">
108 <a class="link" href="cairo-cairo-device-t.html#cairo-device-t" title="cairo_device_t"><span class="returnvalue">cairo_device_t</span></a> *
109 </td>
110 <td class="function_name">
111 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-device" title="cairo_surface_get_device ()">cairo_surface_get_device</a> <span class="c_punctuation">()</span>
112 </td>
113 </tr>
114 <tr>
115 <td class="function_type">
116 <span class="returnvalue">void</span>
117 </td>
118 <td class="function_name">
119 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-font-options" title="cairo_surface_get_font_options ()">cairo_surface_get_font_options</a> <span class="c_punctuation">()</span>
120 </td>
121 </tr>
122 <tr>
123 <td class="function_type">
124 <a class="link" href="cairo-cairo-surface-t.html#cairo-content-t" title="enum cairo_content_t"><span class="returnvalue">cairo_content_t</span></a>
125 </td>
126 <td class="function_name">
127 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-content" title="cairo_surface_get_content ()">cairo_surface_get_content</a> <span class="c_punctuation">()</span>
128 </td>
129 </tr>
130 <tr>
131 <td class="function_type">
132 <span class="returnvalue">void</span>
133 </td>
134 <td class="function_name">
135 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-mark-dirty" title="cairo_surface_mark_dirty ()">cairo_surface_mark_dirty</a> <span class="c_punctuation">()</span>
136 </td>
137 </tr>
138 <tr>
139 <td class="function_type">
140 <span class="returnvalue">void</span>
141 </td>
142 <td class="function_name">
143 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-mark-dirty-rectangle" title="cairo_surface_mark_dirty_rectangle ()">cairo_surface_mark_dirty_rectangle</a> <span class="c_punctuation">()</span>
144 </td>
145 </tr>
146 <tr>
147 <td class="function_type">
148 <span class="returnvalue">void</span>
149 </td>
150 <td class="function_name">
151 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-set-device-offset" title="cairo_surface_set_device_offset ()">cairo_surface_set_device_offset</a> <span class="c_punctuation">()</span>
152 </td>
153 </tr>
154 <tr>
155 <td class="function_type">
156 <span class="returnvalue">void</span>
157 </td>
158 <td class="function_name">
159 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-device-offset" title="cairo_surface_get_device_offset ()">cairo_surface_get_device_offset</a> <span class="c_punctuation">()</span>
160 </td>
161 </tr>
162 <tr>
163 <td class="function_type">
164 <span class="returnvalue">void</span>
165 </td>
166 <td class="function_name">
167 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-device-scale" title="cairo_surface_get_device_scale ()">cairo_surface_get_device_scale</a> <span class="c_punctuation">()</span>
168 </td>
169 </tr>
170 <tr>
171 <td class="function_type">
172 <span class="returnvalue">void</span>
173 </td>
174 <td class="function_name">
175 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-set-device-scale" title="cairo_surface_set_device_scale ()">cairo_surface_set_device_scale</a> <span class="c_punctuation">()</span>
176 </td>
177 </tr>
178 <tr>
179 <td class="function_type">
180 <span class="returnvalue">void</span>
181 </td>
182 <td class="function_name">
183 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-set-fallback-resolution" title="cairo_surface_set_fallback_resolution ()">cairo_surface_set_fallback_resolution</a> <span class="c_punctuation">()</span>
184 </td>
185 </tr>
186 <tr>
187 <td class="function_type">
188 <span class="returnvalue">void</span>
189 </td>
190 <td class="function_name">
191 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-fallback-resolution" title="cairo_surface_get_fallback_resolution ()">cairo_surface_get_fallback_resolution</a> <span class="c_punctuation">()</span>
192 </td>
193 </tr>
194 <tr>
195 <td class="function_type">
196 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-type-t" title="enum cairo_surface_type_t"><span class="returnvalue">cairo_surface_type_t</span></a>
197 </td>
198 <td class="function_name">
199 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-type" title="cairo_surface_get_type ()">cairo_surface_get_type</a> <span class="c_punctuation">()</span>
200 </td>
201 </tr>
202 <tr>
203 <td class="function_type">unsigned <span class="returnvalue">int</span>
204 </td>
205 <td class="function_name">
206 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-reference-count" title="cairo_surface_get_reference_count ()">cairo_surface_get_reference_count</a> <span class="c_punctuation">()</span>
207 </td>
208 </tr>
209 <tr>
210 <td class="function_type">
211 <a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
212 </td>
213 <td class="function_name">
214 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-set-user-data" title="cairo_surface_set_user_data ()">cairo_surface_set_user_data</a> <span class="c_punctuation">()</span>
215 </td>
216 </tr>
217 <tr>
218 <td class="function_type">
219 <span class="returnvalue">void</span> *
220 </td>
221 <td class="function_name">
222 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-user-data" title="cairo_surface_get_user_data ()">cairo_surface_get_user_data</a> <span class="c_punctuation">()</span>
223 </td>
224 </tr>
225 <tr>
226 <td class="function_type">
227 <span class="returnvalue">void</span>
228 </td>
229 <td class="function_name">
230 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-copy-page" title="cairo_surface_copy_page ()">cairo_surface_copy_page</a> <span class="c_punctuation">()</span>
231 </td>
232 </tr>
233 <tr>
234 <td class="function_type">
235 <span class="returnvalue">void</span>
236 </td>
237 <td class="function_name">
238 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-show-page" title="cairo_surface_show_page ()">cairo_surface_show_page</a> <span class="c_punctuation">()</span>
239 </td>
240 </tr>
241 <tr>
242 <td class="function_type">
243 <a class="link" href="cairo-Types.html#cairo-bool-t" title="cairo_bool_t"><span class="returnvalue">cairo_bool_t</span></a>
244 </td>
245 <td class="function_name">
246 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-has-show-text-glyphs" title="cairo_surface_has_show_text_glyphs ()">cairo_surface_has_show_text_glyphs</a> <span class="c_punctuation">()</span>
247 </td>
248 </tr>
249 <tr>
250 <td class="function_type">
251 <a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
252 </td>
253 <td class="function_name">
254 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-set-mime-data" title="cairo_surface_set_mime_data ()">cairo_surface_set_mime_data</a> <span class="c_punctuation">()</span>
255 </td>
256 </tr>
257 <tr>
258 <td class="function_type">
259 <span class="returnvalue">void</span>
260 </td>
261 <td class="function_name">
262 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-mime-data" title="cairo_surface_get_mime_data ()">cairo_surface_get_mime_data</a> <span class="c_punctuation">()</span>
263 </td>
264 </tr>
265 <tr>
266 <td class="function_type">
267 <a class="link" href="cairo-Types.html#cairo-bool-t" title="cairo_bool_t"><span class="returnvalue">cairo_bool_t</span></a>
268 </td>
269 <td class="function_name">
270 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-supports-mime-type" title="cairo_surface_supports_mime_type ()">cairo_surface_supports_mime_type</a> <span class="c_punctuation">()</span>
271 </td>
272 </tr>
273 <tr>
274 <td class="function_type">
275 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> *
276 </td>
277 <td class="function_name">
278 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-map-to-image" title="cairo_surface_map_to_image ()">cairo_surface_map_to_image</a> <span class="c_punctuation">()</span>
279 </td>
280 </tr>
281 <tr>
282 <td class="function_type">
283 <span class="returnvalue">void</span>
284 </td>
285 <td class="function_name">
286 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-unmap-image" title="cairo_surface_unmap_image ()">cairo_surface_unmap_image</a> <span class="c_punctuation">()</span>
287 </td>
288 </tr>
289 </tbody>
290 </table></div>
291 </div>
292 <div class="refsect1">
293 <a name="cairo-cairo-surface-t.other"></a><h2>Types and Values</h2>
294 <div class="informaltable"><table class="informaltable" width="100%" border="0">
295 <colgroup>
296 <col width="150px" class="name">
297 <col class="description">
298 </colgroup>
299 <tbody>
300 <tr>
301 <td class="define_keyword">#define</td>
302 <td class="function_name"><a class="link" href="cairo-cairo-surface-t.html#CAIRO-HAS-MIME-SURFACE:CAPS" title="CAIRO_HAS_MIME_SURFACE">CAIRO_HAS_MIME_SURFACE</a></td>
303 </tr>
304 <tr>
305 <td class="define_keyword">#define</td>
306 <td class="function_name"><a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-CCITT-FAX:CAPS" title="CAIRO_MIME_TYPE_CCITT_FAX">CAIRO_MIME_TYPE_CCITT_FAX</a></td>
307 </tr>
308 <tr>
309 <td class="define_keyword">#define</td>
310 <td class="function_name"><a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-CCITT-FAX-PARAMS:CAPS" title="CAIRO_MIME_TYPE_CCITT_FAX_PARAMS">CAIRO_MIME_TYPE_CCITT_FAX_PARAMS</a></td>
311 </tr>
312 <tr>
313 <td class="define_keyword">#define</td>
314 <td class="function_name"><a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-EPS:CAPS" title="CAIRO_MIME_TYPE_EPS">CAIRO_MIME_TYPE_EPS</a></td>
315 </tr>
316 <tr>
317 <td class="define_keyword">#define</td>
318 <td class="function_name"><a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-EPS-PARAMS:CAPS" title="CAIRO_MIME_TYPE_EPS_PARAMS">CAIRO_MIME_TYPE_EPS_PARAMS</a></td>
319 </tr>
320 <tr>
321 <td class="define_keyword">#define</td>
322 <td class="function_name"><a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JBIG2:CAPS" title="CAIRO_MIME_TYPE_JBIG2">CAIRO_MIME_TYPE_JBIG2</a></td>
323 </tr>
324 <tr>
325 <td class="define_keyword">#define</td>
326 <td class="function_name"><a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JBIG2-GLOBAL:CAPS" title="CAIRO_MIME_TYPE_JBIG2_GLOBAL">CAIRO_MIME_TYPE_JBIG2_GLOBAL</a></td>
327 </tr>
328 <tr>
329 <td class="define_keyword">#define</td>
330 <td class="function_name"><a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JBIG2-GLOBAL-ID:CAPS" title="CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID">CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID</a></td>
331 </tr>
332 <tr>
333 <td class="define_keyword">#define</td>
334 <td class="function_name"><a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JP2:CAPS" title="CAIRO_MIME_TYPE_JP2">CAIRO_MIME_TYPE_JP2</a></td>
335 </tr>
336 <tr>
337 <td class="define_keyword">#define</td>
338 <td class="function_name"><a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JPEG:CAPS" title="CAIRO_MIME_TYPE_JPEG">CAIRO_MIME_TYPE_JPEG</a></td>
339 </tr>
340 <tr>
341 <td class="define_keyword">#define</td>
342 <td class="function_name"><a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-PNG:CAPS" title="CAIRO_MIME_TYPE_PNG">CAIRO_MIME_TYPE_PNG</a></td>
343 </tr>
344 <tr>
345 <td class="define_keyword">#define</td>
346 <td class="function_name"><a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-URI:CAPS" title="CAIRO_MIME_TYPE_URI">CAIRO_MIME_TYPE_URI</a></td>
347 </tr>
348 <tr>
349 <td class="define_keyword">#define</td>
350 <td class="function_name"><a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-UNIQUE-ID:CAPS" title="CAIRO_MIME_TYPE_UNIQUE_ID">CAIRO_MIME_TYPE_UNIQUE_ID</a></td>
351 </tr>
352 <tr>
353 <td class="typedef_keyword">typedef</td>
354 <td class="function_name"><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t">cairo_surface_t</a></td>
355 </tr>
356 <tr>
357 <td class="datatype_keyword">enum</td>
358 <td class="function_name"><a class="link" href="cairo-cairo-surface-t.html#cairo-content-t" title="enum cairo_content_t">cairo_content_t</a></td>
359 </tr>
360 <tr>
361 <td class="datatype_keyword">enum</td>
362 <td class="function_name"><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-type-t" title="enum cairo_surface_type_t">cairo_surface_type_t</a></td>
363 </tr>
364 </tbody>
365 </table></div>
366 </div>
367 <div class="refsect1">
368 <a name="cairo-cairo-surface-t.description"></a><h2>Description</h2>
369 <p><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> is the abstract type representing all different drawing
370 targets that cairo can render to. The actual drawings are
371 performed using a cairo <em class="firstterm">context</em>.</p>
372 <p>A cairo surface is created by using <em class="firstterm">backend</em>-specific
373 constructors, typically of the form
374 <code class="function">cairo_<span class="emphasis"><em>backend</em></span>_surface_create()</code>.</p>
375 <p>Most surface types allow accessing the surface without using Cairo
376 functions. If you do this, keep in mind that it is mandatory that you call
377 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-flush" title="cairo_surface_flush ()"><code class="function">cairo_surface_flush()</code></a> before reading from or writing to the surface and that
378 you must use <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-mark-dirty" title="cairo_surface_mark_dirty ()"><code class="function">cairo_surface_mark_dirty()</code></a> after modifying it.</p>
379 <div class="example">
380 <a name="id-1.5.3.5.5"></a><p class="title"><b>Example 1. Directly modifying an image surface</b></p>
381 <div class="example-contents">
382 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
383 <tbody>
384 <tr>
385 <td class="listing_lines" align="right"><pre>1
386 2
387 3
388 4
389 5
390 6
391 7
392 8
393 9
394 10
395 11
396 12
397 13
398 14
399 15
400 16
401 17
402 18
403 19</pre></td>
404 <td class="listing_code"><pre class="programlisting"><span class="gtkdoc kwb">void</span>
405 <span class="function">modify_image_surface</span> <span class="gtkdoc opt">(</span>cairo_surface_t <span class="gtkdoc opt">*</span>surface<span class="gtkdoc opt">)</span>
406 <span class="gtkdoc opt">{</span>
407 <span class="gtkdoc kwb">unsigned char</span> <span class="gtkdoc opt">*</span>data<span class="gtkdoc opt">;</span>
408 <span class="gtkdoc kwb">int</span> width<span class="gtkdoc opt">,</span> height<span class="gtkdoc opt">,</span> stride<span class="gtkdoc opt">;</span>
409
410 <span class="gtkdoc slc">// flush to ensure all writing to the image was done</span>
411 <span class="function"><a href="cairo-cairo-surface-t.html#cairo-surface-flush">cairo_surface_flush</a></span> <span class="gtkdoc opt">(</span>surface<span class="gtkdoc opt">);</span>
412
413 <span class="gtkdoc slc">// modify the image</span>
414 data <span class="gtkdoc opt">=</span> <span class="function"><a href="cairo-Image-Surfaces.html#cairo-image-surface-get-data">cairo_image_surface_get_data</a></span> <span class="gtkdoc opt">(</span>surface<span class="gtkdoc opt">);</span>
415 width <span class="gtkdoc opt">=</span> <span class="function"><a href="cairo-Image-Surfaces.html#cairo-image-surface-get-width">cairo_image_surface_get_width</a></span> <span class="gtkdoc opt">(</span>surface<span class="gtkdoc opt">);</span>
416 height <span class="gtkdoc opt">=</span> <span class="function"><a href="cairo-Image-Surfaces.html#cairo-image-surface-get-height">cairo_image_surface_get_height</a></span> <span class="gtkdoc opt">(</span>surface<span class="gtkdoc opt">);</span>
417 stride <span class="gtkdoc opt">=</span> <span class="function"><a href="cairo-Image-Surfaces.html#cairo-image-surface-get-stride">cairo_image_surface_get_stride</a></span> <span class="gtkdoc opt">(</span>surface<span class="gtkdoc opt">);</span>
418 <span class="function">modify_image_data</span> <span class="gtkdoc opt">(</span>data<span class="gtkdoc opt">,</span> width<span class="gtkdoc opt">,</span> height<span class="gtkdoc opt">,</span> stride<span class="gtkdoc opt">);</span>
419
420 <span class="gtkdoc slc">// mark the image dirty so Cairo clears its caches.</span>
421 <span class="function"><a href="cairo-cairo-surface-t.html#cairo-surface-mark-dirty">cairo_surface_mark_dirty</a></span> <span class="gtkdoc opt">(</span>surface<span class="gtkdoc opt">);</span>
422 <span class="gtkdoc opt">}</span></pre></td>
423 </tr>
424 </tbody>
425 </table>
426 </div>
427
428 </div>
429 <br class="example-break"><p>Note that for other surface types it might be necessary to acquire the
430 surface's device first. See <a class="link" href="cairo-cairo-device-t.html#cairo-device-acquire" title="cairo_device_acquire ()"><code class="function">cairo_device_acquire()</code></a> for a discussion of
431 devices.</p>
432 </div>
433 <div class="refsect1">
434 <a name="cairo-cairo-surface-t.functions_details"></a><h2>Functions</h2>
435 <div class="refsect2">
436 <a name="cairo-surface-create-similar"></a><h3>cairo_surface_create_similar ()</h3>
437 <pre class="programlisting"><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> *
438 cairo_surface_create_similar (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *other</code></em>,
439 <em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-content-t" title="enum cairo_content_t"><span class="type">cairo_content_t</span></a> content</code></em>,
440 <em class="parameter"><code><span class="type">int</span> width</code></em>,
441 <em class="parameter"><code><span class="type">int</span> height</code></em>);</pre>
442 <p>Create a new surface that is as compatible as possible with an
443 existing surface. For example the new surface will have the same
444 device scale, fallback resolution and font options as
445 <em class="parameter"><code>other</code></em>
446 . Generally, the new surface will also use the same backend
447 as <em class="parameter"><code>other</code></em>
448 , unless that is not possible for some reason. The type of
449 the returned surface may be examined with
450 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-type" title="cairo_surface_get_type ()"><code class="function">cairo_surface_get_type()</code></a>.</p>
451 <p>Initially the surface contents are all 0 (transparent if contents
452 have transparency, black otherwise.)</p>
453 <p>Use <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-create-similar-image" title="cairo_surface_create_similar_image ()"><code class="function">cairo_surface_create_similar_image()</code></a> if you need an image surface
454 which can be painted quickly to the target surface.</p>
455 <div class="refsect3">
456 <a name="cairo-surface-create-similar.parameters"></a><h4>Parameters</h4>
457 <div class="informaltable"><table class="informaltable" width="100%" border="0">
458 <colgroup>
459 <col width="150px" class="parameters_name">
460 <col class="parameters_description">
461 <col width="200px" class="parameters_annotations">
462 </colgroup>
463 <tbody>
464 <tr>
465 <td class="parameter_name"><p>other</p></td>
466 <td class="parameter_description"><p>an existing surface used to select the backend of the new surface</p></td>
467 <td class="parameter_annotations"> </td>
468 </tr>
469 <tr>
470 <td class="parameter_name"><p>content</p></td>
471 <td class="parameter_description"><p>the content for the new surface</p></td>
472 <td class="parameter_annotations"> </td>
473 </tr>
474 <tr>
475 <td class="parameter_name"><p>width</p></td>
476 <td class="parameter_description"><p>width of the new surface, (in device-space units)</p></td>
477 <td class="parameter_annotations"> </td>
478 </tr>
479 <tr>
480 <td class="parameter_name"><p>height</p></td>
481 <td class="parameter_description"><p>height of the new surface (in device-space units)</p></td>
482 <td class="parameter_annotations"> </td>
483 </tr>
484 </tbody>
485 </table></div>
486 </div>
487 <div class="refsect3">
488 <a name="cairo-surface-create-similar.returns"></a><h4>Returns</h4>
489 <p> a pointer to the newly allocated surface. The caller
490 owns the surface and should call <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-destroy" title="cairo_surface_destroy ()"><code class="function">cairo_surface_destroy()</code></a> when done
491 with it.</p>
492 <p>This function always returns a valid pointer, but it will return a
493 pointer to a "nil" surface if <em class="parameter"><code>other</code></em>
494 is already in an error state
495 or any other error occurs.</p>
496 </div>
497 <p class="since">Since: 1.0</p>
498 </div>
499 <hr>
500 <div class="refsect2">
501 <a name="cairo-surface-create-similar-image"></a><h3>cairo_surface_create_similar_image ()</h3>
502 <pre class="programlisting"><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> *
503 cairo_surface_create_similar_image (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *other</code></em>,
504 <em class="parameter"><code><a class="link" href="cairo-Image-Surfaces.html#cairo-format-t" title="enum cairo_format_t"><span class="type">cairo_format_t</span></a> format</code></em>,
505 <em class="parameter"><code><span class="type">int</span> width</code></em>,
506 <em class="parameter"><code><span class="type">int</span> height</code></em>);</pre>
507 <p>Create a new image surface that is as compatible as possible for uploading
508 to and the use in conjunction with an existing surface. However, this surface
509 can still be used like any normal image surface. Unlike
510 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-create-similar" title="cairo_surface_create_similar ()"><code class="function">cairo_surface_create_similar()</code></a> the new image surface won't inherit
511 the device scale from <em class="parameter"><code>other</code></em>
512 .</p>
513 <p>Initially the surface contents are all 0 (transparent if contents
514 have transparency, black otherwise.)</p>
515 <p>Use <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-create-similar" title="cairo_surface_create_similar ()"><code class="function">cairo_surface_create_similar()</code></a> if you don't need an image surface.</p>
516 <div class="refsect3">
517 <a name="cairo-surface-create-similar-image.parameters"></a><h4>Parameters</h4>
518 <div class="informaltable"><table class="informaltable" width="100%" border="0">
519 <colgroup>
520 <col width="150px" class="parameters_name">
521 <col class="parameters_description">
522 <col width="200px" class="parameters_annotations">
523 </colgroup>
524 <tbody>
525 <tr>
526 <td class="parameter_name"><p>other</p></td>
527 <td class="parameter_description"><p>an existing surface used to select the preference of the new surface</p></td>
528 <td class="parameter_annotations"> </td>
529 </tr>
530 <tr>
531 <td class="parameter_name"><p>format</p></td>
532 <td class="parameter_description"><p>the format for the new surface</p></td>
533 <td class="parameter_annotations"> </td>
534 </tr>
535 <tr>
536 <td class="parameter_name"><p>width</p></td>
537 <td class="parameter_description"><p>width of the new surface, (in pixels)</p></td>
538 <td class="parameter_annotations"> </td>
539 </tr>
540 <tr>
541 <td class="parameter_name"><p>height</p></td>
542 <td class="parameter_description"><p>height of the new surface (in pixels)</p></td>
543 <td class="parameter_annotations"> </td>
544 </tr>
545 </tbody>
546 </table></div>
547 </div>
548 <div class="refsect3">
549 <a name="cairo-surface-create-similar-image.returns"></a><h4>Returns</h4>
550 <p> a pointer to the newly allocated image surface. The caller
551 owns the surface and should call <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-destroy" title="cairo_surface_destroy ()"><code class="function">cairo_surface_destroy()</code></a> when done
552 with it.</p>
553 <p>This function always returns a valid pointer, but it will return a
554 pointer to a "nil" surface if <em class="parameter"><code>other</code></em>
555 is already in an error state
556 or any other error occurs.</p>
557 </div>
558 <p class="since">Since: 1.12</p>
559 </div>
560 <hr>
561 <div class="refsect2">
562 <a name="cairo-surface-create-for-rectangle"></a><h3>cairo_surface_create_for_rectangle ()</h3>
563 <pre class="programlisting"><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> *
564 cairo_surface_create_for_rectangle (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *target</code></em>,
565 <em class="parameter"><code><span class="type">double</span> x</code></em>,
566 <em class="parameter"><code><span class="type">double</span> y</code></em>,
567 <em class="parameter"><code><span class="type">double</span> width</code></em>,
568 <em class="parameter"><code><span class="type">double</span> height</code></em>);</pre>
569 <p>Create a new surface that is a rectangle within the target surface.
570 All operations drawn to this surface are then clipped and translated
571 onto the target surface. Nothing drawn via this sub-surface outside of
572 its bounds is drawn onto the target surface, making this a useful method
573 for passing constrained child surfaces to library routines that draw
574 directly onto the parent surface, i.e. with no further backend allocations,
575 double buffering or copies.</p>
576 <div class="note"><p>The semantics of subsurfaces have not been finalized yet
577 unless the rectangle is in full device units, is contained within
578 the extents of the target surface, and the target or subsurface's
579 device transforms are not changed.</p></div>
580 <div class="refsect3">
581 <a name="cairo-surface-create-for-rectangle.parameters"></a><h4>Parameters</h4>
582 <div class="informaltable"><table class="informaltable" width="100%" border="0">
583 <colgroup>
584 <col width="150px" class="parameters_name">
585 <col class="parameters_description">
586 <col width="200px" class="parameters_annotations">
587 </colgroup>
588 <tbody>
589 <tr>
590 <td class="parameter_name"><p>target</p></td>
591 <td class="parameter_description"><p>an existing surface for which the sub-surface will point to</p></td>
592 <td class="parameter_annotations"> </td>
593 </tr>
594 <tr>
595 <td class="parameter_name"><p>x</p></td>
596 <td class="parameter_description"><p>the x-origin of the sub-surface from the top-left of the target surface (in device-space units)</p></td>
597 <td class="parameter_annotations"> </td>
598 </tr>
599 <tr>
600 <td class="parameter_name"><p>y</p></td>
601 <td class="parameter_description"><p>the y-origin of the sub-surface from the top-left of the target surface (in device-space units)</p></td>
602 <td class="parameter_annotations"> </td>
603 </tr>
604 <tr>
605 <td class="parameter_name"><p>width</p></td>
606 <td class="parameter_description"><p>width of the sub-surface (in device-space units)</p></td>
607 <td class="parameter_annotations"> </td>
608 </tr>
609 <tr>
610 <td class="parameter_name"><p>height</p></td>
611 <td class="parameter_description"><p>height of the sub-surface (in device-space units)</p></td>
612 <td class="parameter_annotations"> </td>
613 </tr>
614 </tbody>
615 </table></div>
616 </div>
617 <div class="refsect3">
618 <a name="cairo-surface-create-for-rectangle.returns"></a><h4>Returns</h4>
619 <p> a pointer to the newly allocated surface. The caller
620 owns the surface and should call <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-destroy" title="cairo_surface_destroy ()"><code class="function">cairo_surface_destroy()</code></a> when done
621 with it.</p>
622 <p>This function always returns a valid pointer, but it will return a
623 pointer to a "nil" surface if <em class="parameter"><code>other</code></em>
624 is already in an error state
625 or any other error occurs.</p>
626 </div>
627 <p class="since">Since: 1.10</p>
628 </div>
629 <hr>
630 <div class="refsect2">
631 <a name="cairo-surface-reference"></a><h3>cairo_surface_reference ()</h3>
632 <pre class="programlisting"><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> *
633 cairo_surface_reference (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);</pre>
634 <p>Increases the reference count on <em class="parameter"><code>surface</code></em>
635 by one. This prevents
636 <em class="parameter"><code>surface</code></em>
637 from being destroyed until a matching call to
638 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-destroy" title="cairo_surface_destroy ()"><code class="function">cairo_surface_destroy()</code></a> is made.</p>
639 <p>Use <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-reference-count" title="cairo_surface_get_reference_count ()"><code class="function">cairo_surface_get_reference_count()</code></a> to get the number of
640 references to a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a>.</p>
641 <div class="refsect3">
642 <a name="cairo-surface-reference.parameters"></a><h4>Parameters</h4>
643 <div class="informaltable"><table class="informaltable" width="100%" border="0">
644 <colgroup>
645 <col width="150px" class="parameters_name">
646 <col class="parameters_description">
647 <col width="200px" class="parameters_annotations">
648 </colgroup>
649 <tbody><tr>
650 <td class="parameter_name"><p>surface</p></td>
651 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
652 <td class="parameter_annotations"> </td>
653 </tr></tbody>
654 </table></div>
655 </div>
656 <div class="refsect3">
657 <a name="cairo-surface-reference.returns"></a><h4>Returns</h4>
658 <p> the referenced <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a>.</p>
659 </div>
660 <p class="since">Since: 1.0</p>
661 </div>
662 <hr>
663 <div class="refsect2">
664 <a name="cairo-surface-destroy"></a><h3>cairo_surface_destroy ()</h3>
665 <pre class="programlisting"><span class="returnvalue">void</span>
666 cairo_surface_destroy (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);</pre>
667 <p>Decreases the reference count on <em class="parameter"><code>surface</code></em>
668 by one. If the result is
669 zero, then <em class="parameter"><code>surface</code></em>
670 and all associated resources are freed. See
671 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-reference" title="cairo_surface_reference ()"><code class="function">cairo_surface_reference()</code></a>.</p>
672 <div class="refsect3">
673 <a name="cairo-surface-destroy.parameters"></a><h4>Parameters</h4>
674 <div class="informaltable"><table class="informaltable" width="100%" border="0">
675 <colgroup>
676 <col width="150px" class="parameters_name">
677 <col class="parameters_description">
678 <col width="200px" class="parameters_annotations">
679 </colgroup>
680 <tbody><tr>
681 <td class="parameter_name"><p>surface</p></td>
682 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
683 <td class="parameter_annotations"> </td>
684 </tr></tbody>
685 </table></div>
686 </div>
687 <p class="since">Since: 1.0</p>
688 </div>
689 <hr>
690 <div class="refsect2">
691 <a name="cairo-surface-status"></a><h3>cairo_surface_status ()</h3>
692 <pre class="programlisting"><a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
693 cairo_surface_status (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);</pre>
694 <p>Checks whether an error has previously occurred for this
695 surface.</p>
696 <div class="refsect3">
697 <a name="cairo-surface-status.parameters"></a><h4>Parameters</h4>
698 <div class="informaltable"><table class="informaltable" width="100%" border="0">
699 <colgroup>
700 <col width="150px" class="parameters_name">
701 <col class="parameters_description">
702 <col width="200px" class="parameters_annotations">
703 </colgroup>
704 <tbody><tr>
705 <td class="parameter_name"><p>surface</p></td>
706 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
707 <td class="parameter_annotations"> </td>
708 </tr></tbody>
709 </table></div>
710 </div>
711 <div class="refsect3">
712 <a name="cairo-surface-status.returns"></a><h4>Returns</h4>
713 <p> <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-SUCCESS:CAPS"><code class="literal">CAIRO_STATUS_SUCCESS</code></a>, <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-NULL-POINTER:CAPS"><code class="literal">CAIRO_STATUS_NULL_POINTER</code></a>,
714 <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-NO-MEMORY:CAPS"><code class="literal">CAIRO_STATUS_NO_MEMORY</code></a>, <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-READ-ERROR:CAPS"><code class="literal">CAIRO_STATUS_READ_ERROR</code></a>,
715 <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-INVALID-CONTENT:CAPS"><code class="literal">CAIRO_STATUS_INVALID_CONTENT</code></a>, <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-INVALID-FORMAT:CAPS"><code class="literal">CAIRO_STATUS_INVALID_FORMAT</code></a>, or
716 <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-INVALID-VISUAL:CAPS"><code class="literal">CAIRO_STATUS_INVALID_VISUAL</code></a>.</p>
717 </div>
718 <p class="since">Since: 1.0</p>
719 </div>
720 <hr>
721 <div class="refsect2">
722 <a name="cairo-surface-finish"></a><h3>cairo_surface_finish ()</h3>
723 <pre class="programlisting"><span class="returnvalue">void</span>
724 cairo_surface_finish (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);</pre>
725 <p>This function finishes the surface and drops all references to
726 external resources. For example, for the Xlib backend it means
727 that cairo will no longer access the drawable, which can be freed.
728 After calling <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-finish" title="cairo_surface_finish ()"><code class="function">cairo_surface_finish()</code></a> the only valid operations on a
729 surface are getting and setting user, referencing and
730 destroying, and flushing and finishing it.
731 Further drawing to the surface will not affect the
732 surface but will instead trigger a <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-SURFACE-FINISHED:CAPS"><code class="literal">CAIRO_STATUS_SURFACE_FINISHED</code></a>
733 error.</p>
734 <p>When the last call to <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-destroy" title="cairo_surface_destroy ()"><code class="function">cairo_surface_destroy()</code></a> decreases the
735 reference count to zero, cairo will call <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-finish" title="cairo_surface_finish ()"><code class="function">cairo_surface_finish()</code></a> if
736 it hasn't been called already, before freeing the resources
737 associated with the surface.</p>
738 <div class="refsect3">
739 <a name="cairo-surface-finish.parameters"></a><h4>Parameters</h4>
740 <div class="informaltable"><table class="informaltable" width="100%" border="0">
741 <colgroup>
742 <col width="150px" class="parameters_name">
743 <col class="parameters_description">
744 <col width="200px" class="parameters_annotations">
745 </colgroup>
746 <tbody><tr>
747 <td class="parameter_name"><p>surface</p></td>
748 <td class="parameter_description"><p>the <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> to finish</p></td>
749 <td class="parameter_annotations"> </td>
750 </tr></tbody>
751 </table></div>
752 </div>
753 <p class="since">Since: 1.0</p>
754 </div>
755 <hr>
756 <div class="refsect2">
757 <a name="cairo-surface-flush"></a><h3>cairo_surface_flush ()</h3>
758 <pre class="programlisting"><span class="returnvalue">void</span>
759 cairo_surface_flush (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);</pre>
760 <p>Do any pending drawing for the surface and also restore any temporary
761 modifications cairo has made to the surface's state. This function
762 must be called before switching from drawing on the surface with
763 cairo to drawing on it directly with native APIs, or accessing its
764 memory outside of Cairo. If the surface doesn't support direct
765 access, then this function does nothing.</p>
766 <div class="refsect3">
767 <a name="cairo-surface-flush.parameters"></a><h4>Parameters</h4>
768 <div class="informaltable"><table class="informaltable" width="100%" border="0">
769 <colgroup>
770 <col width="150px" class="parameters_name">
771 <col class="parameters_description">
772 <col width="200px" class="parameters_annotations">
773 </colgroup>
774 <tbody><tr>
775 <td class="parameter_name"><p>surface</p></td>
776 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
777 <td class="parameter_annotations"> </td>
778 </tr></tbody>
779 </table></div>
780 </div>
781 <p class="since">Since: 1.0</p>
782 </div>
783 <hr>
784 <div class="refsect2">
785 <a name="cairo-surface-get-device"></a><h3>cairo_surface_get_device ()</h3>
786 <pre class="programlisting"><a class="link" href="cairo-cairo-device-t.html#cairo-device-t" title="cairo_device_t"><span class="returnvalue">cairo_device_t</span></a> *
787 cairo_surface_get_device (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);</pre>
788 <p>This function returns the device for a <em class="parameter"><code>surface</code></em>
789 .
790 See <a class="link" href="cairo-cairo-device-t.html#cairo-device-t" title="cairo_device_t"><span class="type">cairo_device_t</span></a>.</p>
791 <div class="refsect3">
792 <a name="cairo-surface-get-device.parameters"></a><h4>Parameters</h4>
793 <div class="informaltable"><table class="informaltable" width="100%" border="0">
794 <colgroup>
795 <col width="150px" class="parameters_name">
796 <col class="parameters_description">
797 <col width="200px" class="parameters_annotations">
798 </colgroup>
799 <tbody><tr>
800 <td class="parameter_name"><p>surface</p></td>
801 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
802 <td class="parameter_annotations"> </td>
803 </tr></tbody>
804 </table></div>
805 </div>
806 <div class="refsect3">
807 <a name="cairo-surface-get-device.returns"></a><h4>Returns</h4>
808 <p> The device for <em class="parameter"><code>surface</code></em>
809 or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the surface does
810 not have an associated device.</p>
811 </div>
812 <p class="since">Since: 1.10</p>
813 </div>
814 <hr>
815 <div class="refsect2">
816 <a name="cairo-surface-get-font-options"></a><h3>cairo_surface_get_font_options ()</h3>
817 <pre class="programlisting"><span class="returnvalue">void</span>
818 cairo_surface_get_font_options (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>,
819 <em class="parameter"><code><a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> *options</code></em>);</pre>
820 <p>Retrieves the default font rendering options for the surface.
821 This allows display surfaces to report the correct subpixel order
822 for rendering on them, print surfaces to disable hinting of
823 metrics and so forth. The result can then be used with
824 <a class="link" href="cairo-cairo-scaled-font-t.html#cairo-scaled-font-create" title="cairo_scaled_font_create ()"><code class="function">cairo_scaled_font_create()</code></a>.</p>
825 <div class="refsect3">
826 <a name="cairo-surface-get-font-options.parameters"></a><h4>Parameters</h4>
827 <div class="informaltable"><table class="informaltable" width="100%" border="0">
828 <colgroup>
829 <col width="150px" class="parameters_name">
830 <col class="parameters_description">
831 <col width="200px" class="parameters_annotations">
832 </colgroup>
833 <tbody>
834 <tr>
835 <td class="parameter_name"><p>surface</p></td>
836 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
837 <td class="parameter_annotations"> </td>
838 </tr>
839 <tr>
840 <td class="parameter_name"><p>options</p></td>
841 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-font-options-t.html#cairo-font-options-t" title="cairo_font_options_t"><span class="type">cairo_font_options_t</span></a> object into which to store
842 the retrieved options. All existing values are overwritten</p></td>
843 <td class="parameter_annotations"> </td>
844 </tr>
845 </tbody>
846 </table></div>
847 </div>
848 <p class="since">Since: 1.0</p>
849 </div>
850 <hr>
851 <div class="refsect2">
852 <a name="cairo-surface-get-content"></a><h3>cairo_surface_get_content ()</h3>
853 <pre class="programlisting"><a class="link" href="cairo-cairo-surface-t.html#cairo-content-t" title="enum cairo_content_t"><span class="returnvalue">cairo_content_t</span></a>
854 cairo_surface_get_content (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);</pre>
855 <p>This function returns the content type of <em class="parameter"><code>surface</code></em>
856 which indicates
857 whether the surface contains color and/or alpha information. See
858 <a class="link" href="cairo-cairo-surface-t.html#cairo-content-t" title="enum cairo_content_t"><span class="type">cairo_content_t</span></a>.</p>
859 <div class="refsect3">
860 <a name="cairo-surface-get-content.parameters"></a><h4>Parameters</h4>
861 <div class="informaltable"><table class="informaltable" width="100%" border="0">
862 <colgroup>
863 <col width="150px" class="parameters_name">
864 <col class="parameters_description">
865 <col width="200px" class="parameters_annotations">
866 </colgroup>
867 <tbody><tr>
868 <td class="parameter_name"><p>surface</p></td>
869 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
870 <td class="parameter_annotations"> </td>
871 </tr></tbody>
872 </table></div>
873 </div>
874 <div class="refsect3">
875 <a name="cairo-surface-get-content.returns"></a><h4>Returns</h4>
876 <p> The content type of <em class="parameter"><code>surface</code></em>
877 .</p>
878 </div>
879 <p class="since">Since: 1.2</p>
880 </div>
881 <hr>
882 <div class="refsect2">
883 <a name="cairo-surface-mark-dirty"></a><h3>cairo_surface_mark_dirty ()</h3>
884 <pre class="programlisting"><span class="returnvalue">void</span>
885 cairo_surface_mark_dirty (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);</pre>
886 <p>Tells cairo that drawing has been done to surface using means other
887 than cairo, and that cairo should reread any cached areas. Note
888 that you must call <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-flush" title="cairo_surface_flush ()"><code class="function">cairo_surface_flush()</code></a> before doing such drawing.</p>
889 <div class="refsect3">
890 <a name="cairo-surface-mark-dirty.parameters"></a><h4>Parameters</h4>
891 <div class="informaltable"><table class="informaltable" width="100%" border="0">
892 <colgroup>
893 <col width="150px" class="parameters_name">
894 <col class="parameters_description">
895 <col width="200px" class="parameters_annotations">
896 </colgroup>
897 <tbody><tr>
898 <td class="parameter_name"><p>surface</p></td>
899 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
900 <td class="parameter_annotations"> </td>
901 </tr></tbody>
902 </table></div>
903 </div>
904 <p class="since">Since: 1.0</p>
905 </div>
906 <hr>
907 <div class="refsect2">
908 <a name="cairo-surface-mark-dirty-rectangle"></a><h3>cairo_surface_mark_dirty_rectangle ()</h3>
909 <pre class="programlisting"><span class="returnvalue">void</span>
910 cairo_surface_mark_dirty_rectangle (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>,
911 <em class="parameter"><code><span class="type">int</span> x</code></em>,
912 <em class="parameter"><code><span class="type">int</span> y</code></em>,
913 <em class="parameter"><code><span class="type">int</span> width</code></em>,
914 <em class="parameter"><code><span class="type">int</span> height</code></em>);</pre>
915 <p>Like <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-mark-dirty" title="cairo_surface_mark_dirty ()"><code class="function">cairo_surface_mark_dirty()</code></a>, but drawing has been done only to
916 the specified rectangle, so that cairo can retain cached contents
917 for other parts of the surface.</p>
918 <p>Any cached clip set on the surface will be reset by this function,
919 to make sure that future cairo calls have the clip set that they
920 expect.</p>
921 <div class="refsect3">
922 <a name="cairo-surface-mark-dirty-rectangle.parameters"></a><h4>Parameters</h4>
923 <div class="informaltable"><table class="informaltable" width="100%" border="0">
924 <colgroup>
925 <col width="150px" class="parameters_name">
926 <col class="parameters_description">
927 <col width="200px" class="parameters_annotations">
928 </colgroup>
929 <tbody>
930 <tr>
931 <td class="parameter_name"><p>surface</p></td>
932 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
933 <td class="parameter_annotations"> </td>
934 </tr>
935 <tr>
936 <td class="parameter_name"><p>x</p></td>
937 <td class="parameter_description"><p>X coordinate of dirty rectangle</p></td>
938 <td class="parameter_annotations"> </td>
939 </tr>
940 <tr>
941 <td class="parameter_name"><p>y</p></td>
942 <td class="parameter_description"><p>Y coordinate of dirty rectangle</p></td>
943 <td class="parameter_annotations"> </td>
944 </tr>
945 <tr>
946 <td class="parameter_name"><p>width</p></td>
947 <td class="parameter_description"><p>width of dirty rectangle</p></td>
948 <td class="parameter_annotations"> </td>
949 </tr>
950 <tr>
951 <td class="parameter_name"><p>height</p></td>
952 <td class="parameter_description"><p>height of dirty rectangle</p></td>
953 <td class="parameter_annotations"> </td>
954 </tr>
955 </tbody>
956 </table></div>
957 </div>
958 <p class="since">Since: 1.0</p>
959 </div>
960 <hr>
961 <div class="refsect2">
962 <a name="cairo-surface-set-device-offset"></a><h3>cairo_surface_set_device_offset ()</h3>
963 <pre class="programlisting"><span class="returnvalue">void</span>
964 cairo_surface_set_device_offset (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>,
965 <em class="parameter"><code><span class="type">double</span> x_offset</code></em>,
966 <em class="parameter"><code><span class="type">double</span> y_offset</code></em>);</pre>
967 <p>Sets an offset that is added to the device coordinates determined
968 by the CTM when drawing to <em class="parameter"><code>surface</code></em>
969 . One use case for this function
970 is when we want to create a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> that redirects drawing
971 for a portion of an onscreen surface to an offscreen surface in a
972 way that is completely invisible to the user of the cairo
973 API. Setting a transformation via <a class="link" href="cairo-Transformations.html#cairo-translate" title="cairo_translate ()"><code class="function">cairo_translate()</code></a> isn't
974 sufficient to do this, since functions like
975 <a class="link" href="cairo-Transformations.html#cairo-device-to-user" title="cairo_device_to_user ()"><code class="function">cairo_device_to_user()</code></a> will expose the hidden offset.</p>
976 <p>Note that the offset affects drawing to the surface as well as
977 using the surface in a source pattern.</p>
978 <div class="refsect3">
979 <a name="cairo-surface-set-device-offset.parameters"></a><h4>Parameters</h4>
980 <div class="informaltable"><table class="informaltable" width="100%" border="0">
981 <colgroup>
982 <col width="150px" class="parameters_name">
983 <col class="parameters_description">
984 <col width="200px" class="parameters_annotations">
985 </colgroup>
986 <tbody>
987 <tr>
988 <td class="parameter_name"><p>surface</p></td>
989 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
990 <td class="parameter_annotations"> </td>
991 </tr>
992 <tr>
993 <td class="parameter_name"><p>x_offset</p></td>
994 <td class="parameter_description"><p>the offset in the X direction, in device units</p></td>
995 <td class="parameter_annotations"> </td>
996 </tr>
997 <tr>
998 <td class="parameter_name"><p>y_offset</p></td>
999 <td class="parameter_description"><p>the offset in the Y direction, in device units</p></td>
1000 <td class="parameter_annotations"> </td>
1001 </tr>
1002 </tbody>
1003 </table></div>
1004 </div>
1005 <p class="since">Since: 1.0</p>
1006 </div>
1007 <hr>
1008 <div class="refsect2">
1009 <a name="cairo-surface-get-device-offset"></a><h3>cairo_surface_get_device_offset ()</h3>
1010 <pre class="programlisting"><span class="returnvalue">void</span>
1011 cairo_surface_get_device_offset (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>,
1012 <em class="parameter"><code><span class="type">double</span> *x_offset</code></em>,
1013 <em class="parameter"><code><span class="type">double</span> *y_offset</code></em>);</pre>
1014 <p>This function returns the previous device offset set by
1015 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-set-device-offset" title="cairo_surface_set_device_offset ()"><code class="function">cairo_surface_set_device_offset()</code></a>.</p>
1016 <div class="refsect3">
1017 <a name="cairo-surface-get-device-offset.parameters"></a><h4>Parameters</h4>
1018 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1019 <colgroup>
1020 <col width="150px" class="parameters_name">
1021 <col class="parameters_description">
1022 <col width="200px" class="parameters_annotations">
1023 </colgroup>
1024 <tbody>
1025 <tr>
1026 <td class="parameter_name"><p>surface</p></td>
1027 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
1028 <td class="parameter_annotations"> </td>
1029 </tr>
1030 <tr>
1031 <td class="parameter_name"><p>x_offset</p></td>
1032 <td class="parameter_description"><p>the offset in the X direction, in device units</p></td>
1033 <td class="parameter_annotations"> </td>
1034 </tr>
1035 <tr>
1036 <td class="parameter_name"><p>y_offset</p></td>
1037 <td class="parameter_description"><p>the offset in the Y direction, in device units</p></td>
1038 <td class="parameter_annotations"> </td>
1039 </tr>
1040 </tbody>
1041 </table></div>
1042 </div>
1043 <p class="since">Since: 1.2</p>
1044 </div>
1045 <hr>
1046 <div class="refsect2">
1047 <a name="cairo-surface-get-device-scale"></a><h3>cairo_surface_get_device_scale ()</h3>
1048 <pre class="programlisting"><span class="returnvalue">void</span>
1049 cairo_surface_get_device_scale (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>,
1050 <em class="parameter"><code><span class="type">double</span> *x_scale</code></em>,
1051 <em class="parameter"><code><span class="type">double</span> *y_scale</code></em>);</pre>
1052 <p>This function returns the previous device offset set by
1053 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-set-device-scale" title="cairo_surface_set_device_scale ()"><code class="function">cairo_surface_set_device_scale()</code></a>.</p>
1054 <div class="refsect3">
1055 <a name="cairo-surface-get-device-scale.parameters"></a><h4>Parameters</h4>
1056 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1057 <colgroup>
1058 <col width="150px" class="parameters_name">
1059 <col class="parameters_description">
1060 <col width="200px" class="parameters_annotations">
1061 </colgroup>
1062 <tbody>
1063 <tr>
1064 <td class="parameter_name"><p>surface</p></td>
1065 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
1066 <td class="parameter_annotations"> </td>
1067 </tr>
1068 <tr>
1069 <td class="parameter_name"><p>x_scale</p></td>
1070 <td class="parameter_description"><p>the scale in the X direction, in device units</p></td>
1071 <td class="parameter_annotations"> </td>
1072 </tr>
1073 <tr>
1074 <td class="parameter_name"><p>y_scale</p></td>
1075 <td class="parameter_description"><p>the scale in the Y direction, in device units</p></td>
1076 <td class="parameter_annotations"> </td>
1077 </tr>
1078 </tbody>
1079 </table></div>
1080 </div>
1081 <p class="since">Since: 1.14</p>
1082 </div>
1083 <hr>
1084 <div class="refsect2">
1085 <a name="cairo-surface-set-device-scale"></a><h3>cairo_surface_set_device_scale ()</h3>
1086 <pre class="programlisting"><span class="returnvalue">void</span>
1087 cairo_surface_set_device_scale (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>,
1088 <em class="parameter"><code><span class="type">double</span> x_scale</code></em>,
1089 <em class="parameter"><code><span class="type">double</span> y_scale</code></em>);</pre>
1090 <p>Sets a scale that is multiplied to the device coordinates determined
1091 by the CTM when drawing to <em class="parameter"><code>surface</code></em>
1092 . One common use for this is to
1093 render to very high resolution display devices at a scale factor, so
1094 that code that assumes 1 pixel will be a certain size will still work.
1095 Setting a transformation via <a class="link" href="cairo-Transformations.html#cairo-translate" title="cairo_translate ()"><code class="function">cairo_translate()</code></a> isn't
1096 sufficient to do this, since functions like
1097 <a class="link" href="cairo-Transformations.html#cairo-device-to-user" title="cairo_device_to_user ()"><code class="function">cairo_device_to_user()</code></a> will expose the hidden scale.</p>
1098 <p>Note that the scale affects drawing to the surface as well as
1099 using the surface in a source pattern.</p>
1100 <div class="refsect3">
1101 <a name="cairo-surface-set-device-scale.parameters"></a><h4>Parameters</h4>
1102 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1103 <colgroup>
1104 <col width="150px" class="parameters_name">
1105 <col class="parameters_description">
1106 <col width="200px" class="parameters_annotations">
1107 </colgroup>
1108 <tbody>
1109 <tr>
1110 <td class="parameter_name"><p>surface</p></td>
1111 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
1112 <td class="parameter_annotations"> </td>
1113 </tr>
1114 <tr>
1115 <td class="parameter_name"><p>x_scale</p></td>
1116 <td class="parameter_description"><p>a scale factor in the X direction</p></td>
1117 <td class="parameter_annotations"> </td>
1118 </tr>
1119 <tr>
1120 <td class="parameter_name"><p>y_scale</p></td>
1121 <td class="parameter_description"><p>a scale factor in the Y direction</p></td>
1122 <td class="parameter_annotations"> </td>
1123 </tr>
1124 </tbody>
1125 </table></div>
1126 </div>
1127 <p class="since">Since: 1.14</p>
1128 </div>
1129 <hr>
1130 <div class="refsect2">
1131 <a name="cairo-surface-set-fallback-resolution"></a><h3>cairo_surface_set_fallback_resolution ()</h3>
1132 <pre class="programlisting"><span class="returnvalue">void</span>
1133 cairo_surface_set_fallback_resolution (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>,
1134 <em class="parameter"><code><span class="type">double</span> x_pixels_per_inch</code></em>,
1135 <em class="parameter"><code><span class="type">double</span> y_pixels_per_inch</code></em>);</pre>
1136 <p>Set the horizontal and vertical resolution for image fallbacks.</p>
1137 <p>When certain operations aren't supported natively by a backend,
1138 cairo will fallback by rendering operations to an image and then
1139 overlaying that image onto the output. For backends that are
1140 natively vector-oriented, this function can be used to set the
1141 resolution used for these image fallbacks, (larger values will
1142 result in more detailed images, but also larger file sizes).</p>
1143 <p>Some examples of natively vector-oriented backends are the ps, pdf,
1144 and svg backends.</p>
1145 <p>For backends that are natively raster-oriented, image fallbacks are
1146 still possible, but they are always performed at the native
1147 device resolution. So this function has no effect on those
1148 backends.</p>
1149 <p>Note: The fallback resolution only takes effect at the time of
1150 completing a page (with <a class="link" href="cairo-cairo-t.html#cairo-show-page" title="cairo_show_page ()"><code class="function">cairo_show_page()</code></a> or <a class="link" href="cairo-cairo-t.html#cairo-copy-page" title="cairo_copy_page ()"><code class="function">cairo_copy_page()</code></a>) so
1151 there is currently no way to have more than one fallback resolution
1152 in effect on a single page.</p>
1153 <p>The default fallback resoultion is 300 pixels per inch in both
1154 dimensions.</p>
1155 <div class="refsect3">
1156 <a name="cairo-surface-set-fallback-resolution.parameters"></a><h4>Parameters</h4>
1157 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1158 <colgroup>
1159 <col width="150px" class="parameters_name">
1160 <col class="parameters_description">
1161 <col width="200px" class="parameters_annotations">
1162 </colgroup>
1163 <tbody>
1164 <tr>
1165 <td class="parameter_name"><p>surface</p></td>
1166 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
1167 <td class="parameter_annotations"> </td>
1168 </tr>
1169 <tr>
1170 <td class="parameter_name"><p>x_pixels_per_inch</p></td>
1171 <td class="parameter_description"><p>horizontal setting for pixels per inch</p></td>
1172 <td class="parameter_annotations"> </td>
1173 </tr>
1174 <tr>
1175 <td class="parameter_name"><p>y_pixels_per_inch</p></td>
1176 <td class="parameter_description"><p>vertical setting for pixels per inch</p></td>
1177 <td class="parameter_annotations"> </td>
1178 </tr>
1179 </tbody>
1180 </table></div>
1181 </div>
1182 <p class="since">Since: 1.2</p>
1183 </div>
1184 <hr>
1185 <div class="refsect2">
1186 <a name="cairo-surface-get-fallback-resolution"></a><h3>cairo_surface_get_fallback_resolution ()</h3>
1187 <pre class="programlisting"><span class="returnvalue">void</span>
1188 cairo_surface_get_fallback_resolution (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>,
1189 <em class="parameter"><code><span class="type">double</span> *x_pixels_per_inch</code></em>,
1190 <em class="parameter"><code><span class="type">double</span> *y_pixels_per_inch</code></em>);</pre>
1191 <p>This function returns the previous fallback resolution set by
1192 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-set-fallback-resolution" title="cairo_surface_set_fallback_resolution ()"><code class="function">cairo_surface_set_fallback_resolution()</code></a>, or default fallback
1193 resolution if never set.</p>
1194 <div class="refsect3">
1195 <a name="cairo-surface-get-fallback-resolution.parameters"></a><h4>Parameters</h4>
1196 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1197 <colgroup>
1198 <col width="150px" class="parameters_name">
1199 <col class="parameters_description">
1200 <col width="200px" class="parameters_annotations">
1201 </colgroup>
1202 <tbody>
1203 <tr>
1204 <td class="parameter_name"><p>surface</p></td>
1205 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
1206 <td class="parameter_annotations"> </td>
1207 </tr>
1208 <tr>
1209 <td class="parameter_name"><p>x_pixels_per_inch</p></td>
1210 <td class="parameter_description"><p>horizontal pixels per inch</p></td>
1211 <td class="parameter_annotations"> </td>
1212 </tr>
1213 <tr>
1214 <td class="parameter_name"><p>y_pixels_per_inch</p></td>
1215 <td class="parameter_description"><p>vertical pixels per inch</p></td>
1216 <td class="parameter_annotations"> </td>
1217 </tr>
1218 </tbody>
1219 </table></div>
1220 </div>
1221 <p class="since">Since: 1.8</p>
1222 </div>
1223 <hr>
1224 <div class="refsect2">
1225 <a name="cairo-surface-get-type"></a><h3>cairo_surface_get_type ()</h3>
1226 <pre class="programlisting"><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-type-t" title="enum cairo_surface_type_t"><span class="returnvalue">cairo_surface_type_t</span></a>
1227 cairo_surface_get_type (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);</pre>
1228 <p>This function returns the type of the backend used to create
1229 a surface. See <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-type-t" title="enum cairo_surface_type_t"><span class="type">cairo_surface_type_t</span></a> for available types.</p>
1230 <div class="refsect3">
1231 <a name="cairo-surface-get-type.parameters"></a><h4>Parameters</h4>
1232 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1233 <colgroup>
1234 <col width="150px" class="parameters_name">
1235 <col class="parameters_description">
1236 <col width="200px" class="parameters_annotations">
1237 </colgroup>
1238 <tbody><tr>
1239 <td class="parameter_name"><p>surface</p></td>
1240 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
1241 <td class="parameter_annotations"> </td>
1242 </tr></tbody>
1243 </table></div>
1244 </div>
1245 <div class="refsect3">
1246 <a name="cairo-surface-get-type.returns"></a><h4>Returns</h4>
1247 <p> The type of <em class="parameter"><code>surface</code></em>
1248 .</p>
1249 </div>
1250 <p class="since">Since: 1.2</p>
1251 </div>
1252 <hr>
1253 <div class="refsect2">
1254 <a name="cairo-surface-get-reference-count"></a><h3>cairo_surface_get_reference_count ()</h3>
1255 <pre class="programlisting">unsigned <span class="returnvalue">int</span>
1256 cairo_surface_get_reference_count (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);</pre>
1257 <p>Returns the current reference count of <em class="parameter"><code>surface</code></em>
1258 .</p>
1259 <div class="refsect3">
1260 <a name="cairo-surface-get-reference-count.parameters"></a><h4>Parameters</h4>
1261 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1262 <colgroup>
1263 <col width="150px" class="parameters_name">
1264 <col class="parameters_description">
1265 <col width="200px" class="parameters_annotations">
1266 </colgroup>
1267 <tbody><tr>
1268 <td class="parameter_name"><p>surface</p></td>
1269 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
1270 <td class="parameter_annotations"> </td>
1271 </tr></tbody>
1272 </table></div>
1273 </div>
1274 <div class="refsect3">
1275 <a name="cairo-surface-get-reference-count.returns"></a><h4>Returns</h4>
1276 <p> the current reference count of <em class="parameter"><code>surface</code></em>
1277 . If the
1278 object is a nil object, 0 will be returned.</p>
1279 </div>
1280 <p class="since">Since: 1.4</p>
1281 </div>
1282 <hr>
1283 <div class="refsect2">
1284 <a name="cairo-surface-set-user-data"></a><h3>cairo_surface_set_user_data ()</h3>
1285 <pre class="programlisting"><a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
1286 cairo_surface_set_user_data (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>,
1287 <em class="parameter"><code>const <a class="link" href="cairo-Types.html#cairo-user-data-key-t" title="cairo_user_data_key_t"><span class="type">cairo_user_data_key_t</span></a> *key</code></em>,
1288 <em class="parameter"><code><span class="type">void</span> *user_data</code></em>,
1289 <em class="parameter"><code><a class="link" href="cairo-Types.html#cairo-destroy-func-t" title="cairo_destroy_func_t ()"><span class="type">cairo_destroy_func_t</span></a> destroy</code></em>);</pre>
1290 <p>Attach user data to <em class="parameter"><code>surface</code></em>
1291 . To remove user data from a surface,
1292 call this function with the key that was used to set it and <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
1293 for <em class="parameter"><code>data</code></em>
1294 .</p>
1295 <div class="refsect3">
1296 <a name="cairo-surface-set-user-data.parameters"></a><h4>Parameters</h4>
1297 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1298 <colgroup>
1299 <col width="150px" class="parameters_name">
1300 <col class="parameters_description">
1301 <col width="200px" class="parameters_annotations">
1302 </colgroup>
1303 <tbody>
1304 <tr>
1305 <td class="parameter_name"><p>surface</p></td>
1306 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
1307 <td class="parameter_annotations"> </td>
1308 </tr>
1309 <tr>
1310 <td class="parameter_name"><p>key</p></td>
1311 <td class="parameter_description"><p>the address of a <a class="link" href="cairo-Types.html#cairo-user-data-key-t" title="cairo_user_data_key_t"><span class="type">cairo_user_data_key_t</span></a> to attach the user data to</p></td>
1312 <td class="parameter_annotations"> </td>
1313 </tr>
1314 <tr>
1315 <td class="parameter_name"><p>user_data</p></td>
1316 <td class="parameter_description"><p>the user data to attach to the surface</p></td>
1317 <td class="parameter_annotations"> </td>
1318 </tr>
1319 <tr>
1320 <td class="parameter_name"><p>destroy</p></td>
1321 <td class="parameter_description"><p>a <a class="link" href="cairo-Types.html#cairo-destroy-func-t" title="cairo_destroy_func_t ()"><span class="type">cairo_destroy_func_t</span></a> which will be called when the
1322 surface is destroyed or when new user data is attached using the
1323 same key.</p></td>
1324 <td class="parameter_annotations"> </td>
1325 </tr>
1326 </tbody>
1327 </table></div>
1328 </div>
1329 <div class="refsect3">
1330 <a name="cairo-surface-set-user-data.returns"></a><h4>Returns</h4>
1331 <p> <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-SUCCESS:CAPS"><code class="literal">CAIRO_STATUS_SUCCESS</code></a> or <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-NO-MEMORY:CAPS"><code class="literal">CAIRO_STATUS_NO_MEMORY</code></a> if a
1332 slot could not be allocated for the user data.</p>
1333 </div>
1334 <p class="since">Since: 1.0</p>
1335 </div>
1336 <hr>
1337 <div class="refsect2">
1338 <a name="cairo-surface-get-user-data"></a><h3>cairo_surface_get_user_data ()</h3>
1339 <pre class="programlisting"><span class="returnvalue">void</span> *
1340 cairo_surface_get_user_data (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>,
1341 <em class="parameter"><code>const <a class="link" href="cairo-Types.html#cairo-user-data-key-t" title="cairo_user_data_key_t"><span class="type">cairo_user_data_key_t</span></a> *key</code></em>);</pre>
1342 <p>Return user data previously attached to <em class="parameter"><code>surface</code></em>
1343 using the specified
1344 key. If no user data has been attached with the given key this
1345 function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
1346 <div class="refsect3">
1347 <a name="cairo-surface-get-user-data.parameters"></a><h4>Parameters</h4>
1348 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1349 <colgroup>
1350 <col width="150px" class="parameters_name">
1351 <col class="parameters_description">
1352 <col width="200px" class="parameters_annotations">
1353 </colgroup>
1354 <tbody>
1355 <tr>
1356 <td class="parameter_name"><p>surface</p></td>
1357 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
1358 <td class="parameter_annotations"> </td>
1359 </tr>
1360 <tr>
1361 <td class="parameter_name"><p>key</p></td>
1362 <td class="parameter_description"><p>the address of the <a class="link" href="cairo-Types.html#cairo-user-data-key-t" title="cairo_user_data_key_t"><span class="type">cairo_user_data_key_t</span></a> the user data was
1363 attached to</p></td>
1364 <td class="parameter_annotations"> </td>
1365 </tr>
1366 </tbody>
1367 </table></div>
1368 </div>
1369 <div class="refsect3">
1370 <a name="cairo-surface-get-user-data.returns"></a><h4>Returns</h4>
1371 <p> the user data previously attached or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
1372 </div>
1373 <p class="since">Since: 1.0</p>
1374 </div>
1375 <hr>
1376 <div class="refsect2">
1377 <a name="cairo-surface-copy-page"></a><h3>cairo_surface_copy_page ()</h3>
1378 <pre class="programlisting"><span class="returnvalue">void</span>
1379 cairo_surface_copy_page (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);</pre>
1380 <p>Emits the current page for backends that support multiple pages,
1381 but doesn't clear it, so that the contents of the current page will
1382 be retained for the next page. Use <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-show-page" title="cairo_surface_show_page ()"><code class="function">cairo_surface_show_page()</code></a> if you
1383 want to get an empty page after the emission.</p>
1384 <p>There is a convenience function for this that takes a <a class="link" href="cairo-cairo-t.html#cairo-t" title="cairo_t"><span class="type">cairo_t</span></a>,
1385 namely <a class="link" href="cairo-cairo-t.html#cairo-copy-page" title="cairo_copy_page ()"><code class="function">cairo_copy_page()</code></a>.</p>
1386 <div class="refsect3">
1387 <a name="cairo-surface-copy-page.parameters"></a><h4>Parameters</h4>
1388 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1389 <colgroup>
1390 <col width="150px" class="parameters_name">
1391 <col class="parameters_description">
1392 <col width="200px" class="parameters_annotations">
1393 </colgroup>
1394 <tbody><tr>
1395 <td class="parameter_name"><p>surface</p></td>
1396 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
1397 <td class="parameter_annotations"> </td>
1398 </tr></tbody>
1399 </table></div>
1400 </div>
1401 <p class="since">Since: 1.6</p>
1402 </div>
1403 <hr>
1404 <div class="refsect2">
1405 <a name="cairo-surface-show-page"></a><h3>cairo_surface_show_page ()</h3>
1406 <pre class="programlisting"><span class="returnvalue">void</span>
1407 cairo_surface_show_page (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);</pre>
1408 <p>Emits and clears the current page for backends that support multiple
1409 pages. Use <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-copy-page" title="cairo_surface_copy_page ()"><code class="function">cairo_surface_copy_page()</code></a> if you don't want to clear the page.</p>
1410 <p>There is a convenience function for this that takes a <a class="link" href="cairo-cairo-t.html#cairo-t" title="cairo_t"><span class="type">cairo_t</span></a>,
1411 namely <a class="link" href="cairo-cairo-t.html#cairo-show-page" title="cairo_show_page ()"><code class="function">cairo_show_page()</code></a>.</p>
1412 <div class="refsect3">
1413 <a name="cairo-surface-show-page.parameters"></a><h4>Parameters</h4>
1414 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1415 <colgroup>
1416 <col width="150px" class="parameters_name">
1417 <col class="parameters_description">
1418 <col width="200px" class="parameters_annotations">
1419 </colgroup>
1420 <tbody><tr>
1421 <td class="parameter_name"><p>surface</p></td>
1422 <td class="parameter_description"><p>a <span class="type">cairo_Surface_t</span></p></td>
1423 <td class="parameter_annotations"> </td>
1424 </tr></tbody>
1425 </table></div>
1426 </div>
1427 <p class="since">Since: 1.6</p>
1428 </div>
1429 <hr>
1430 <div class="refsect2">
1431 <a name="cairo-surface-has-show-text-glyphs"></a><h3>cairo_surface_has_show_text_glyphs ()</h3>
1432 <pre class="programlisting"><a class="link" href="cairo-Types.html#cairo-bool-t" title="cairo_bool_t"><span class="returnvalue">cairo_bool_t</span></a>
1433 cairo_surface_has_show_text_glyphs (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);</pre>
1434 <p>Returns whether the surface supports
1435 sophisticated <a class="link" href="cairo-text.html#cairo-show-text-glyphs" title="cairo_show_text_glyphs ()"><code class="function">cairo_show_text_glyphs()</code></a> operations. That is,
1436 whether it actually uses the provided text and cluster data
1437 to a <a class="link" href="cairo-text.html#cairo-show-text-glyphs" title="cairo_show_text_glyphs ()"><code class="function">cairo_show_text_glyphs()</code></a> call.</p>
1438 <p>Note: Even if this function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, a
1439 <a class="link" href="cairo-text.html#cairo-show-text-glyphs" title="cairo_show_text_glyphs ()"><code class="function">cairo_show_text_glyphs()</code></a> operation targeted at <em class="parameter"><code>surface</code></em>
1440 will
1441 still succeed. It just will
1442 act like a <a class="link" href="cairo-text.html#cairo-show-glyphs" title="cairo_show_glyphs ()"><code class="function">cairo_show_glyphs()</code></a> operation. Users can use this
1443 function to avoid computing UTF-8 text and cluster mapping if the
1444 target surface does not use it.</p>
1445 <div class="refsect3">
1446 <a name="cairo-surface-has-show-text-glyphs.parameters"></a><h4>Parameters</h4>
1447 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1448 <colgroup>
1449 <col width="150px" class="parameters_name">
1450 <col class="parameters_description">
1451 <col width="200px" class="parameters_annotations">
1452 </colgroup>
1453 <tbody><tr>
1454 <td class="parameter_name"><p>surface</p></td>
1455 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
1456 <td class="parameter_annotations"> </td>
1457 </tr></tbody>
1458 </table></div>
1459 </div>
1460 <div class="refsect3">
1461 <a name="cairo-surface-has-show-text-glyphs.returns"></a><h4>Returns</h4>
1462 <p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>surface</code></em>
1463 supports
1464 <a class="link" href="cairo-text.html#cairo-show-text-glyphs" title="cairo_show_text_glyphs ()"><code class="function">cairo_show_text_glyphs()</code></a>, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
1465 </div>
1466 <p class="since">Since: 1.8</p>
1467 </div>
1468 <hr>
1469 <div class="refsect2">
1470 <a name="cairo-surface-set-mime-data"></a><h3>cairo_surface_set_mime_data ()</h3>
1471 <pre class="programlisting"><a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
1472 cairo_surface_set_mime_data (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>,
1473 <em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>,
1474 <em class="parameter"><code>const unsigned <span class="type">char</span> *data</code></em>,
1475 <em class="parameter"><code><span class="type">unsigned long </span> length</code></em>,
1476 <em class="parameter"><code><a class="link" href="cairo-Types.html#cairo-destroy-func-t" title="cairo_destroy_func_t ()"><span class="type">cairo_destroy_func_t</span></a> destroy</code></em>,
1477 <em class="parameter"><code><span class="type">void</span> *closure</code></em>);</pre>
1478 <p>Attach an image in the format <em class="parameter"><code>mime_type</code></em>
1479 to <em class="parameter"><code>surface</code></em>
1480 . To remove
1481 the data from a surface, call this function with same mime type
1482 and <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for <em class="parameter"><code>data</code></em>
1483 .</p>
1484 <p>The attached image (or filename) data can later be used by backends
1485 which support it (currently: PDF, PS, SVG and Win32 Printing
1486 surfaces) to emit this data instead of making a snapshot of the
1487 <em class="parameter"><code>surface</code></em>
1488 . This approach tends to be faster and requires less
1489 memory and disk space.</p>
1490 <p>The recognized MIME types are the following: <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JPEG:CAPS" title="CAIRO_MIME_TYPE_JPEG"><code class="literal">CAIRO_MIME_TYPE_JPEG</code></a>,
1491 <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-PNG:CAPS" title="CAIRO_MIME_TYPE_PNG"><code class="literal">CAIRO_MIME_TYPE_PNG</code></a>, <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JP2:CAPS" title="CAIRO_MIME_TYPE_JP2"><code class="literal">CAIRO_MIME_TYPE_JP2</code></a>, <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-URI:CAPS" title="CAIRO_MIME_TYPE_URI"><code class="literal">CAIRO_MIME_TYPE_URI</code></a>,
1492 <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-UNIQUE-ID:CAPS" title="CAIRO_MIME_TYPE_UNIQUE_ID"><code class="literal">CAIRO_MIME_TYPE_UNIQUE_ID</code></a>, <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JBIG2:CAPS" title="CAIRO_MIME_TYPE_JBIG2"><code class="literal">CAIRO_MIME_TYPE_JBIG2</code></a>,
1493 <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JBIG2-GLOBAL:CAPS" title="CAIRO_MIME_TYPE_JBIG2_GLOBAL"><code class="literal">CAIRO_MIME_TYPE_JBIG2_GLOBAL</code></a>, <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-JBIG2-GLOBAL-ID:CAPS" title="CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID"><code class="literal">CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID</code></a>,
1494 <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-CCITT-FAX:CAPS" title="CAIRO_MIME_TYPE_CCITT_FAX"><code class="literal">CAIRO_MIME_TYPE_CCITT_FAX</code></a>, <a class="link" href="cairo-cairo-surface-t.html#CAIRO-MIME-TYPE-CCITT-FAX-PARAMS:CAPS" title="CAIRO_MIME_TYPE_CCITT_FAX_PARAMS"><code class="literal">CAIRO_MIME_TYPE_CCITT_FAX_PARAMS</code></a>.</p>
1495 <p>See corresponding backend surface docs for details about which MIME
1496 types it can handle. Caution: the associated MIME data will be
1497 discarded if you draw on the surface afterwards. Use this function
1498 with care.</p>
1499 <p>Even if a backend supports a MIME type, that does not mean cairo
1500 will always be able to use the attached MIME data. For example, if
1501 the backend does not natively support the compositing operation used
1502 to apply the MIME data to the backend. In that case, the MIME data
1503 will be ignored. Therefore, to apply an image in all cases, it is best
1504 to create an image surface which contains the decoded image data and
1505 then attach the MIME data to that. This ensures the image will always
1506 be used while still allowing the MIME data to be used whenever
1507 possible.</p>
1508 <div class="refsect3">
1509 <a name="cairo-surface-set-mime-data.parameters"></a><h4>Parameters</h4>
1510 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1511 <colgroup>
1512 <col width="150px" class="parameters_name">
1513 <col class="parameters_description">
1514 <col width="200px" class="parameters_annotations">
1515 </colgroup>
1516 <tbody>
1517 <tr>
1518 <td class="parameter_name"><p>surface</p></td>
1519 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
1520 <td class="parameter_annotations"> </td>
1521 </tr>
1522 <tr>
1523 <td class="parameter_name"><p>mime_type</p></td>
1524 <td class="parameter_description"><p>the MIME type of the image data</p></td>
1525 <td class="parameter_annotations"> </td>
1526 </tr>
1527 <tr>
1528 <td class="parameter_name"><p>data</p></td>
1529 <td class="parameter_description"><p>the image data to attach to the surface</p></td>
1530 <td class="parameter_annotations"> </td>
1531 </tr>
1532 <tr>
1533 <td class="parameter_name"><p>length</p></td>
1534 <td class="parameter_description"><p>the length of the image data</p></td>
1535 <td class="parameter_annotations"> </td>
1536 </tr>
1537 <tr>
1538 <td class="parameter_name"><p>destroy</p></td>
1539 <td class="parameter_description"><p>a <a class="link" href="cairo-Types.html#cairo-destroy-func-t" title="cairo_destroy_func_t ()"><span class="type">cairo_destroy_func_t</span></a> which will be called when the
1540 surface is destroyed or when new image data is attached using the
1541 same mime type.</p></td>
1542 <td class="parameter_annotations"> </td>
1543 </tr>
1544 <tr>
1545 <td class="parameter_name"><p>closure</p></td>
1546 <td class="parameter_description"><p>the data to be passed to the <em class="parameter"><code>destroy</code></em>
1547 notifier</p></td>
1548 <td class="parameter_annotations"> </td>
1549 </tr>
1550 </tbody>
1551 </table></div>
1552 </div>
1553 <div class="refsect3">
1554 <a name="cairo-surface-set-mime-data.returns"></a><h4>Returns</h4>
1555 <p> <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-SUCCESS:CAPS"><code class="literal">CAIRO_STATUS_SUCCESS</code></a> or <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-NO-MEMORY:CAPS"><code class="literal">CAIRO_STATUS_NO_MEMORY</code></a> if a
1556 slot could not be allocated for the user data.</p>
1557 </div>
1558 <p class="since">Since: 1.10</p>
1559 </div>
1560 <hr>
1561 <div class="refsect2">
1562 <a name="cairo-surface-get-mime-data"></a><h3>cairo_surface_get_mime_data ()</h3>
1563 <pre class="programlisting"><span class="returnvalue">void</span>
1564 cairo_surface_get_mime_data (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>,
1565 <em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>,
1566 <em class="parameter"><code>const unsigned <span class="type">char</span> **data</code></em>,
1567 <em class="parameter"><code>unsigned <span class="type">long</span> *length</code></em>);</pre>
1568 <p>Return mime data previously attached to <em class="parameter"><code>surface</code></em>
1569 using the
1570 specified mime type. If no data has been attached with the given
1571 mime type, <em class="parameter"><code>data</code></em>
1572 is set <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
1573 <div class="refsect3">
1574 <a name="cairo-surface-get-mime-data.parameters"></a><h4>Parameters</h4>
1575 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1576 <colgroup>
1577 <col width="150px" class="parameters_name">
1578 <col class="parameters_description">
1579 <col width="200px" class="parameters_annotations">
1580 </colgroup>
1581 <tbody>
1582 <tr>
1583 <td class="parameter_name"><p>surface</p></td>
1584 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
1585 <td class="parameter_annotations"> </td>
1586 </tr>
1587 <tr>
1588 <td class="parameter_name"><p>mime_type</p></td>
1589 <td class="parameter_description"><p>the mime type of the image data</p></td>
1590 <td class="parameter_annotations"> </td>
1591 </tr>
1592 <tr>
1593 <td class="parameter_name"><p>data</p></td>
1594 <td class="parameter_description"><p>the image data to attached to the surface</p></td>
1595 <td class="parameter_annotations"> </td>
1596 </tr>
1597 <tr>
1598 <td class="parameter_name"><p>length</p></td>
1599 <td class="parameter_description"><p>the length of the image data</p></td>
1600 <td class="parameter_annotations"> </td>
1601 </tr>
1602 </tbody>
1603 </table></div>
1604 </div>
1605 <p class="since">Since: 1.10</p>
1606 </div>
1607 <hr>
1608 <div class="refsect2">
1609 <a name="cairo-surface-supports-mime-type"></a><h3>cairo_surface_supports_mime_type ()</h3>
1610 <pre class="programlisting"><a class="link" href="cairo-Types.html#cairo-bool-t" title="cairo_bool_t"><span class="returnvalue">cairo_bool_t</span></a>
1611 cairo_surface_supports_mime_type (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>,
1612 <em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>);</pre>
1613 <p>Return whether <em class="parameter"><code>surface</code></em>
1614 supports <em class="parameter"><code>mime_type</code></em>
1615 .</p>
1616 <div class="refsect3">
1617 <a name="cairo-surface-supports-mime-type.parameters"></a><h4>Parameters</h4>
1618 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1619 <colgroup>
1620 <col width="150px" class="parameters_name">
1621 <col class="parameters_description">
1622 <col width="200px" class="parameters_annotations">
1623 </colgroup>
1624 <tbody>
1625 <tr>
1626 <td class="parameter_name"><p>surface</p></td>
1627 <td class="parameter_description"><p>a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p></td>
1628 <td class="parameter_annotations"> </td>
1629 </tr>
1630 <tr>
1631 <td class="parameter_name"><p>mime_type</p></td>
1632 <td class="parameter_description"><p>the mime type</p></td>
1633 <td class="parameter_annotations"> </td>
1634 </tr>
1635 </tbody>
1636 </table></div>
1637 </div>
1638 <div class="refsect3">
1639 <a name="cairo-surface-supports-mime-type.returns"></a><h4>Returns</h4>
1640 <p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>surface</code></em>
1641 supports
1642 <em class="parameter"><code>mime_type</code></em>
1643 , <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
1644 </div>
1645 <p class="since">Since: 1.12</p>
1646 </div>
1647 <hr>
1648 <div class="refsect2">
1649 <a name="cairo-surface-map-to-image"></a><h3>cairo_surface_map_to_image ()</h3>
1650 <pre class="programlisting"><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> *
1651 cairo_surface_map_to_image (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>,
1652 <em class="parameter"><code>const <a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t"><span class="type">cairo_rectangle_int_t</span></a> *extents</code></em>);</pre>
1653 <p>Returns an image surface that is the most efficient mechanism for
1654 modifying the backing store of the target surface. The region retrieved
1655 may be limited to the <em class="parameter"><code>extents</code></em>
1656 or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the whole surface</p>
1657 <p>Note, the use of the original surface as a target or source whilst
1658 it is mapped is undefined. The result of mapping the surface
1659 multiple times is undefined. Calling <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-destroy" title="cairo_surface_destroy ()"><code class="function">cairo_surface_destroy()</code></a> or
1660 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-finish" title="cairo_surface_finish ()"><code class="function">cairo_surface_finish()</code></a> on the resulting image surface results in
1661 undefined behavior. Changing the device transform of the image
1662 surface or of <em class="parameter"><code>surface</code></em>
1663 before the image surface is unmapped results
1664 in undefined behavior.</p>
1665 <div class="refsect3">
1666 <a name="cairo-surface-map-to-image.parameters"></a><h4>Parameters</h4>
1667 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1668 <colgroup>
1669 <col width="150px" class="parameters_name">
1670 <col class="parameters_description">
1671 <col width="200px" class="parameters_annotations">
1672 </colgroup>
1673 <tbody>
1674 <tr>
1675 <td class="parameter_name"><p>surface</p></td>
1676 <td class="parameter_description"><p>an existing surface used to extract the image from</p></td>
1677 <td class="parameter_annotations"> </td>
1678 </tr>
1679 <tr>
1680 <td class="parameter_name"><p>extents</p></td>
1681 <td class="parameter_description"><p>limit the extraction to an rectangular region</p></td>
1682 <td class="parameter_annotations"> </td>
1683 </tr>
1684 </tbody>
1685 </table></div>
1686 </div>
1687 <div class="refsect3">
1688 <a name="cairo-surface-map-to-image.returns"></a><h4>Returns</h4>
1689 <p> a pointer to the newly allocated image surface. The caller
1690 must use <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-unmap-image" title="cairo_surface_unmap_image ()"><code class="function">cairo_surface_unmap_image()</code></a> to destroy this image surface.</p>
1691 <p>This function always returns a valid pointer, but it will return a
1692 pointer to a "nil" surface if <em class="parameter"><code>other</code></em>
1693 is already in an error state
1694 or any other error occurs. If the returned pointer does not have an
1695 error status, it is guaranteed to be an image surface whose format
1696 is not <a class="link" href="cairo-Image-Surfaces.html#CAIRO-FORMAT-INVALID:CAPS"><code class="literal">CAIRO_FORMAT_INVALID</code></a>.</p>
1697 </div>
1698 <p class="since">Since: 1.12</p>
1699 </div>
1700 <hr>
1701 <div class="refsect2">
1702 <a name="cairo-surface-unmap-image"></a><h3>cairo_surface_unmap_image ()</h3>
1703 <pre class="programlisting"><span class="returnvalue">void</span>
1704 cairo_surface_unmap_image (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>,
1705 <em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *image</code></em>);</pre>
1706 <p>Unmaps the image surface as returned from <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-map-to-image" title="cairo_surface_map_to_image ()"><code class="function">cairo_surface_map_to_image()</code></a>.</p>
1707 <p>The content of the image will be uploaded to the target surface.
1708 Afterwards, the image is destroyed.</p>
1709 <p>Using an image surface which wasn't returned by <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-map-to-image" title="cairo_surface_map_to_image ()"><code class="function">cairo_surface_map_to_image()</code></a>
1710 results in undefined behavior.</p>
1711 <div class="refsect3">
1712 <a name="cairo-surface-unmap-image.parameters"></a><h4>Parameters</h4>
1713 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1714 <colgroup>
1715 <col width="150px" class="parameters_name">
1716 <col class="parameters_description">
1717 <col width="200px" class="parameters_annotations">
1718 </colgroup>
1719 <tbody>
1720 <tr>
1721 <td class="parameter_name"><p>surface</p></td>
1722 <td class="parameter_description"><p>the surface passed to <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-map-to-image" title="cairo_surface_map_to_image ()"><code class="function">cairo_surface_map_to_image()</code></a>.</p></td>
1723 <td class="parameter_annotations"> </td>
1724 </tr>
1725 <tr>
1726 <td class="parameter_name"><p>image</p></td>
1727 <td class="parameter_description"><p>the currently mapped image</p></td>
1728 <td class="parameter_annotations"> </td>
1729 </tr>
1730 </tbody>
1731 </table></div>
1732 </div>
1733 <p class="since">Since: 1.12</p>
1734 </div>
1735 </div>
1736 <div class="refsect1">
1737 <a name="cairo-cairo-surface-t.other_details"></a><h2>Types and Values</h2>
1738 <div class="refsect2">
1739 <a name="CAIRO-HAS-MIME-SURFACE:CAPS"></a><h3>CAIRO_HAS_MIME_SURFACE</h3>
1740 <pre class="programlisting">#define CAIRO_HAS_MIME_SURFACE 1
1741 </pre>
1742 </div>
1743 <hr>
1744 <div class="refsect2">
1745 <a name="CAIRO-MIME-TYPE-CCITT-FAX:CAPS"></a><h3>CAIRO_MIME_TYPE_CCITT_FAX</h3>
1746 <pre class="programlisting">#define CAIRO_MIME_TYPE_CCITT_FAX "image/g3fax"
1747 </pre>
1748 <p>Group 3 or Group 4 CCITT facsimile encoding (International
1749 Telecommunication Union, Recommendations T.4 and T.6.)</p>
1750 <p class="since">Since: 1.16</p>
1751 </div>
1752 <hr>
1753 <div class="refsect2">
1754 <a name="CAIRO-MIME-TYPE-CCITT-FAX-PARAMS:CAPS"></a><h3>CAIRO_MIME_TYPE_CCITT_FAX_PARAMS</h3>
1755 <pre class="programlisting">#define CAIRO_MIME_TYPE_CCITT_FAX_PARAMS "application/x-cairo.ccitt.params"
1756 </pre>
1757 <p>Decode parameters for Group 3 or Group 4 CCITT facsimile encoding.
1758 See <a class="link" href="cairo-PDF-Surfaces.html#ccitt" title="CCITT Fax Images">CCITT Fax Images</a>.</p>
1759 <p class="since">Since: 1.16</p>
1760 </div>
1761 <hr>
1762 <div class="refsect2">
1763 <a name="CAIRO-MIME-TYPE-EPS:CAPS"></a><h3>CAIRO_MIME_TYPE_EPS</h3>
1764 <pre class="programlisting">#define CAIRO_MIME_TYPE_EPS "application/postscript"
1765 </pre>
1766 <p>Encapsulated PostScript file.
1767 <a class="ulink" href="http://wwwimages.adobe.com/content/dam/Adobe/endevnet/postscript/pdfs/5002.EPSF_Spec.pdf" target="_top">Encapsulated PostScript File Format Specification</a></p>
1768 <p class="since">Since: 1.16</p>
1769 </div>
1770 <hr>
1771 <div class="refsect2">
1772 <a name="CAIRO-MIME-TYPE-EPS-PARAMS:CAPS"></a><h3>CAIRO_MIME_TYPE_EPS_PARAMS</h3>
1773 <pre class="programlisting">#define CAIRO_MIME_TYPE_EPS_PARAMS "application/x-cairo.eps.params"
1774 </pre>
1775 <p>Embedding parameters Encapsulated PostScript data.
1776 See <a class="link" href="cairo-PostScript-Surfaces.html#eps" title="Embedding EPS files">Embedding EPS files</a>.</p>
1777 <p class="since">Since: 1.16</p>
1778 </div>
1779 <hr>
1780 <div class="refsect2">
1781 <a name="CAIRO-MIME-TYPE-JBIG2:CAPS"></a><h3>CAIRO_MIME_TYPE_JBIG2</h3>
1782 <pre class="programlisting">#define CAIRO_MIME_TYPE_JBIG2 "application/x-cairo.jbig2"
1783 </pre>
1784 <p>Joint Bi-level Image Experts Group image coding standard (ISO/IEC 11544).</p>
1785 <p class="since">Since: 1.14</p>
1786 </div>
1787 <hr>
1788 <div class="refsect2">
1789 <a name="CAIRO-MIME-TYPE-JBIG2-GLOBAL:CAPS"></a><h3>CAIRO_MIME_TYPE_JBIG2_GLOBAL</h3>
1790 <pre class="programlisting">#define CAIRO_MIME_TYPE_JBIG2_GLOBAL "application/x-cairo.jbig2-global"
1791 </pre>
1792 <p>Joint Bi-level Image Experts Group image coding standard (ISO/IEC 11544) global segment.</p>
1793 <p class="since">Since: 1.14</p>
1794 </div>
1795 <hr>
1796 <div class="refsect2">
1797 <a name="CAIRO-MIME-TYPE-JBIG2-GLOBAL-ID:CAPS"></a><h3>CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID</h3>
1798 <pre class="programlisting">#define CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID "application/x-cairo.jbig2-global-id"
1799 </pre>
1800 <p>An unique identifier shared by a JBIG2 global segment and all JBIG2 images
1801 that depend on the global segment.</p>
1802 <p class="since">Since: 1.14</p>
1803 </div>
1804 <hr>
1805 <div class="refsect2">
1806 <a name="CAIRO-MIME-TYPE-JP2:CAPS"></a><h3>CAIRO_MIME_TYPE_JP2</h3>
1807 <pre class="programlisting">#define CAIRO_MIME_TYPE_JP2 "image/jp2"
1808 </pre>
1809 <p>The Joint Photographic Experts Group (JPEG) 2000 image coding standard (ISO/IEC 15444-1).</p>
1810 <p class="since">Since: 1.10</p>
1811 </div>
1812 <hr>
1813 <div class="refsect2">
1814 <a name="CAIRO-MIME-TYPE-JPEG:CAPS"></a><h3>CAIRO_MIME_TYPE_JPEG</h3>
1815 <pre class="programlisting">#define CAIRO_MIME_TYPE_JPEG "image/jpeg"
1816 </pre>
1817 <p>The Joint Photographic Experts Group (JPEG) image coding standard (ISO/IEC 10918-1).</p>
1818 <p class="since">Since: 1.10</p>
1819 </div>
1820 <hr>
1821 <div class="refsect2">
1822 <a name="CAIRO-MIME-TYPE-PNG:CAPS"></a><h3>CAIRO_MIME_TYPE_PNG</h3>
1823 <pre class="programlisting">#define CAIRO_MIME_TYPE_PNG "image/png"
1824 </pre>
1825 <p>The Portable Network Graphics image file format (ISO/IEC 15948).</p>
1826 <p class="since">Since: 1.10</p>
1827 </div>
1828 <hr>
1829 <div class="refsect2">
1830 <a name="CAIRO-MIME-TYPE-URI:CAPS"></a><h3>CAIRO_MIME_TYPE_URI</h3>
1831 <pre class="programlisting">#define CAIRO_MIME_TYPE_URI "text/x-uri"
1832 </pre>
1833 <p>URI for an image file (unofficial MIME type).</p>
1834 <p class="since">Since: 1.10</p>
1835 </div>
1836 <hr>
1837 <div class="refsect2">
1838 <a name="CAIRO-MIME-TYPE-UNIQUE-ID:CAPS"></a><h3>CAIRO_MIME_TYPE_UNIQUE_ID</h3>
1839 <pre class="programlisting">#define CAIRO_MIME_TYPE_UNIQUE_ID "application/x-cairo.uuid"
1840 </pre>
1841 <p>Unique identifier for a surface (cairo specific MIME type). All surfaces with
1842 the same unique identifier will only be embedded once.</p>
1843 <p class="since">Since: 1.12</p>
1844 </div>
1845 <hr>
1846 <div class="refsect2">
1847 <a name="cairo-surface-t"></a><h3>cairo_surface_t</h3>
1848 <pre class="programlisting">typedef struct _cairo_surface cairo_surface_t;
1849 </pre>
1850 <p>A <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> represents an image, either as the destination
1851 of a drawing operation or as source when drawing onto another
1852 surface. To draw to a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a>, create a cairo context
1853 with the surface as the target, using <a class="link" href="cairo-cairo-t.html#cairo-create" title="cairo_create ()"><code class="function">cairo_create()</code></a>.</p>
1854 <p>There are different subtypes of <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> for
1855 different drawing backends; for example, <a class="link" href="cairo-Image-Surfaces.html#cairo-image-surface-create" title="cairo_image_surface_create ()"><code class="function">cairo_image_surface_create()</code></a>
1856 creates a bitmap image in memory.
1857 The type of a surface can be queried with <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-type" title="cairo_surface_get_type ()"><code class="function">cairo_surface_get_type()</code></a>.</p>
1858 <p>The initial contents of a surface after creation depend upon the manner
1859 of its creation. If cairo creates the surface and backing storage for
1860 the user, it will be initially cleared; for example,
1861 <a class="link" href="cairo-Image-Surfaces.html#cairo-image-surface-create" title="cairo_image_surface_create ()"><code class="function">cairo_image_surface_create()</code></a> and <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-create-similar" title="cairo_surface_create_similar ()"><code class="function">cairo_surface_create_similar()</code></a>.
1862 Alternatively, if the user passes in a reference to some backing storage
1863 and asks cairo to wrap that in a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a>, then the contents are
1864 not modified; for example, <a class="link" href="cairo-Image-Surfaces.html#cairo-image-surface-create-for-data" title="cairo_image_surface_create_for_data ()"><code class="function">cairo_image_surface_create_for_data()</code></a> and
1865 <a class="link" href="cairo-XLib-Surfaces.html#cairo-xlib-surface-create" title="cairo_xlib_surface_create ()"><code class="function">cairo_xlib_surface_create()</code></a>.</p>
1866 <p>Memory management of <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> is done with
1867 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-reference" title="cairo_surface_reference ()"><code class="function">cairo_surface_reference()</code></a> and <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-destroy" title="cairo_surface_destroy ()"><code class="function">cairo_surface_destroy()</code></a>.</p>
1868 <p class="since">Since: 1.0</p>
1869 </div>
1870 <hr>
1871 <div class="refsect2">
1872 <a name="cairo-content-t"></a><h3>enum cairo_content_t</h3>
1873 <p><a class="link" href="cairo-cairo-surface-t.html#cairo-content-t" title="enum cairo_content_t"><span class="type">cairo_content_t</span></a> is used to describe the content that a surface will
1874 contain, whether color information, alpha information (translucence
1875 vs. opacity), or both.</p>
1876 <p>Note: The large values here are designed to keep <a class="link" href="cairo-cairo-surface-t.html#cairo-content-t" title="enum cairo_content_t"><span class="type">cairo_content_t</span></a>
1877 values distinct from <a class="link" href="cairo-Image-Surfaces.html#cairo-format-t" title="enum cairo_format_t"><span class="type">cairo_format_t</span></a> values so that the
1878 implementation can detect the error if users confuse the two types.</p>
1879 <div class="refsect3">
1880 <a name="cairo-content-t.members"></a><h4>Members</h4>
1881 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1882 <colgroup>
1883 <col width="300px" class="enum_members_name">
1884 <col class="enum_members_description">
1885 <col width="200px" class="enum_members_annotations">
1886 </colgroup>
1887 <tbody>
1888 <tr>
1889 <td class="enum_member_name"><p><a name="CAIRO-CONTENT-COLOR:CAPS"></a>CAIRO_CONTENT_COLOR</p></td>
1890 <td class="enum_member_description">
1891 <p>The surface will hold color content only. (Since 1.0)</p>
1892 </td>
1893 <td class="enum_member_annotations"> </td>
1894 </tr>
1895 <tr>
1896 <td class="enum_member_name"><p><a name="CAIRO-CONTENT-ALPHA:CAPS"></a>CAIRO_CONTENT_ALPHA</p></td>
1897 <td class="enum_member_description">
1898 <p>The surface will hold alpha content only. (Since 1.0)</p>
1899 </td>
1900 <td class="enum_member_annotations"> </td>
1901 </tr>
1902 <tr>
1903 <td class="enum_member_name"><p><a name="CAIRO-CONTENT-COLOR-ALPHA:CAPS"></a>CAIRO_CONTENT_COLOR_ALPHA</p></td>
1904 <td class="enum_member_description">
1905 <p>The surface will hold color and alpha content. (Since 1.0)</p>
1906 </td>
1907 <td class="enum_member_annotations"> </td>
1908 </tr>
1909 </tbody>
1910 </table></div>
1911 </div>
1912 <p class="since">Since: 1.0</p>
1913 </div>
1914 <hr>
1915 <div class="refsect2">
1916 <a name="cairo-surface-type-t"></a><h3>enum cairo_surface_type_t</h3>
1917 <p><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-type-t" title="enum cairo_surface_type_t"><span class="type">cairo_surface_type_t</span></a> is used to describe the type of a given
1918 surface. The surface types are also known as "backends" or "surface
1919 backends" within cairo.</p>
1920 <p>The type of a surface is determined by the function used to create
1921 it, which will generally be of the form
1922 <code class="function">cairo_<span class="emphasis"><em>type</em></span>_surface_create()</code>,
1923 (though see <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-create-similar" title="cairo_surface_create_similar ()"><code class="function">cairo_surface_create_similar()</code></a> as well).</p>
1924 <p>The surface type can be queried with <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-type" title="cairo_surface_get_type ()"><code class="function">cairo_surface_get_type()</code></a></p>
1925 <p>The various <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> functions can be used with surfaces of
1926 any type, but some backends also provide type-specific functions
1927 that must only be called with a surface of the appropriate
1928 type. These functions have names that begin with
1929 <code class="literal">cairo_<span class="emphasis"><em>type</em></span>_surface</code> such as <a class="link" href="cairo-Image-Surfaces.html#cairo-image-surface-get-width" title="cairo_image_surface_get_width ()"><code class="function">cairo_image_surface_get_width()</code></a>.</p>
1930 <p>The behavior of calling a type-specific function with a surface of
1931 the wrong type is undefined.</p>
1932 <p>New entries may be added in future versions.</p>
1933 <div class="refsect3">
1934 <a name="cairo-surface-type-t.members"></a><h4>Members</h4>
1935 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1936 <colgroup>
1937 <col width="300px" class="enum_members_name">
1938 <col class="enum_members_description">
1939 <col width="200px" class="enum_members_annotations">
1940 </colgroup>
1941 <tbody>
1942 <tr>
1943 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-IMAGE:CAPS"></a>CAIRO_SURFACE_TYPE_IMAGE</p></td>
1944 <td class="enum_member_description">
1945 <p>The surface is of type image, since 1.2</p>
1946 </td>
1947 <td class="enum_member_annotations"> </td>
1948 </tr>
1949 <tr>
1950 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-PDF:CAPS"></a>CAIRO_SURFACE_TYPE_PDF</p></td>
1951 <td class="enum_member_description">
1952 <p>The surface is of type pdf, since 1.2</p>
1953 </td>
1954 <td class="enum_member_annotations"> </td>
1955 </tr>
1956 <tr>
1957 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-PS:CAPS"></a>CAIRO_SURFACE_TYPE_PS</p></td>
1958 <td class="enum_member_description">
1959 <p>The surface is of type ps, since 1.2</p>
1960 </td>
1961 <td class="enum_member_annotations"> </td>
1962 </tr>
1963 <tr>
1964 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-XLIB:CAPS"></a>CAIRO_SURFACE_TYPE_XLIB</p></td>
1965 <td class="enum_member_description">
1966 <p>The surface is of type xlib, since 1.2</p>
1967 </td>
1968 <td class="enum_member_annotations"> </td>
1969 </tr>
1970 <tr>
1971 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-XCB:CAPS"></a>CAIRO_SURFACE_TYPE_XCB</p></td>
1972 <td class="enum_member_description">
1973 <p>The surface is of type xcb, since 1.2</p>
1974 </td>
1975 <td class="enum_member_annotations"> </td>
1976 </tr>
1977 <tr>
1978 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-GLITZ:CAPS"></a>CAIRO_SURFACE_TYPE_GLITZ</p></td>
1979 <td class="enum_member_description">
1980 <p>The surface is of type glitz, since 1.2</p>
1981 </td>
1982 <td class="enum_member_annotations"> </td>
1983 </tr>
1984 <tr>
1985 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-QUARTZ:CAPS"></a>CAIRO_SURFACE_TYPE_QUARTZ</p></td>
1986 <td class="enum_member_description">
1987 <p>The surface is of type quartz, since 1.2</p>
1988 </td>
1989 <td class="enum_member_annotations"> </td>
1990 </tr>
1991 <tr>
1992 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-WIN32:CAPS"></a>CAIRO_SURFACE_TYPE_WIN32</p></td>
1993 <td class="enum_member_description">
1994 <p>The surface is of type win32, since 1.2</p>
1995 </td>
1996 <td class="enum_member_annotations"> </td>
1997 </tr>
1998 <tr>
1999 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-BEOS:CAPS"></a>CAIRO_SURFACE_TYPE_BEOS</p></td>
2000 <td class="enum_member_description">
2001 <p>The surface is of type beos, since 1.2</p>
2002 </td>
2003 <td class="enum_member_annotations"> </td>
2004 </tr>
2005 <tr>
2006 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-DIRECTFB:CAPS"></a>CAIRO_SURFACE_TYPE_DIRECTFB</p></td>
2007 <td class="enum_member_description">
2008 <p>The surface is of type directfb, since 1.2</p>
2009 </td>
2010 <td class="enum_member_annotations"> </td>
2011 </tr>
2012 <tr>
2013 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-SVG:CAPS"></a>CAIRO_SURFACE_TYPE_SVG</p></td>
2014 <td class="enum_member_description">
2015 <p>The surface is of type svg, since 1.2</p>
2016 </td>
2017 <td class="enum_member_annotations"> </td>
2018 </tr>
2019 <tr>
2020 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-OS2:CAPS"></a>CAIRO_SURFACE_TYPE_OS2</p></td>
2021 <td class="enum_member_description">
2022 <p>The surface is of type os2, since 1.4</p>
2023 </td>
2024 <td class="enum_member_annotations"> </td>
2025 </tr>
2026 <tr>
2027 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-WIN32-PRINTING:CAPS"></a>CAIRO_SURFACE_TYPE_WIN32_PRINTING</p></td>
2028 <td class="enum_member_description">
2029 <p>The surface is a win32 printing surface, since 1.6</p>
2030 </td>
2031 <td class="enum_member_annotations"> </td>
2032 </tr>
2033 <tr>
2034 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-QUARTZ-IMAGE:CAPS"></a>CAIRO_SURFACE_TYPE_QUARTZ_IMAGE</p></td>
2035 <td class="enum_member_description">
2036 <p>The surface is of type quartz_image, since 1.6</p>
2037 </td>
2038 <td class="enum_member_annotations"> </td>
2039 </tr>
2040 <tr>
2041 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-SCRIPT:CAPS"></a>CAIRO_SURFACE_TYPE_SCRIPT</p></td>
2042 <td class="enum_member_description">
2043 <p>The surface is of type script, since 1.10</p>
2044 </td>
2045 <td class="enum_member_annotations"> </td>
2046 </tr>
2047 <tr>
2048 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-QT:CAPS"></a>CAIRO_SURFACE_TYPE_QT</p></td>
2049 <td class="enum_member_description">
2050 <p>The surface is of type Qt, since 1.10</p>
2051 </td>
2052 <td class="enum_member_annotations"> </td>
2053 </tr>
2054 <tr>
2055 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-RECORDING:CAPS"></a>CAIRO_SURFACE_TYPE_RECORDING</p></td>
2056 <td class="enum_member_description">
2057 <p>The surface is of type recording, since 1.10</p>
2058 </td>
2059 <td class="enum_member_annotations"> </td>
2060 </tr>
2061 <tr>
2062 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-VG:CAPS"></a>CAIRO_SURFACE_TYPE_VG</p></td>
2063 <td class="enum_member_description">
2064 <p>The surface is a OpenVG surface, since 1.10</p>
2065 </td>
2066 <td class="enum_member_annotations"> </td>
2067 </tr>
2068 <tr>
2069 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-GL:CAPS"></a>CAIRO_SURFACE_TYPE_GL</p></td>
2070 <td class="enum_member_description">
2071 <p>The surface is of type OpenGL, since 1.10</p>
2072 </td>
2073 <td class="enum_member_annotations"> </td>
2074 </tr>
2075 <tr>
2076 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-DRM:CAPS"></a>CAIRO_SURFACE_TYPE_DRM</p></td>
2077 <td class="enum_member_description">
2078 <p>The surface is of type Direct Render Manager, since 1.10</p>
2079 </td>
2080 <td class="enum_member_annotations"> </td>
2081 </tr>
2082 <tr>
2083 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-TEE:CAPS"></a>CAIRO_SURFACE_TYPE_TEE</p></td>
2084 <td class="enum_member_description">
2085 <p>The surface is of type 'tee' (a multiplexing surface), since 1.10</p>
2086 </td>
2087 <td class="enum_member_annotations"> </td>
2088 </tr>
2089 <tr>
2090 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-XML:CAPS"></a>CAIRO_SURFACE_TYPE_XML</p></td>
2091 <td class="enum_member_description">
2092 <p>The surface is of type XML (for debugging), since 1.10</p>
2093 </td>
2094 <td class="enum_member_annotations"> </td>
2095 </tr>
2096 <tr>
2097 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-SKIA:CAPS"></a>CAIRO_SURFACE_TYPE_SKIA</p></td>
2098 <td> </td>
2099 <td> </td>
2100 </tr>
2101 <tr>
2102 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-SUBSURFACE:CAPS"></a>CAIRO_SURFACE_TYPE_SUBSURFACE</p></td>
2103 <td class="enum_member_description">
2104 <p>The surface is a subsurface created with
2105 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-create-for-rectangle" title="cairo_surface_create_for_rectangle ()"><code class="function">cairo_surface_create_for_rectangle()</code></a>, since 1.10</p>
2106 </td>
2107 <td class="enum_member_annotations"> </td>
2108 </tr>
2109 <tr>
2110 <td class="enum_member_name"><p><a name="CAIRO-SURFACE-TYPE-COGL:CAPS"></a>CAIRO_SURFACE_TYPE_COGL</p></td>
2111 <td class="enum_member_description">
2112 <p>This surface is of type Cogl, since 1.12</p>
2113 </td>
2114 <td class="enum_member_annotations"> </td>
2115 </tr>
2116 </tbody>
2117 </table></div>
2118 </div>
2119 <p class="since">Since: 1.2</p>
2120 </div>
2121 </div>
2122 <div class="refsect1">
2123 <a name="cairo-cairo-surface-t.see-also"></a><h2>See Also</h2>
2124 <p><a class="link" href="cairo-cairo-t.html#cairo-t" title="cairo_t"><span class="type">cairo_t</span></a>, <a class="link" href="cairo-cairo-pattern-t.html#cairo-pattern-t" title="cairo_pattern_t"><span class="type">cairo_pattern_t</span></a></p>
2125 </div>
2126 </div>
2127 <div class="footer">
2128 <hr>Generated by GTK-Doc V1.27</div>
2129 </body>
2130 </html>