Mercurial > repos > rliterman > csp2
comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/gtk-doc/html/cairo/cairo-Win32-Surfaces.html @ 68:5028fdace37b
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>Win32 Surfaces: 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-Recording-Surfaces.html" title="Recording Surfaces"> | |
10 <link rel="next" href="cairo-SVG-Surfaces.html" title="SVG 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-Win32-Surfaces.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-Recording-Surfaces.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> | |
23 <td><a accesskey="n" href="cairo-SVG-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-Win32-Surfaces"></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-Win32-Surfaces.top_of_page"></a>Win32 Surfaces</span></h2> | |
30 <p>Win32 Surfaces — Microsoft Windows surface support</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-Win32-Surfaces.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-Win32-Surfaces.html#cairo-win32-surface-create" title="cairo_win32_surface_create ()">cairo_win32_surface_create</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-Win32-Surfaces.html#cairo-win32-surface-create-with-dib" title="cairo_win32_surface_create_with_dib ()">cairo_win32_surface_create_with_dib</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-Win32-Surfaces.html#cairo-win32-surface-create-with-ddb" title="cairo_win32_surface_create_with_ddb ()">cairo_win32_surface_create_with_ddb</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-Win32-Surfaces.html#cairo-win32-surface-create-with-format" title="cairo_win32_surface_create_with_format ()">cairo_win32_surface_create_with_format</a> <span class="c_punctuation">()</span> | |
72 </td> | |
73 </tr> | |
74 <tr> | |
75 <td class="function_type"> | |
76 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> * | |
77 </td> | |
78 <td class="function_name"> | |
79 <a class="link" href="cairo-Win32-Surfaces.html#cairo-win32-printing-surface-create" title="cairo_win32_printing_surface_create ()">cairo_win32_printing_surface_create</a> <span class="c_punctuation">()</span> | |
80 </td> | |
81 </tr> | |
82 <tr> | |
83 <td class="function_type"> | |
84 <span class="returnvalue">HDC</span> | |
85 </td> | |
86 <td class="function_name"> | |
87 <a class="link" href="cairo-Win32-Surfaces.html#cairo-win32-surface-get-dc" title="cairo_win32_surface_get_dc ()">cairo_win32_surface_get_dc</a> <span class="c_punctuation">()</span> | |
88 </td> | |
89 </tr> | |
90 <tr> | |
91 <td class="function_type"> | |
92 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> * | |
93 </td> | |
94 <td class="function_name"> | |
95 <a class="link" href="cairo-Win32-Surfaces.html#cairo-win32-surface-get-image" title="cairo_win32_surface_get_image ()">cairo_win32_surface_get_image</a> <span class="c_punctuation">()</span> | |
96 </td> | |
97 </tr> | |
98 </tbody> | |
99 </table></div> | |
100 </div> | |
101 <div class="refsect1"> | |
102 <a name="cairo-Win32-Surfaces.other"></a><h2>Types and Values</h2> | |
103 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
104 <colgroup> | |
105 <col width="150px" class="name"> | |
106 <col class="description"> | |
107 </colgroup> | |
108 <tbody><tr> | |
109 <td class="define_keyword">#define</td> | |
110 <td class="function_name"><a class="link" href="cairo-Win32-Surfaces.html#CAIRO-HAS-WIN32-SURFACE:CAPS" title="CAIRO_HAS_WIN32_SURFACE">CAIRO_HAS_WIN32_SURFACE</a></td> | |
111 </tr></tbody> | |
112 </table></div> | |
113 </div> | |
114 <div class="refsect1"> | |
115 <a name="cairo-Win32-Surfaces.description"></a><h2>Description</h2> | |
116 <p>The Microsoft Windows surface is used to render cairo graphics to | |
117 Microsoft Windows windows, bitmaps, and printing device contexts.</p> | |
118 <p>The surface returned by <a class="link" href="cairo-Win32-Surfaces.html#cairo-win32-printing-surface-create" title="cairo_win32_printing_surface_create ()"><code class="function">cairo_win32_printing_surface_create()</code></a> is of surface | |
119 type <a class="link" href="cairo-cairo-surface-t.html#CAIRO-SURFACE-TYPE-WIN32-PRINTING:CAPS"><code class="literal">CAIRO_SURFACE_TYPE_WIN32_PRINTING</code></a> and is a multi-page vector surface | |
120 type.</p> | |
121 <p>The surface returned by the other win32 constructors is of surface type | |
122 <a class="link" href="cairo-cairo-surface-t.html#CAIRO-SURFACE-TYPE-WIN32:CAPS"><code class="literal">CAIRO_SURFACE_TYPE_WIN32</code></a> and is a raster surface type.</p> | |
123 </div> | |
124 <div class="refsect1"> | |
125 <a name="cairo-Win32-Surfaces.functions_details"></a><h2>Functions</h2> | |
126 <div class="refsect2"> | |
127 <a name="cairo-win32-surface-create"></a><h3>cairo_win32_surface_create ()</h3> | |
128 <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> * | |
129 cairo_win32_surface_create (<em class="parameter"><code><span class="type">HDC</span> hdc</code></em>);</pre> | |
130 <p>Creates a cairo surface that targets the given DC. The DC will be | |
131 queried for its initial clip extents, and this will be used as the | |
132 size of the cairo surface. The resulting surface will always be of | |
133 format <a class="link" href="cairo-Image-Surfaces.html#CAIRO-FORMAT-RGB24:CAPS"><code class="literal">CAIRO_FORMAT_RGB24</code></a>; should you need another surface format, | |
134 you will need to create one through | |
135 <a class="link" href="cairo-Win32-Surfaces.html#cairo-win32-surface-create-with-format" title="cairo_win32_surface_create_with_format ()"><code class="function">cairo_win32_surface_create_with_format()</code></a> or | |
136 <a class="link" href="cairo-Win32-Surfaces.html#cairo-win32-surface-create-with-dib" title="cairo_win32_surface_create_with_dib ()"><code class="function">cairo_win32_surface_create_with_dib()</code></a>.</p> | |
137 <div class="refsect3"> | |
138 <a name="cairo-win32-surface-create.parameters"></a><h4>Parameters</h4> | |
139 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
140 <colgroup> | |
141 <col width="150px" class="parameters_name"> | |
142 <col class="parameters_description"> | |
143 <col width="200px" class="parameters_annotations"> | |
144 </colgroup> | |
145 <tbody><tr> | |
146 <td class="parameter_name"><p>hdc</p></td> | |
147 <td class="parameter_description"><p>the DC to create a surface for</p></td> | |
148 <td class="parameter_annotations"> </td> | |
149 </tr></tbody> | |
150 </table></div> | |
151 </div> | |
152 <div class="refsect3"> | |
153 <a name="cairo-win32-surface-create.returns"></a><h4>Returns</h4> | |
154 <p> the newly created surface, NULL on failure</p> | |
155 </div> | |
156 <p class="since">Since: 1.0</p> | |
157 </div> | |
158 <hr> | |
159 <div class="refsect2"> | |
160 <a name="cairo-win32-surface-create-with-dib"></a><h3>cairo_win32_surface_create_with_dib ()</h3> | |
161 <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> * | |
162 cairo_win32_surface_create_with_dib (<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>, | |
163 <em class="parameter"><code><span class="type">int</span> width</code></em>, | |
164 <em class="parameter"><code><span class="type">int</span> height</code></em>);</pre> | |
165 <p>Creates a device-independent-bitmap surface not associated with | |
166 any particular existing surface or device context. The created | |
167 bitmap will be uninitialized.</p> | |
168 <div class="refsect3"> | |
169 <a name="cairo-win32-surface-create-with-dib.parameters"></a><h4>Parameters</h4> | |
170 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
171 <colgroup> | |
172 <col width="150px" class="parameters_name"> | |
173 <col class="parameters_description"> | |
174 <col width="200px" class="parameters_annotations"> | |
175 </colgroup> | |
176 <tbody> | |
177 <tr> | |
178 <td class="parameter_name"><p>format</p></td> | |
179 <td class="parameter_description"><p>format of pixels in the surface to create</p></td> | |
180 <td class="parameter_annotations"> </td> | |
181 </tr> | |
182 <tr> | |
183 <td class="parameter_name"><p>width</p></td> | |
184 <td class="parameter_description"><p>width of the surface, in pixels</p></td> | |
185 <td class="parameter_annotations"> </td> | |
186 </tr> | |
187 <tr> | |
188 <td class="parameter_name"><p>height</p></td> | |
189 <td class="parameter_description"><p>height of the surface, in pixels</p></td> | |
190 <td class="parameter_annotations"> </td> | |
191 </tr> | |
192 </tbody> | |
193 </table></div> | |
194 </div> | |
195 <div class="refsect3"> | |
196 <a name="cairo-win32-surface-create-with-dib.returns"></a><h4>Returns</h4> | |
197 <p> the newly created surface</p> | |
198 </div> | |
199 <p class="since">Since: 1.2</p> | |
200 </div> | |
201 <hr> | |
202 <div class="refsect2"> | |
203 <a name="cairo-win32-surface-create-with-ddb"></a><h3>cairo_win32_surface_create_with_ddb ()</h3> | |
204 <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> * | |
205 cairo_win32_surface_create_with_ddb (<em class="parameter"><code><span class="type">HDC</span> hdc</code></em>, | |
206 <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>, | |
207 <em class="parameter"><code><span class="type">int</span> width</code></em>, | |
208 <em class="parameter"><code><span class="type">int</span> height</code></em>);</pre> | |
209 <p>Creates a device-dependent-bitmap surface not associated with | |
210 any particular existing surface or device context. The created | |
211 bitmap will be uninitialized.</p> | |
212 <div class="refsect3"> | |
213 <a name="cairo-win32-surface-create-with-ddb.parameters"></a><h4>Parameters</h4> | |
214 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
215 <colgroup> | |
216 <col width="150px" class="parameters_name"> | |
217 <col class="parameters_description"> | |
218 <col width="200px" class="parameters_annotations"> | |
219 </colgroup> | |
220 <tbody> | |
221 <tr> | |
222 <td class="parameter_name"><p>hdc</p></td> | |
223 <td class="parameter_description"><p>a DC compatible with the surface to create</p></td> | |
224 <td class="parameter_annotations"> </td> | |
225 </tr> | |
226 <tr> | |
227 <td class="parameter_name"><p>format</p></td> | |
228 <td class="parameter_description"><p>format of pixels in the surface to create</p></td> | |
229 <td class="parameter_annotations"> </td> | |
230 </tr> | |
231 <tr> | |
232 <td class="parameter_name"><p>width</p></td> | |
233 <td class="parameter_description"><p>width of the surface, in pixels</p></td> | |
234 <td class="parameter_annotations"> </td> | |
235 </tr> | |
236 <tr> | |
237 <td class="parameter_name"><p>height</p></td> | |
238 <td class="parameter_description"><p>height of the surface, in pixels</p></td> | |
239 <td class="parameter_annotations"> </td> | |
240 </tr> | |
241 </tbody> | |
242 </table></div> | |
243 </div> | |
244 <div class="refsect3"> | |
245 <a name="cairo-win32-surface-create-with-ddb.returns"></a><h4>Returns</h4> | |
246 <p> the newly created surface</p> | |
247 </div> | |
248 <p class="since">Since: 1.4</p> | |
249 </div> | |
250 <hr> | |
251 <div class="refsect2"> | |
252 <a name="cairo-win32-surface-create-with-format"></a><h3>cairo_win32_surface_create_with_format ()</h3> | |
253 <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> * | |
254 cairo_win32_surface_create_with_format | |
255 (<em class="parameter"><code><span class="type">HDC</span> hdc</code></em>, | |
256 <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>);</pre> | |
257 <p>Creates a cairo surface that targets the given DC. The DC will be | |
258 queried for its initial clip extents, and this will be used as the | |
259 size of the cairo surface.</p> | |
260 <p>Supported formats are: | |
261 <a class="link" href="cairo-Image-Surfaces.html#CAIRO-FORMAT-ARGB32:CAPS"><code class="literal">CAIRO_FORMAT_ARGB32</code></a> | |
262 <a class="link" href="cairo-Image-Surfaces.html#CAIRO-FORMAT-RGB24:CAPS"><code class="literal">CAIRO_FORMAT_RGB24</code></a></p> | |
263 <p>Note: <em class="parameter"><code>format</code></em> | |
264 only tells cairo how to draw on the surface, not what | |
265 the format of the surface is. Namely, cairo does not (and cannot) | |
266 check that <em class="parameter"><code>hdc</code></em> | |
267 actually supports alpha-transparency.</p> | |
268 <div class="refsect3"> | |
269 <a name="cairo-win32-surface-create-with-format.parameters"></a><h4>Parameters</h4> | |
270 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
271 <colgroup> | |
272 <col width="150px" class="parameters_name"> | |
273 <col class="parameters_description"> | |
274 <col width="200px" class="parameters_annotations"> | |
275 </colgroup> | |
276 <tbody> | |
277 <tr> | |
278 <td class="parameter_name"><p>hdc</p></td> | |
279 <td class="parameter_description"><p>the DC to create a surface for</p></td> | |
280 <td class="parameter_annotations"> </td> | |
281 </tr> | |
282 <tr> | |
283 <td class="parameter_name"><p>format</p></td> | |
284 <td class="parameter_description"><p>format of pixels in the surface to create</p></td> | |
285 <td class="parameter_annotations"> </td> | |
286 </tr> | |
287 </tbody> | |
288 </table></div> | |
289 </div> | |
290 <div class="refsect3"> | |
291 <a name="cairo-win32-surface-create-with-format.returns"></a><h4>Returns</h4> | |
292 <p> the newly created surface, NULL on failure</p> | |
293 </div> | |
294 <p class="since">Since: 1.14</p> | |
295 </div> | |
296 <hr> | |
297 <div class="refsect2"> | |
298 <a name="cairo-win32-printing-surface-create"></a><h3>cairo_win32_printing_surface_create ()</h3> | |
299 <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> * | |
300 cairo_win32_printing_surface_create (<em class="parameter"><code><span class="type">HDC</span> hdc</code></em>);</pre> | |
301 <p>Creates a cairo surface that targets the given DC. The DC will be | |
302 queried for its initial clip extents, and this will be used as the | |
303 size of the cairo surface. The DC should be a printing DC; | |
304 antialiasing will be ignored, and GDI will be used as much as | |
305 possible to draw to the surface.</p> | |
306 <p>The returned surface will be wrapped using the paginated surface to | |
307 provide correct complex rendering behaviour; <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> and | |
308 associated methods must be used for correct output.</p> | |
309 <div class="refsect3"> | |
310 <a name="cairo-win32-printing-surface-create.parameters"></a><h4>Parameters</h4> | |
311 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
312 <colgroup> | |
313 <col width="150px" class="parameters_name"> | |
314 <col class="parameters_description"> | |
315 <col width="200px" class="parameters_annotations"> | |
316 </colgroup> | |
317 <tbody><tr> | |
318 <td class="parameter_name"><p>hdc</p></td> | |
319 <td class="parameter_description"><p>the DC to create a surface for</p></td> | |
320 <td class="parameter_annotations"> </td> | |
321 </tr></tbody> | |
322 </table></div> | |
323 </div> | |
324 <div class="refsect3"> | |
325 <a name="cairo-win32-printing-surface-create.returns"></a><h4>Returns</h4> | |
326 <p> the newly created surface</p> | |
327 </div> | |
328 <p class="since">Since: 1.6</p> | |
329 </div> | |
330 <hr> | |
331 <div class="refsect2"> | |
332 <a name="cairo-win32-surface-get-dc"></a><h3>cairo_win32_surface_get_dc ()</h3> | |
333 <pre class="programlisting"><span class="returnvalue">HDC</span> | |
334 cairo_win32_surface_get_dc (<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> | |
335 <p>Returns the HDC associated with this surface, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if none. | |
336 Also returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the surface is not a win32 surface.</p> | |
337 <p>A call to <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-flush" title="cairo_surface_flush ()"><code class="function">cairo_surface_flush()</code></a> is required before using the HDC to | |
338 ensure that all pending drawing operations are finished and to | |
339 restore any temporary modification cairo has made to its state. A | |
340 call to <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> is required after the state or | |
341 the content of the HDC has been modified.</p> | |
342 <div class="refsect3"> | |
343 <a name="cairo-win32-surface-get-dc.parameters"></a><h4>Parameters</h4> | |
344 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
345 <colgroup> | |
346 <col width="150px" class="parameters_name"> | |
347 <col class="parameters_description"> | |
348 <col width="200px" class="parameters_annotations"> | |
349 </colgroup> | |
350 <tbody><tr> | |
351 <td class="parameter_name"><p>surface</p></td> | |
352 <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> | |
353 <td class="parameter_annotations"> </td> | |
354 </tr></tbody> | |
355 </table></div> | |
356 </div> | |
357 <div class="refsect3"> | |
358 <a name="cairo-win32-surface-get-dc.returns"></a><h4>Returns</h4> | |
359 <p> HDC or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no HDC available.</p> | |
360 </div> | |
361 <p class="since">Since: 1.2</p> | |
362 </div> | |
363 <hr> | |
364 <div class="refsect2"> | |
365 <a name="cairo-win32-surface-get-image"></a><h3>cairo_win32_surface_get_image ()</h3> | |
366 <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> * | |
367 cairo_win32_surface_get_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>);</pre> | |
368 <p>Returns 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> image surface that refers to the same bits | |
369 as the DIB of the Win32 surface. If the passed-in win32 surface | |
370 is not a DIB surface, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.</p> | |
371 <div class="refsect3"> | |
372 <a name="cairo-win32-surface-get-image.parameters"></a><h4>Parameters</h4> | |
373 <div class="informaltable"><table class="informaltable" width="100%" border="0"> | |
374 <colgroup> | |
375 <col width="150px" class="parameters_name"> | |
376 <col class="parameters_description"> | |
377 <col width="200px" class="parameters_annotations"> | |
378 </colgroup> | |
379 <tbody><tr> | |
380 <td class="parameter_name"><p>surface</p></td> | |
381 <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> | |
382 <td class="parameter_annotations"> </td> | |
383 </tr></tbody> | |
384 </table></div> | |
385 </div> | |
386 <div class="refsect3"> | |
387 <a name="cairo-win32-surface-get-image.returns"></a><h4>Returns</h4> | |
388 <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> (owned by the win32 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a>), | |
389 or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the win32 surface is not a DIB.</p> | |
390 </div> | |
391 <p class="since">Since: 1.4</p> | |
392 </div> | |
393 </div> | |
394 <div class="refsect1"> | |
395 <a name="cairo-Win32-Surfaces.other_details"></a><h2>Types and Values</h2> | |
396 <div class="refsect2"> | |
397 <a name="CAIRO-HAS-WIN32-SURFACE:CAPS"></a><h3>CAIRO_HAS_WIN32_SURFACE</h3> | |
398 <pre class="programlisting">#define CAIRO_HAS_WIN32_SURFACE 1 | |
399 </pre> | |
400 <p>Defined if the Microsoft Windows surface backend is available. | |
401 This macro can be used to conditionally compile backend-specific code.</p> | |
402 <p class="since">Since: 1.0</p> | |
403 </div> | |
404 </div> | |
405 <div class="refsect1"> | |
406 <a name="cairo-Win32-Surfaces.see-also"></a><h2>See Also</h2> | |
407 <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></p> | |
408 </div> | |
409 </div> | |
410 <div class="footer"> | |
411 <hr>Generated by GTK-Doc V1.27</div> | |
412 </body> | |
413 </html> |