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