cairo 1.7.0-x86-mswin32 → 1.8.0-x86-mswin32
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.
- data/ChangeLog +32 -0
- data/NEWS +9 -1
- data/README +1 -0
- data/Rakefile +2 -2
- data/cairo/DLL_FAQ.txt +397 -0
- data/cairo/README.txt +53 -0
- data/cairo/USAGE.txt +94 -0
- data/cairo/bin/libcairo-2.dll +0 -0
- data/cairo/bin/libpng12-0.dll +0 -0
- data/cairo/bin/zlib1.dll +0 -0
- data/cairo/include/cairo/cairo-deprecated.h +0 -4
- data/cairo/include/cairo/cairo-features.h +7 -22
- data/cairo/include/cairo/cairo-pdf.h +1 -1
- data/cairo/include/cairo/cairo-ps.h +1 -1
- data/cairo/include/cairo/cairo-svg.h +1 -1
- data/cairo/include/cairo/cairo-version.h +8 -0
- data/cairo/include/cairo/cairo-win32.h +9 -1
- data/cairo/include/cairo/cairo.h +420 -32
- data/cairo/include/libpng12/png.h +3592 -0
- data/cairo/include/libpng12/pngconf.h +1481 -0
- data/cairo/include/png.h +36 -13
- data/cairo/include/pngconf.h +3 -3
- data/cairo/include/zconf.h +332 -0
- data/cairo/include/zlib.h +1357 -0
- data/cairo/lib/cairo.def +22 -0
- data/cairo/lib/cairo.lib +0 -0
- data/cairo/lib/libcairo.dll.a +0 -0
- data/cairo/lib/libpng.def +1 -0
- data/cairo/lib/libpng.lib +0 -0
- data/cairo/lib/libpng12.dll.a +0 -0
- data/cairo/lib/pkgconfig/cairo-pdf.pc +5 -5
- data/cairo/lib/pkgconfig/cairo-png.pc +5 -5
- data/cairo/lib/pkgconfig/cairo-ps.pc +5 -5
- data/cairo/lib/pkgconfig/cairo-svg.pc +4 -4
- data/cairo/lib/pkgconfig/cairo-win32-font.pc +4 -4
- data/cairo/lib/pkgconfig/cairo-win32.pc +4 -4
- data/cairo/lib/pkgconfig/cairo.pc +4 -4
- data/cairo/lib/pkgconfig/libpng.pc +3 -2
- data/cairo/lib/pkgconfig/libpng12.pc +3 -2
- data/cairo/lib/zdll.exp +0 -0
- data/cairo/lib/zdll.lib +0 -0
- data/cairo/lib/zlib.def +60 -0
- data/cairo/manifest/cairo-dev_1.8.0-1_win32.mft +76 -0
- data/cairo/manifest/cairo_1.8.0-1_win32.mft +5 -0
- data/cairo/manifest/{libpng-dev-1.2.29.mft → libpng-dev_1.2.32-1_win32.mft} +5 -2
- data/cairo/manifest/libpng_1.2.32-1_win32.mft +2 -0
- data/cairo/share/doc/{cairo-1.6.4-2 → cairo_1.8.0-1_win32}/COPYING +0 -0
- data/cairo/share/doc/{cairo-1.6.4-2 → cairo_1.8.0-1_win32}/COPYING-LGPL-2.1 +0 -0
- data/cairo/share/doc/{cairo-1.6.4-2 → cairo_1.8.0-1_win32}/COPYING-MPL-1.1 +0 -0
- data/cairo/share/gtk-doc/html/cairo/bindings-errors.html +15 -11
- data/cairo/share/gtk-doc/html/cairo/bindings-fonts.html +15 -11
- data/cairo/share/gtk-doc/html/cairo/bindings-memory.html +20 -16
- data/cairo/share/gtk-doc/html/cairo/bindings-overloading.html +16 -12
- data/cairo/share/gtk-doc/html/cairo/bindings-path.html +17 -13
- data/cairo/share/gtk-doc/html/cairo/bindings-patterns.html +25 -21
- data/cairo/share/gtk-doc/html/cairo/bindings-return-values.html +17 -13
- data/cairo/share/gtk-doc/html/cairo/bindings-streams.html +14 -10
- data/cairo/share/gtk-doc/html/cairo/bindings-surfaces.html +19 -15
- data/cairo/share/gtk-doc/html/cairo/cairo-context.html +2721 -0
- data/cairo/share/gtk-doc/html/cairo/cairo-drawing.html +57 -0
- data/cairo/share/gtk-doc/html/cairo/cairo-error-status.html +361 -0
- data/cairo/share/gtk-doc/html/cairo/cairo-font-face.html +418 -0
- data/cairo/share/gtk-doc/html/cairo/cairo-font-options.html +695 -0
- data/cairo/share/gtk-doc/html/cairo/cairo-fonts.html +63 -0
- data/cairo/share/gtk-doc/html/cairo/cairo-ft-font.html +318 -0
- data/cairo/share/gtk-doc/html/cairo/cairo-image-surface.html +486 -0
- data/cairo/share/gtk-doc/html/cairo/{cairo-cairo-matrix-t.html → cairo-matrix.html} +137 -156
- data/cairo/share/gtk-doc/html/cairo/{cairo-Paths.html → cairo-paths.html} +275 -306
- data/cairo/share/gtk-doc/html/cairo/cairo-pattern.html +1524 -0
- data/cairo/share/gtk-doc/html/cairo/{cairo-PDF-Surfaces.html → cairo-pdf-surface.html} +60 -70
- data/cairo/share/gtk-doc/html/cairo/cairo-png-functions.html +332 -0
- data/cairo/share/gtk-doc/html/cairo/{cairo-PostScript-Surfaces.html → cairo-ps-surface.html} +131 -150
- data/cairo/share/gtk-doc/html/cairo/cairo-quartz-font.html +153 -0
- data/cairo/share/gtk-doc/html/cairo/{cairo-Quartz-Surfaces.html → cairo-quartz-surface.html} +53 -62
- data/cairo/share/gtk-doc/html/cairo/cairo-scaled-font.html +1051 -0
- data/cairo/share/gtk-doc/html/cairo/cairo-support.html +54 -0
- data/cairo/share/gtk-doc/html/cairo/cairo-surface.html +1064 -0
- data/cairo/share/gtk-doc/html/cairo/cairo-surfaces.html +69 -0
- data/cairo/share/gtk-doc/html/cairo/cairo-svg-surface.html +324 -0
- data/cairo/share/gtk-doc/html/cairo/cairo-text.html +1264 -0
- data/cairo/share/gtk-doc/html/cairo/{cairo-Transformations.html → cairo-transformations.html} +98 -115
- data/cairo/share/gtk-doc/html/cairo/cairo-types.html +134 -0
- data/cairo/share/gtk-doc/html/cairo/cairo-user-font.html +769 -0
- data/cairo/share/gtk-doc/html/cairo/cairo-version-info.html +355 -0
- data/cairo/share/gtk-doc/html/cairo/cairo-win32-font.html +366 -0
- data/cairo/share/gtk-doc/html/cairo/cairo-win32-surface.html +321 -0
- data/cairo/share/gtk-doc/html/cairo/{cairo-XLib-Surfaces.html → cairo-xlib-surface.html} +104 -121
- data/cairo/share/gtk-doc/html/cairo/cairo.devhelp +390 -405
- data/cairo/share/gtk-doc/html/cairo/cairo.devhelp2 +390 -405
- data/cairo/share/gtk-doc/html/cairo/index-1.2.html +63 -59
- data/cairo/share/gtk-doc/html/cairo/index-1.4.html +45 -41
- data/cairo/share/gtk-doc/html/cairo/index-1.6.html +29 -23
- data/cairo/share/gtk-doc/html/cairo/index-1.8.html +107 -0
- data/cairo/share/gtk-doc/html/cairo/index-all.html +759 -0
- data/cairo/share/gtk-doc/html/cairo/index.html +51 -41
- data/cairo/share/gtk-doc/html/cairo/index.sgml +478 -466
- data/cairo/share/gtk-doc/html/cairo/language-bindings.html +22 -18
- data/cairo/share/gtk-doc/html/cairo/style.css +14 -2
- data/cairo/share/man/man3/libpng.3 +443 -17
- data/cairo/share/man/man3/libpngpf.3 +618 -102
- data/cairo/share/man/man5/png.5 +1 -1
- data/cairo/src/tml/make/cairo_1.8.0-1_win32.log +1021 -0
- data/cairo/src/tml/make/cairo_1.8.0-1_win32.sh +68 -0
- data/cairo/src/tml/make/libpng_1.2.32-1_win32.log +269 -0
- data/cairo/src/tml/make/libpng_1.2.32-1_win32.sh +63 -0
- data/cairo/test/example_d.exe +0 -0
- data/cairo/test/minigzip_d.exe +0 -0
- data/cairo/test/testzlib_d.exe +0 -0
- data/cairo/test/untgz_d.exe +0 -0
- data/doc/en/cairo-context.html +81 -91
- data/doc/en/cairo-font-options.html +11 -26
- data/doc/en/cairo-text-cluster-flag.html +35 -0
- data/doc/en/cairo-user-font-face-text-to-glyphs-data.html +3 -3
- data/doc/en/cairo.html +38 -42
- data/doc/en/index.html +129 -142
- data/doc/ja/cairo-font-options.html +3 -25
- data/doc/ja/cairo-text-cluster-flag.html +46 -0
- data/doc/ja/cairo-user-font-face-text-to-glyphs-data.html +16 -15
- data/doc/ja/cairo.html +3 -7
- data/doc/ja/index.html +9 -17
- data/src/cairo.def +1 -1
- data/src/cairo.so +0 -0
- data/src/lib/cairo/constants.rb +3 -1
- data/src/libruby-cairo.a +0 -0
- data/src/rb_cairo.c +2 -2
- data/src/rb_cairo.h +5 -5
- data/src/rb_cairo_constants.c +12 -19
- data/src/rb_cairo_context.c +25 -21
- data/src/rb_cairo_font_face.c +44 -29
- data/src/rb_cairo_font_options.c +1 -23
- data/src/rb_cairo_scaled_font.c +5 -5
- data/test/test_constants.rb +6 -9
- data/test/test_context.rb +0 -12
- data/test/test_font_face.rb +7 -7
- data/test/test_font_options.rb +2 -21
- data/test/test_scaled_font.rb +3 -3
- data/test/test_text_to_glyphs_data.rb +19 -15
- metadata +68 -45
- data/cairo/make/cairo-1.6.4-2.sh +0 -55
- data/cairo/make/libpng-1.2.29.sh +0 -35
- data/cairo/manifest/cairo-1.6.4-2.mft +0 -6
- data/cairo/manifest/cairo-dev-1.6.4-2.mft +0 -72
- data/cairo/manifest/libpng-1.2.29.mft +0 -2
- data/cairo/share/gtk-doc/html/cairo/Drawing.html +0 -53
- data/cairo/share/gtk-doc/html/cairo/Fonts.html +0 -56
- data/cairo/share/gtk-doc/html/cairo/Support.html +0 -50
- data/cairo/share/gtk-doc/html/cairo/Surfaces.html +0 -65
- data/cairo/share/gtk-doc/html/cairo/cairo-Error-Handling.html +0 -328
- data/cairo/share/gtk-doc/html/cairo/cairo-Font-Options.html +0 -720
- data/cairo/share/gtk-doc/html/cairo/cairo-FreeType-Fonts.html +0 -297
- data/cairo/share/gtk-doc/html/cairo/cairo-Image-Surfaces.html +0 -484
- data/cairo/share/gtk-doc/html/cairo/cairo-PNG-Support.html +0 -345
- data/cairo/share/gtk-doc/html/cairo/cairo-Patterns.html +0 -1560
- data/cairo/share/gtk-doc/html/cairo/cairo-Quartz-Fonts.html +0 -161
- data/cairo/share/gtk-doc/html/cairo/cairo-SVG-Surfaces.html +0 -337
- data/cairo/share/gtk-doc/html/cairo/cairo-Scaled-Fonts.html +0 -823
- data/cairo/share/gtk-doc/html/cairo/cairo-Text.html +0 -836
- data/cairo/share/gtk-doc/html/cairo/cairo-Types.html +0 -143
- data/cairo/share/gtk-doc/html/cairo/cairo-Version-Information.html +0 -325
- data/cairo/share/gtk-doc/html/cairo/cairo-Win32-Fonts.html +0 -381
- data/cairo/share/gtk-doc/html/cairo/cairo-Win32-Surfaces.html +0 -331
- data/cairo/share/gtk-doc/html/cairo/cairo-cairo-font-face-t.html +0 -427
- data/cairo/share/gtk-doc/html/cairo/cairo-cairo-surface-t.html +0 -995
- data/cairo/share/gtk-doc/html/cairo/cairo-cairo-t.html +0 -2795
- data/cairo/share/gtk-doc/html/cairo/ix01.html +0 -693
- data/doc/en/cairo-lcd-filter.html +0 -39
- data/doc/ja/cairo-lcd-filter.html +0 -63
|
@@ -1,427 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
2
|
-
<html>
|
|
3
|
-
<head>
|
|
4
|
-
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
5
|
-
<title>cairo_font_face_t</title>
|
|
6
|
-
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
|
|
7
|
-
<link rel="start" href="index.html" title="Cairo: A Vector Graphics Library">
|
|
8
|
-
<link rel="up" href="Fonts.html" title="Fonts">
|
|
9
|
-
<link rel="prev" href="Fonts.html" title="Fonts">
|
|
10
|
-
<link rel="next" href="cairo-Scaled-Fonts.html" title="cairo_scaled_font_t">
|
|
11
|
-
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
|
|
12
|
-
<link rel="stylesheet" href="style.css" type="text/css">
|
|
13
|
-
<link rel="chapter" href="Drawing.html" title="Drawing">
|
|
14
|
-
<link rel="chapter" href="Fonts.html" title="Fonts">
|
|
15
|
-
<link rel="chapter" href="Surfaces.html" title="Surfaces">
|
|
16
|
-
<link rel="chapter" href="Support.html" title="Utilities">
|
|
17
|
-
<link rel="index" href="ix01.html" title="Index">
|
|
18
|
-
<link rel="index" href="index-1.2.html" title="Index of new symbols in 1.2">
|
|
19
|
-
<link rel="index" href="index-1.4.html" title="Index of new symbols in 1.4">
|
|
20
|
-
<link rel="index" href="index-1.6.html" title="Index of new symbols in 1.6">
|
|
21
|
-
<link rel="appendix" href="language-bindings.html" title="Appendix A. Creating a language binding for cairo">
|
|
22
|
-
</head>
|
|
23
|
-
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
24
|
-
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
|
|
25
|
-
<tr valign="middle">
|
|
26
|
-
<td><a accesskey="p" href="Fonts.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
|
|
27
|
-
<td><a accesskey="u" href="Fonts.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
|
|
28
|
-
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
|
|
29
|
-
<th width="100%" align="center">Cairo: A Vector Graphics Library</th>
|
|
30
|
-
<td><a accesskey="n" href="cairo-Scaled-Fonts.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
|
|
31
|
-
</tr>
|
|
32
|
-
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2590230" class="shortcut">Top</a>
|
|
33
|
-
 | 
|
|
34
|
-
<a href="#id2594252" class="shortcut">Description</a></nobr></td></tr>
|
|
35
|
-
</table>
|
|
36
|
-
<div class="refentry" lang="en">
|
|
37
|
-
<a name="cairo-cairo-font-face-t"></a><div class="titlepage"></div>
|
|
38
|
-
<div class="refnamediv"><table width="100%"><tr>
|
|
39
|
-
<td valign="top">
|
|
40
|
-
<h2>
|
|
41
|
-
<a name="id2590230"></a><span class="refentrytitle">cairo_font_face_t</span>
|
|
42
|
-
</h2>
|
|
43
|
-
<p>cairo_font_face_t — Base class for font faces</p>
|
|
44
|
-
</td>
|
|
45
|
-
<td valign="top" align="right"></td>
|
|
46
|
-
</tr></table></div>
|
|
47
|
-
<div class="refsynopsisdiv">
|
|
48
|
-
<h2>Synopsis</h2>
|
|
49
|
-
<pre class="synopsis">
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
typedef <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t">cairo_font_face_t</a>;
|
|
54
|
-
<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t">cairo_font_face_t</a>* <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-reference">cairo_font_face_reference</a> (<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t">cairo_font_face_t</a> *font_face);
|
|
55
|
-
void <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-destroy">cairo_font_face_destroy</a> (<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t">cairo_font_face_t</a> *font_face);
|
|
56
|
-
<a class="link" href="cairo-Error-Handling.html#cairo-status-t">cairo_status_t</a> <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-status">cairo_font_face_status</a> (<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t">cairo_font_face_t</a> *font_face);
|
|
57
|
-
enum <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-type-t">cairo_font_type_t</a>;
|
|
58
|
-
<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-type-t">cairo_font_type_t</a> <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-get-type">cairo_font_face_get_type</a> (<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t">cairo_font_face_t</a> *font_face);
|
|
59
|
-
unsigned int <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-get-reference-count">cairo_font_face_get_reference_count</a> (<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t">cairo_font_face_t</a> *font_face);
|
|
60
|
-
<a class="link" href="cairo-Error-Handling.html#cairo-status-t">cairo_status_t</a> <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-set-user-data">cairo_font_face_set_user_data</a> (<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t">cairo_font_face_t</a> *font_face,
|
|
61
|
-
const <a class="link" href="cairo-Types.html#cairo-user-data-key-t">cairo_user_data_key_t</a> *key,
|
|
62
|
-
void *user_data,
|
|
63
|
-
<a class="link" href="cairo-Types.html#cairo-destroy-func-t">cairo_destroy_func_t</a> destroy);
|
|
64
|
-
void* <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-get-user-data">cairo_font_face_get_user_data</a> (<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t">cairo_font_face_t</a> *font_face,
|
|
65
|
-
const <a class="link" href="cairo-Types.html#cairo-user-data-key-t">cairo_user_data_key_t</a> *key);
|
|
66
|
-
</pre>
|
|
67
|
-
</div>
|
|
68
|
-
<div class="refsect1" lang="en">
|
|
69
|
-
<a name="id2594252"></a><h2>Description</h2>
|
|
70
|
-
<p>
|
|
71
|
-
<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t"><span class="type">cairo_font_face_t</span></a> represents a particular font at a particular weight,
|
|
72
|
-
slant, and other characteristic but no size, transformation, or size.
|
|
73
|
-
</p>
|
|
74
|
-
<p>
|
|
75
|
-
Font faces are created using <em class="firstterm">font-backend</em>-specific
|
|
76
|
-
constructors, typically of the form
|
|
77
|
-
cairo_<span class="emphasis"><em>backend</em></span><code class="function">_font_face_create()</code>,
|
|
78
|
-
or implicitly using the <em class="firstterm">toy</em> text API by way of
|
|
79
|
-
<a class="link" href="cairo-Text.html#cairo-select-font-face"><code class="function">cairo_select_font_face()</code></a>. The resulting face can be accessed using
|
|
80
|
-
<a class="link" href="cairo-Text.html#cairo-get-font-face"><code class="function">cairo_get_font_face()</code></a>.
|
|
81
|
-
</p>
|
|
82
|
-
</div>
|
|
83
|
-
<div class="refsect1" lang="en">
|
|
84
|
-
<a name="id2594318"></a><h2>Details</h2>
|
|
85
|
-
<div class="refsect2" lang="en">
|
|
86
|
-
<a name="id2594329"></a><h3>
|
|
87
|
-
<a name="cairo-font-face-t"></a>cairo_font_face_t</h3>
|
|
88
|
-
<a class="indexterm" name="id2594342"></a><pre class="programlisting">typedef struct _cairo_font_face cairo_font_face_t;
|
|
89
|
-
</pre>
|
|
90
|
-
<p>
|
|
91
|
-
A <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t"><span class="type">cairo_font_face_t</span></a> specifies all aspects of a font other
|
|
92
|
-
than the size or font matrix (a font matrix is used to distort
|
|
93
|
-
a font by sheering it or scaling it unequally in the two
|
|
94
|
-
directions) . A font face can be set on a <a class="link" href="cairo-cairo-t.html#cairo-t"><span class="type">cairo_t</span></a> by using
|
|
95
|
-
<a class="link" href="cairo-Text.html#cairo-set-font-face"><code class="function">cairo_set_font_face()</code></a>; the size and font matrix are set with
|
|
96
|
-
<a class="link" href="cairo-Text.html#cairo-set-font-size"><code class="function">cairo_set_font_size()</code></a> and <a class="link" href="cairo-Text.html#cairo-set-font-matrix"><code class="function">cairo_set_font_matrix()</code></a>.
|
|
97
|
-
</p>
|
|
98
|
-
<p>
|
|
99
|
-
There are various types of font faces, depending on the
|
|
100
|
-
<em class="firstterm">font backend</em> they use. The type of a
|
|
101
|
-
font face can be queried using <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-get-type"><code class="function">cairo_font_face_get_type()</code></a>.
|
|
102
|
-
</p>
|
|
103
|
-
<p>
|
|
104
|
-
Memory management of <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t"><span class="type">cairo_font_face_t</span></a> is done with
|
|
105
|
-
<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-reference"><code class="function">cairo_font_face_reference()</code></a> and <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-destroy"><code class="function">cairo_font_face_destroy()</code></a>.</p>
|
|
106
|
-
<p>
|
|
107
|
-
|
|
108
|
-
</p>
|
|
109
|
-
</div>
|
|
110
|
-
<hr>
|
|
111
|
-
<div class="refsect2" lang="en">
|
|
112
|
-
<a name="id2641773"></a><h3>
|
|
113
|
-
<a name="cairo-font-face-reference"></a>cairo_font_face_reference ()</h3>
|
|
114
|
-
<a class="indexterm" name="id2641784"></a><pre class="programlisting"><a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t">cairo_font_face_t</a>* cairo_font_face_reference (<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t">cairo_font_face_t</a> *font_face);</pre>
|
|
115
|
-
<p>
|
|
116
|
-
Increases the reference count on <em class="parameter"><code>font_face</code></em> by one. This prevents
|
|
117
|
-
<em class="parameter"><code>font_face</code></em> from being destroyed until a matching call to
|
|
118
|
-
<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-destroy"><code class="function">cairo_font_face_destroy()</code></a> is made.
|
|
119
|
-
</p>
|
|
120
|
-
<p>
|
|
121
|
-
The number of references to a <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t"><span class="type">cairo_font_face_t</span></a> can be get using
|
|
122
|
-
<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-get-reference-count"><code class="function">cairo_font_face_get_reference_count()</code></a>.</p>
|
|
123
|
-
<p>
|
|
124
|
-
|
|
125
|
-
</p>
|
|
126
|
-
<div class="variablelist"><table border="0">
|
|
127
|
-
<col align="left" valign="top">
|
|
128
|
-
<tbody>
|
|
129
|
-
<tr>
|
|
130
|
-
<td><p><span class="term"><em class="parameter"><code>font_face</code></em> :</span></p></td>
|
|
131
|
-
<td> a <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t"><span class="type">cairo_font_face_t</span></a>, (may be <code class="literal">NULL</code> in which case this
|
|
132
|
-
function does nothing).
|
|
133
|
-
</td>
|
|
134
|
-
</tr>
|
|
135
|
-
<tr>
|
|
136
|
-
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
137
|
-
<td> the referenced <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t"><span class="type">cairo_font_face_t</span></a>.
|
|
138
|
-
</td>
|
|
139
|
-
</tr>
|
|
140
|
-
</tbody>
|
|
141
|
-
</table></div>
|
|
142
|
-
</div>
|
|
143
|
-
<hr>
|
|
144
|
-
<div class="refsect2" lang="en">
|
|
145
|
-
<a name="id2642165"></a><h3>
|
|
146
|
-
<a name="cairo-font-face-destroy"></a>cairo_font_face_destroy ()</h3>
|
|
147
|
-
<a class="indexterm" name="id2642176"></a><pre class="programlisting">void cairo_font_face_destroy (<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t">cairo_font_face_t</a> *font_face);</pre>
|
|
148
|
-
<p>
|
|
149
|
-
Decreases the reference count on <em class="parameter"><code>font_face</code></em> by one. If the result
|
|
150
|
-
is zero, then <em class="parameter"><code>font_face</code></em> and all associated resources are freed.
|
|
151
|
-
See <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-reference"><code class="function">cairo_font_face_reference()</code></a>.</p>
|
|
152
|
-
<p>
|
|
153
|
-
|
|
154
|
-
</p>
|
|
155
|
-
<div class="variablelist"><table border="0">
|
|
156
|
-
<col align="left" valign="top">
|
|
157
|
-
<tbody><tr>
|
|
158
|
-
<td><p><span class="term"><em class="parameter"><code>font_face</code></em> :</span></p></td>
|
|
159
|
-
<td> a <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t"><span class="type">cairo_font_face_t</span></a>
|
|
160
|
-
</td>
|
|
161
|
-
</tr></tbody>
|
|
162
|
-
</table></div>
|
|
163
|
-
</div>
|
|
164
|
-
<hr>
|
|
165
|
-
<div class="refsect2" lang="en">
|
|
166
|
-
<a name="id2642255"></a><h3>
|
|
167
|
-
<a name="cairo-font-face-status"></a>cairo_font_face_status ()</h3>
|
|
168
|
-
<a class="indexterm" name="id2642266"></a><pre class="programlisting"><a class="link" href="cairo-Error-Handling.html#cairo-status-t">cairo_status_t</a> cairo_font_face_status (<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t">cairo_font_face_t</a> *font_face);</pre>
|
|
169
|
-
<p>
|
|
170
|
-
Checks whether an error has previously occurred for this
|
|
171
|
-
font face</p>
|
|
172
|
-
<p>
|
|
173
|
-
|
|
174
|
-
</p>
|
|
175
|
-
<div class="variablelist"><table border="0">
|
|
176
|
-
<col align="left" valign="top">
|
|
177
|
-
<tbody>
|
|
178
|
-
<tr>
|
|
179
|
-
<td><p><span class="term"><em class="parameter"><code>font_face</code></em> :</span></p></td>
|
|
180
|
-
<td> a <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t"><span class="type">cairo_font_face_t</span></a>
|
|
181
|
-
</td>
|
|
182
|
-
</tr>
|
|
183
|
-
<tr>
|
|
184
|
-
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
185
|
-
<td> <a class="link" href="cairo-Error-Handling.html#CAIRO-STATUS-SUCCESS:CAPS"><code class="literal">CAIRO_STATUS_SUCCESS</code></a> or another error such as
|
|
186
|
-
<a class="link" href="cairo-Error-Handling.html#CAIRO-STATUS-NO-MEMORY:CAPS"><code class="literal">CAIRO_STATUS_NO_MEMORY</code></a>.
|
|
187
|
-
</td>
|
|
188
|
-
</tr>
|
|
189
|
-
</tbody>
|
|
190
|
-
</table></div>
|
|
191
|
-
</div>
|
|
192
|
-
<hr>
|
|
193
|
-
<div class="refsect2" lang="en">
|
|
194
|
-
<a name="id2629117"></a><h3>
|
|
195
|
-
<a name="cairo-font-type-t"></a>enum cairo_font_type_t</h3>
|
|
196
|
-
<a class="indexterm" name="id2629132"></a><pre class="programlisting">typedef enum _cairo_font_type {
|
|
197
|
-
CAIRO_FONT_TYPE_TOY,
|
|
198
|
-
CAIRO_FONT_TYPE_FT,
|
|
199
|
-
CAIRO_FONT_TYPE_WIN32,
|
|
200
|
-
CAIRO_FONT_TYPE_QUARTZ
|
|
201
|
-
} cairo_font_type_t;
|
|
202
|
-
</pre>
|
|
203
|
-
<p>
|
|
204
|
-
<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-type-t"><span class="type">cairo_font_type_t</span></a> is used to describe the type of a given font
|
|
205
|
-
face or scaled font. The font types are also known as "font
|
|
206
|
-
backends" within cairo.
|
|
207
|
-
</p>
|
|
208
|
-
<p>
|
|
209
|
-
The type of a font face is determined by the function used to
|
|
210
|
-
create it, which will generally be of the form
|
|
211
|
-
cairo_<span class="emphasis"><em>type</em></span>_font_face_create. The font face type can be queried
|
|
212
|
-
with <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-get-type"><code class="function">cairo_font_face_get_type()</code></a>
|
|
213
|
-
</p>
|
|
214
|
-
<p>
|
|
215
|
-
The various <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t"><span class="type">cairo_font_face_t</span></a> functions can be used with a font face
|
|
216
|
-
of any type.
|
|
217
|
-
</p>
|
|
218
|
-
<p>
|
|
219
|
-
The type of a scaled font is determined by the type of the font
|
|
220
|
-
face passed to <a class="link" href="cairo-Scaled-Fonts.html#cairo-scaled-font-create"><code class="function">cairo_scaled_font_create()</code></a>. The scaled font type can
|
|
221
|
-
be queried with <a class="link" href="cairo-Scaled-Fonts.html#cairo-scaled-font-get-type"><code class="function">cairo_scaled_font_get_type()</code></a>
|
|
222
|
-
</p>
|
|
223
|
-
<p>
|
|
224
|
-
The various <a class="link" href="cairo-Scaled-Fonts.html#cairo-scaled-font-t"><span class="type">cairo_scaled_font_t</span></a> functions can be used with scaled
|
|
225
|
-
fonts of any type, but some font backends also provide
|
|
226
|
-
type-specific functions that must only be called with a scaled font
|
|
227
|
-
of the appropriate type. These functions have names that begin with
|
|
228
|
-
cairo_<span class="emphasis"><em>type</em></span>_scaled_font such as <a class="link" href="cairo-FreeType-Fonts.html#cairo-ft-scaled-font-lock-face"><code class="function">cairo_ft_scaled_font_lock_face()</code></a>.
|
|
229
|
-
</p>
|
|
230
|
-
<p>
|
|
231
|
-
The behavior of calling a type-specific function with a scaled font
|
|
232
|
-
of the wrong type is undefined.
|
|
233
|
-
</p>
|
|
234
|
-
<p>
|
|
235
|
-
New entries may be added in future versions.</p>
|
|
236
|
-
<p>
|
|
237
|
-
|
|
238
|
-
</p>
|
|
239
|
-
<div class="variablelist"><table border="0">
|
|
240
|
-
<col align="left" valign="top">
|
|
241
|
-
<tbody>
|
|
242
|
-
<tr>
|
|
243
|
-
<td><p><span class="term"><a name="CAIRO-FONT-TYPE-TOY:CAPS"></a><code class="literal">CAIRO_FONT_TYPE_TOY</code></span></p></td>
|
|
244
|
-
<td> The font was created using cairo's toy font api
|
|
245
|
-
</td>
|
|
246
|
-
</tr>
|
|
247
|
-
<tr>
|
|
248
|
-
<td><p><span class="term"><a name="CAIRO-FONT-TYPE-FT:CAPS"></a><code class="literal">CAIRO_FONT_TYPE_FT</code></span></p></td>
|
|
249
|
-
<td> The font is of type FreeType
|
|
250
|
-
</td>
|
|
251
|
-
</tr>
|
|
252
|
-
<tr>
|
|
253
|
-
<td><p><span class="term"><a name="CAIRO-FONT-TYPE-WIN32:CAPS"></a><code class="literal">CAIRO_FONT_TYPE_WIN32</code></span></p></td>
|
|
254
|
-
<td> The font is of type Win32
|
|
255
|
-
</td>
|
|
256
|
-
</tr>
|
|
257
|
-
<tr>
|
|
258
|
-
<td><p><span class="term"><a name="CAIRO-FONT-TYPE-QUARTZ:CAPS"></a><code class="literal">CAIRO_FONT_TYPE_QUARTZ</code></span></p></td>
|
|
259
|
-
<td> The font is of type Quartz (Since: 1.6)
|
|
260
|
-
</td>
|
|
261
|
-
</tr>
|
|
262
|
-
</tbody>
|
|
263
|
-
</table></div>
|
|
264
|
-
<p class="since">Since 1.2
|
|
265
|
-
</p>
|
|
266
|
-
</div>
|
|
267
|
-
<hr>
|
|
268
|
-
<div class="refsect2" lang="en">
|
|
269
|
-
<a name="id2640989"></a><h3>
|
|
270
|
-
<a name="cairo-font-face-get-type"></a>cairo_font_face_get_type ()</h3>
|
|
271
|
-
<a class="indexterm" name="id2641002"></a><pre class="programlisting"><a class="link" href="cairo-cairo-font-face-t.html#cairo-font-type-t">cairo_font_type_t</a> cairo_font_face_get_type (<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t">cairo_font_face_t</a> *font_face);</pre>
|
|
272
|
-
<p>
|
|
273
|
-
This function returns the type of the backend used to create
|
|
274
|
-
a font face. See <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-type-t"><span class="type">cairo_font_type_t</span></a> for available types.</p>
|
|
275
|
-
<p>
|
|
276
|
-
|
|
277
|
-
</p>
|
|
278
|
-
<div class="variablelist"><table border="0">
|
|
279
|
-
<col align="left" valign="top">
|
|
280
|
-
<tbody>
|
|
281
|
-
<tr>
|
|
282
|
-
<td><p><span class="term"><em class="parameter"><code>font_face</code></em> :</span></p></td>
|
|
283
|
-
<td> a font face
|
|
284
|
-
</td>
|
|
285
|
-
</tr>
|
|
286
|
-
<tr>
|
|
287
|
-
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
288
|
-
<td> The type of <em class="parameter"><code>font_face</code></em>.
|
|
289
|
-
|
|
290
|
-
</td>
|
|
291
|
-
</tr>
|
|
292
|
-
</tbody>
|
|
293
|
-
</table></div>
|
|
294
|
-
<p class="since">Since 1.2
|
|
295
|
-
</p>
|
|
296
|
-
</div>
|
|
297
|
-
<hr>
|
|
298
|
-
<div class="refsect2" lang="en">
|
|
299
|
-
<a name="id2641084"></a><h3>
|
|
300
|
-
<a name="cairo-font-face-get-reference-count"></a>cairo_font_face_get_reference_count ()</h3>
|
|
301
|
-
<a class="indexterm" name="id2641099"></a><pre class="programlisting">unsigned int cairo_font_face_get_reference_count (<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t">cairo_font_face_t</a> *font_face);</pre>
|
|
302
|
-
<p>
|
|
303
|
-
Returns the current reference count of <em class="parameter"><code>font_face</code></em>.</p>
|
|
304
|
-
<p>
|
|
305
|
-
|
|
306
|
-
</p>
|
|
307
|
-
<div class="variablelist"><table border="0">
|
|
308
|
-
<col align="left" valign="top">
|
|
309
|
-
<tbody>
|
|
310
|
-
<tr>
|
|
311
|
-
<td><p><span class="term"><em class="parameter"><code>font_face</code></em> :</span></p></td>
|
|
312
|
-
<td> a <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t"><span class="type">cairo_font_face_t</span></a>
|
|
313
|
-
</td>
|
|
314
|
-
</tr>
|
|
315
|
-
<tr>
|
|
316
|
-
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
317
|
-
<td> the current reference count of <em class="parameter"><code>font_face</code></em>. If the
|
|
318
|
-
object is a nil object, 0 will be returned.
|
|
319
|
-
|
|
320
|
-
</td>
|
|
321
|
-
</tr>
|
|
322
|
-
</tbody>
|
|
323
|
-
</table></div>
|
|
324
|
-
<p class="since">Since 1.4
|
|
325
|
-
</p>
|
|
326
|
-
</div>
|
|
327
|
-
<hr>
|
|
328
|
-
<div class="refsect2" lang="en">
|
|
329
|
-
<a name="id2641188"></a><h3>
|
|
330
|
-
<a name="cairo-font-face-set-user-data"></a>cairo_font_face_set_user_data ()</h3>
|
|
331
|
-
<a class="indexterm" name="id2641202"></a><pre class="programlisting"><a class="link" href="cairo-Error-Handling.html#cairo-status-t">cairo_status_t</a> cairo_font_face_set_user_data (<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t">cairo_font_face_t</a> *font_face,
|
|
332
|
-
const <a class="link" href="cairo-Types.html#cairo-user-data-key-t">cairo_user_data_key_t</a> *key,
|
|
333
|
-
void *user_data,
|
|
334
|
-
<a class="link" href="cairo-Types.html#cairo-destroy-func-t">cairo_destroy_func_t</a> destroy);</pre>
|
|
335
|
-
<p>
|
|
336
|
-
Attach user data to <em class="parameter"><code>font_face</code></em>. To remove user data from a font face,
|
|
337
|
-
call this function with the key that was used to set it and <code class="literal">NULL</code>
|
|
338
|
-
for <em class="parameter"><code>data</code></em>.</p>
|
|
339
|
-
<p>
|
|
340
|
-
|
|
341
|
-
</p>
|
|
342
|
-
<div class="variablelist"><table border="0">
|
|
343
|
-
<col align="left" valign="top">
|
|
344
|
-
<tbody>
|
|
345
|
-
<tr>
|
|
346
|
-
<td><p><span class="term"><em class="parameter"><code>font_face</code></em> :</span></p></td>
|
|
347
|
-
<td> a <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t"><span class="type">cairo_font_face_t</span></a>
|
|
348
|
-
</td>
|
|
349
|
-
</tr>
|
|
350
|
-
<tr>
|
|
351
|
-
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
|
|
352
|
-
<td> the address of a <a class="link" href="cairo-Types.html#cairo-user-data-key-t"><span class="type">cairo_user_data_key_t</span></a> to attach the user data to
|
|
353
|
-
</td>
|
|
354
|
-
</tr>
|
|
355
|
-
<tr>
|
|
356
|
-
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
|
|
357
|
-
<td> the user data to attach to the font face
|
|
358
|
-
</td>
|
|
359
|
-
</tr>
|
|
360
|
-
<tr>
|
|
361
|
-
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
|
|
362
|
-
<td> a <a class="link" href="cairo-Types.html#cairo-destroy-func-t"><span class="type">cairo_destroy_func_t</span></a> which will be called when the
|
|
363
|
-
font face is destroyed or when new user data is attached using the
|
|
364
|
-
same key.
|
|
365
|
-
</td>
|
|
366
|
-
</tr>
|
|
367
|
-
<tr>
|
|
368
|
-
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
369
|
-
<td> <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
|
|
370
|
-
slot could not be allocated for the user data.
|
|
371
|
-
</td>
|
|
372
|
-
</tr>
|
|
373
|
-
</tbody>
|
|
374
|
-
</table></div>
|
|
375
|
-
</div>
|
|
376
|
-
<hr>
|
|
377
|
-
<div class="refsect2" lang="en">
|
|
378
|
-
<a name="id2626649"></a><h3>
|
|
379
|
-
<a name="cairo-font-face-get-user-data"></a>cairo_font_face_get_user_data ()</h3>
|
|
380
|
-
<a class="indexterm" name="id2626662"></a><pre class="programlisting">void* cairo_font_face_get_user_data (<a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t">cairo_font_face_t</a> *font_face,
|
|
381
|
-
const <a class="link" href="cairo-Types.html#cairo-user-data-key-t">cairo_user_data_key_t</a> *key);</pre>
|
|
382
|
-
<p>
|
|
383
|
-
Return user data previously attached to <em class="parameter"><code>font_face</code></em> using the specified
|
|
384
|
-
key. If no user data has been attached with the given key this
|
|
385
|
-
function returns <code class="literal">NULL</code>.</p>
|
|
386
|
-
<p>
|
|
387
|
-
|
|
388
|
-
</p>
|
|
389
|
-
<div class="variablelist"><table border="0">
|
|
390
|
-
<col align="left" valign="top">
|
|
391
|
-
<tbody>
|
|
392
|
-
<tr>
|
|
393
|
-
<td><p><span class="term"><em class="parameter"><code>font_face</code></em> :</span></p></td>
|
|
394
|
-
<td> a <a class="link" href="cairo-cairo-font-face-t.html#cairo-font-face-t"><span class="type">cairo_font_face_t</span></a>
|
|
395
|
-
</td>
|
|
396
|
-
</tr>
|
|
397
|
-
<tr>
|
|
398
|
-
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
|
|
399
|
-
<td> the address of the <a class="link" href="cairo-Types.html#cairo-user-data-key-t"><span class="type">cairo_user_data_key_t</span></a> the user data was
|
|
400
|
-
attached to
|
|
401
|
-
</td>
|
|
402
|
-
</tr>
|
|
403
|
-
<tr>
|
|
404
|
-
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
405
|
-
<td> the user data previously attached or <code class="literal">NULL</code>.
|
|
406
|
-
</td>
|
|
407
|
-
</tr>
|
|
408
|
-
</tbody>
|
|
409
|
-
</table></div>
|
|
410
|
-
</div>
|
|
411
|
-
</div>
|
|
412
|
-
<div class="refsect1" lang="en">
|
|
413
|
-
<a name="id2626787"></a><h2>See Also</h2>
|
|
414
|
-
<p>
|
|
415
|
-
</p>
|
|
416
|
-
<div class="itemizedlist"><ul type="disc"><li><a class="link" href="cairo-Scaled-Fonts.html#cairo-scaled-font-t"><span class="type">cairo_scaled_font_t</span></a></li></ul></div>
|
|
417
|
-
<p>
|
|
418
|
-
</p>
|
|
419
|
-
</div>
|
|
420
|
-
<div class="refsect1" lang="en">
|
|
421
|
-
<a name="id2626810"></a><div class="refsect2" lang="en"><a name="id2626812"></a></div>
|
|
422
|
-
<hr>
|
|
423
|
-
<div class="refsect2" lang="en"><a name="id2626813"></a></div>
|
|
424
|
-
</div>
|
|
425
|
-
</div>
|
|
426
|
-
</body>
|
|
427
|
-
</html>
|
|
@@ -1,995 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
2
|
-
<html>
|
|
3
|
-
<head>
|
|
4
|
-
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
5
|
-
<title>cairo_surface_t</title>
|
|
6
|
-
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
|
|
7
|
-
<link rel="start" href="index.html" title="Cairo: A Vector Graphics Library">
|
|
8
|
-
<link rel="up" href="Surfaces.html" title="Surfaces">
|
|
9
|
-
<link rel="prev" href="Surfaces.html" title="Surfaces">
|
|
10
|
-
<link rel="next" href="cairo-Image-Surfaces.html" title="Image Surfaces">
|
|
11
|
-
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
|
|
12
|
-
<link rel="stylesheet" href="style.css" type="text/css">
|
|
13
|
-
<link rel="chapter" href="Drawing.html" title="Drawing">
|
|
14
|
-
<link rel="chapter" href="Fonts.html" title="Fonts">
|
|
15
|
-
<link rel="chapter" href="Surfaces.html" title="Surfaces">
|
|
16
|
-
<link rel="chapter" href="Support.html" title="Utilities">
|
|
17
|
-
<link rel="index" href="ix01.html" title="Index">
|
|
18
|
-
<link rel="index" href="index-1.2.html" title="Index of new symbols in 1.2">
|
|
19
|
-
<link rel="index" href="index-1.4.html" title="Index of new symbols in 1.4">
|
|
20
|
-
<link rel="index" href="index-1.6.html" title="Index of new symbols in 1.6">
|
|
21
|
-
<link rel="appendix" href="language-bindings.html" title="Appendix A. Creating a language binding for cairo">
|
|
22
|
-
</head>
|
|
23
|
-
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
24
|
-
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
|
|
25
|
-
<tr valign="middle">
|
|
26
|
-
<td><a accesskey="p" href="Surfaces.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
|
|
27
|
-
<td><a accesskey="u" href="Surfaces.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
|
|
28
|
-
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
|
|
29
|
-
<th width="100%" align="center">Cairo: A Vector Graphics Library</th>
|
|
30
|
-
<td><a accesskey="n" href="cairo-Image-Surfaces.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
|
|
31
|
-
</tr>
|
|
32
|
-
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2527063" class="shortcut">Top</a>
|
|
33
|
-
 | 
|
|
34
|
-
<a href="#id2650015" class="shortcut">Description</a></nobr></td></tr>
|
|
35
|
-
</table>
|
|
36
|
-
<div class="refentry" lang="en">
|
|
37
|
-
<a name="cairo-cairo-surface-t"></a><div class="titlepage"></div>
|
|
38
|
-
<div class="refnamediv"><table width="100%"><tr>
|
|
39
|
-
<td valign="top">
|
|
40
|
-
<h2>
|
|
41
|
-
<a name="id2527063"></a><span class="refentrytitle">cairo_surface_t</span>
|
|
42
|
-
</h2>
|
|
43
|
-
<p>cairo_surface_t — Base class for surfaces</p>
|
|
44
|
-
</td>
|
|
45
|
-
<td valign="top" align="right"></td>
|
|
46
|
-
</tr></table></div>
|
|
47
|
-
<div class="refsynopsisdiv">
|
|
48
|
-
<h2>Synopsis</h2>
|
|
49
|
-
<pre class="synopsis">
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
typedef <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a>;
|
|
54
|
-
enum <a class="link" href="cairo-cairo-surface-t.html#cairo-content-t">cairo_content_t</a>;
|
|
55
|
-
<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a>* <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-create-similar">cairo_surface_create_similar</a> (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *other,
|
|
56
|
-
<a class="link" href="cairo-cairo-surface-t.html#cairo-content-t">cairo_content_t</a> content,
|
|
57
|
-
int width,
|
|
58
|
-
int height);
|
|
59
|
-
<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a>* <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-reference">cairo_surface_reference</a> (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);
|
|
60
|
-
void <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-destroy">cairo_surface_destroy</a> (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);
|
|
61
|
-
<a class="link" href="cairo-Error-Handling.html#cairo-status-t">cairo_status_t</a> <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-status">cairo_surface_status</a> (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);
|
|
62
|
-
void <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-finish">cairo_surface_finish</a> (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);
|
|
63
|
-
void <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-flush">cairo_surface_flush</a> (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);
|
|
64
|
-
void <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-font-options">cairo_surface_get_font_options</a> (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface,
|
|
65
|
-
<a class="link" href="cairo-Font-Options.html#cairo-font-options-t">cairo_font_options_t</a> *options);
|
|
66
|
-
<a class="link" href="cairo-cairo-surface-t.html#cairo-content-t">cairo_content_t</a> <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-content">cairo_surface_get_content</a> (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);
|
|
67
|
-
void <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-mark-dirty">cairo_surface_mark_dirty</a> (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);
|
|
68
|
-
void <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-mark-dirty-rectangle">cairo_surface_mark_dirty_rectangle</a> (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface,
|
|
69
|
-
int x,
|
|
70
|
-
int y,
|
|
71
|
-
int width,
|
|
72
|
-
int height);
|
|
73
|
-
void <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-set-device-offset">cairo_surface_set_device_offset</a> (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface,
|
|
74
|
-
double x_offset,
|
|
75
|
-
double y_offset);
|
|
76
|
-
void <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-device-offset">cairo_surface_get_device_offset</a> (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface,
|
|
77
|
-
double *x_offset,
|
|
78
|
-
double *y_offset);
|
|
79
|
-
void <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-set-fallback-resolution">cairo_surface_set_fallback_resolution</a>
|
|
80
|
-
(<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface,
|
|
81
|
-
double x_pixels_per_inch,
|
|
82
|
-
double y_pixels_per_inch);
|
|
83
|
-
enum <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-type-t">cairo_surface_type_t</a>;
|
|
84
|
-
<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-type-t">cairo_surface_type_t</a> <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-type">cairo_surface_get_type</a> (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);
|
|
85
|
-
unsigned int <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-reference-count">cairo_surface_get_reference_count</a> (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);
|
|
86
|
-
<a class="link" href="cairo-Error-Handling.html#cairo-status-t">cairo_status_t</a> <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-set-user-data">cairo_surface_set_user_data</a> (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface,
|
|
87
|
-
const <a class="link" href="cairo-Types.html#cairo-user-data-key-t">cairo_user_data_key_t</a> *key,
|
|
88
|
-
void *user_data,
|
|
89
|
-
<a class="link" href="cairo-Types.html#cairo-destroy-func-t">cairo_destroy_func_t</a> destroy);
|
|
90
|
-
void* <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-user-data">cairo_surface_get_user_data</a> (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface,
|
|
91
|
-
const <a class="link" href="cairo-Types.html#cairo-user-data-key-t">cairo_user_data_key_t</a> *key);
|
|
92
|
-
void <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-copy-page">cairo_surface_copy_page</a> (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);
|
|
93
|
-
void <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-show-page">cairo_surface_show_page</a> (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);
|
|
94
|
-
</pre>
|
|
95
|
-
</div>
|
|
96
|
-
<div class="refsect1" lang="en">
|
|
97
|
-
<a name="id2650015"></a><h2>Description</h2>
|
|
98
|
-
<p>
|
|
99
|
-
<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a> is the abstract type representing all different drawing
|
|
100
|
-
targets that cairo can render to. The actual drawings are
|
|
101
|
-
performed using a cairo <em class="firstterm">context</em>.
|
|
102
|
-
</p>
|
|
103
|
-
<p>
|
|
104
|
-
A cairo surface is created by using <em class="firstterm">backend</em>-specific
|
|
105
|
-
constructors, typically of the form
|
|
106
|
-
cairo_<span class="emphasis"><em>backend</em></span><code class="function">_surface_create()</code>.
|
|
107
|
-
</p>
|
|
108
|
-
</div>
|
|
109
|
-
<div class="refsect1" lang="en">
|
|
110
|
-
<a name="id2650064"></a><h2>Details</h2>
|
|
111
|
-
<div class="refsect2" lang="en">
|
|
112
|
-
<a name="id2650075"></a><h3>
|
|
113
|
-
<a name="cairo-surface-t"></a>cairo_surface_t</h3>
|
|
114
|
-
<a class="indexterm" name="id2656052"></a><pre class="programlisting">typedef struct _cairo_surface cairo_surface_t;
|
|
115
|
-
</pre>
|
|
116
|
-
<p>
|
|
117
|
-
A <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a> represents an image, either as the destination
|
|
118
|
-
of a drawing operation or as source when drawing onto another
|
|
119
|
-
surface. To draw to a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>, create a cairo context
|
|
120
|
-
with the surface as the target, using <a class="link" href="cairo-cairo-t.html#cairo-create"><code class="function">cairo_create()</code></a>.
|
|
121
|
-
</p>
|
|
122
|
-
<p>
|
|
123
|
-
There are different subtypes of <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a> for
|
|
124
|
-
different drawing backends; for example, <a class="link" href="cairo-Image-Surfaces.html#cairo-image-surface-create"><code class="function">cairo_image_surface_create()</code></a>
|
|
125
|
-
creates a bitmap image in memory.
|
|
126
|
-
The type of a surface can be queried with <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-type"><code class="function">cairo_surface_get_type()</code></a>.
|
|
127
|
-
</p>
|
|
128
|
-
<p>
|
|
129
|
-
Memory management of <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a> is done with
|
|
130
|
-
<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-reference"><code class="function">cairo_surface_reference()</code></a> and <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-destroy"><code class="function">cairo_surface_destroy()</code></a>.</p>
|
|
131
|
-
<p>
|
|
132
|
-
|
|
133
|
-
</p>
|
|
134
|
-
</div>
|
|
135
|
-
<hr>
|
|
136
|
-
<div class="refsect2" lang="en">
|
|
137
|
-
<a name="id2656157"></a><h3>
|
|
138
|
-
<a name="cairo-content-t"></a>enum cairo_content_t</h3>
|
|
139
|
-
<a class="indexterm" name="id2656170"></a><pre class="programlisting">typedef enum _cairo_content {
|
|
140
|
-
CAIRO_CONTENT_COLOR = 0x1000,
|
|
141
|
-
CAIRO_CONTENT_ALPHA = 0x2000,
|
|
142
|
-
CAIRO_CONTENT_COLOR_ALPHA = 0x3000
|
|
143
|
-
} cairo_content_t;
|
|
144
|
-
</pre>
|
|
145
|
-
<p>
|
|
146
|
-
<a class="link" href="cairo-cairo-surface-t.html#cairo-content-t"><span class="type">cairo_content_t</span></a> is used to describe the content that a surface will
|
|
147
|
-
contain, whether color information, alpha information (translucence
|
|
148
|
-
vs. opacity), or both.
|
|
149
|
-
</p>
|
|
150
|
-
<p>
|
|
151
|
-
Note: The large values here are designed to keep <a class="link" href="cairo-cairo-surface-t.html#cairo-content-t"><span class="type">cairo_content_t</span></a>
|
|
152
|
-
values distinct from <a class="link" href="cairo-Image-Surfaces.html#cairo-format-t"><span class="type">cairo_format_t</span></a> values so that the
|
|
153
|
-
implementation can detect the error if users confuse the two types.</p>
|
|
154
|
-
<p>
|
|
155
|
-
|
|
156
|
-
</p>
|
|
157
|
-
<div class="variablelist"><table border="0">
|
|
158
|
-
<col align="left" valign="top">
|
|
159
|
-
<tbody>
|
|
160
|
-
<tr>
|
|
161
|
-
<td><p><span class="term"><a name="CAIRO-CONTENT-COLOR:CAPS"></a><code class="literal">CAIRO_CONTENT_COLOR</code></span></p></td>
|
|
162
|
-
<td> The surface will hold color content only.
|
|
163
|
-
</td>
|
|
164
|
-
</tr>
|
|
165
|
-
<tr>
|
|
166
|
-
<td><p><span class="term"><a name="CAIRO-CONTENT-ALPHA:CAPS"></a><code class="literal">CAIRO_CONTENT_ALPHA</code></span></p></td>
|
|
167
|
-
<td> The surface will hold alpha content only.
|
|
168
|
-
</td>
|
|
169
|
-
</tr>
|
|
170
|
-
<tr>
|
|
171
|
-
<td><p><span class="term"><a name="CAIRO-CONTENT-COLOR-ALPHA:CAPS"></a><code class="literal">CAIRO_CONTENT_COLOR_ALPHA</code></span></p></td>
|
|
172
|
-
<td> The surface will hold color and alpha content.
|
|
173
|
-
</td>
|
|
174
|
-
</tr>
|
|
175
|
-
</tbody>
|
|
176
|
-
</table></div>
|
|
177
|
-
</div>
|
|
178
|
-
<hr>
|
|
179
|
-
<div class="refsect2" lang="en">
|
|
180
|
-
<a name="id2656289"></a><h3>
|
|
181
|
-
<a name="cairo-surface-create-similar"></a>cairo_surface_create_similar ()</h3>
|
|
182
|
-
<a class="indexterm" name="id2656300"></a><pre class="programlisting"><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a>* cairo_surface_create_similar (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *other,
|
|
183
|
-
<a class="link" href="cairo-cairo-surface-t.html#cairo-content-t">cairo_content_t</a> content,
|
|
184
|
-
int width,
|
|
185
|
-
int height);</pre>
|
|
186
|
-
<p>
|
|
187
|
-
Create a new surface that is as compatible as possible with an
|
|
188
|
-
existing surface. For example the new surface will have the same
|
|
189
|
-
fallback resolution and font options as <em class="parameter"><code>other</code></em>. Generally, the new
|
|
190
|
-
surface will also use the same backend as <em class="parameter"><code>other</code></em>, unless that is
|
|
191
|
-
not possible for some reason. The type of the returned surface may
|
|
192
|
-
be examined with <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-type"><code class="function">cairo_surface_get_type()</code></a>.
|
|
193
|
-
</p>
|
|
194
|
-
<p>
|
|
195
|
-
Initially the surface contents are all 0 (transparent if contents
|
|
196
|
-
have transparency, black otherwise.)</p>
|
|
197
|
-
<p>
|
|
198
|
-
|
|
199
|
-
</p>
|
|
200
|
-
<div class="variablelist"><table border="0">
|
|
201
|
-
<col align="left" valign="top">
|
|
202
|
-
<tbody>
|
|
203
|
-
<tr>
|
|
204
|
-
<td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td>
|
|
205
|
-
<td> an existing surface used to select the backend of the new surface
|
|
206
|
-
</td>
|
|
207
|
-
</tr>
|
|
208
|
-
<tr>
|
|
209
|
-
<td><p><span class="term"><em class="parameter"><code>content</code></em> :</span></p></td>
|
|
210
|
-
<td> the content for the new surface
|
|
211
|
-
</td>
|
|
212
|
-
</tr>
|
|
213
|
-
<tr>
|
|
214
|
-
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
|
|
215
|
-
<td> width of the new surface, (in device-space units)
|
|
216
|
-
</td>
|
|
217
|
-
</tr>
|
|
218
|
-
<tr>
|
|
219
|
-
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
|
|
220
|
-
<td> height of the new surface (in device-space units)
|
|
221
|
-
</td>
|
|
222
|
-
</tr>
|
|
223
|
-
<tr>
|
|
224
|
-
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
225
|
-
<td> a pointer to the newly allocated surface. The caller
|
|
226
|
-
owns the surface and should call <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-destroy"><code class="function">cairo_surface_destroy()</code></a> when done
|
|
227
|
-
with it.
|
|
228
|
-
|
|
229
|
-
This function always returns a valid pointer, but it will return a
|
|
230
|
-
pointer to a "nil" surface if <em class="parameter"><code>other</code></em> is already in an error state
|
|
231
|
-
or any other error occurs.
|
|
232
|
-
</td>
|
|
233
|
-
</tr>
|
|
234
|
-
</tbody>
|
|
235
|
-
</table></div>
|
|
236
|
-
</div>
|
|
237
|
-
<hr>
|
|
238
|
-
<div class="refsect2" lang="en">
|
|
239
|
-
<a name="id2661829"></a><h3>
|
|
240
|
-
<a name="cairo-surface-reference"></a>cairo_surface_reference ()</h3>
|
|
241
|
-
<a class="indexterm" name="id2661839"></a><pre class="programlisting"><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a>* cairo_surface_reference (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);</pre>
|
|
242
|
-
<p>
|
|
243
|
-
Increases the reference count on <em class="parameter"><code>surface</code></em> by one. This prevents
|
|
244
|
-
<em class="parameter"><code>surface</code></em> from being destroyed until a matching call to
|
|
245
|
-
<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-destroy"><code class="function">cairo_surface_destroy()</code></a> is made.
|
|
246
|
-
</p>
|
|
247
|
-
<p>
|
|
248
|
-
The number of references to a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a> can be get using
|
|
249
|
-
<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-reference-count"><code class="function">cairo_surface_get_reference_count()</code></a>.</p>
|
|
250
|
-
<p>
|
|
251
|
-
|
|
252
|
-
</p>
|
|
253
|
-
<div class="variablelist"><table border="0">
|
|
254
|
-
<col align="left" valign="top">
|
|
255
|
-
<tbody>
|
|
256
|
-
<tr>
|
|
257
|
-
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
|
|
258
|
-
<td> a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>
|
|
259
|
-
</td>
|
|
260
|
-
</tr>
|
|
261
|
-
<tr>
|
|
262
|
-
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
263
|
-
<td> the referenced <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>.
|
|
264
|
-
</td>
|
|
265
|
-
</tr>
|
|
266
|
-
</tbody>
|
|
267
|
-
</table></div>
|
|
268
|
-
</div>
|
|
269
|
-
<hr>
|
|
270
|
-
<div class="refsect2" lang="en">
|
|
271
|
-
<a name="id2661953"></a><h3>
|
|
272
|
-
<a name="cairo-surface-destroy"></a>cairo_surface_destroy ()</h3>
|
|
273
|
-
<a class="indexterm" name="id2661964"></a><pre class="programlisting">void cairo_surface_destroy (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);</pre>
|
|
274
|
-
<p>
|
|
275
|
-
Decreases the reference count on <em class="parameter"><code>surface</code></em> by one. If the result is
|
|
276
|
-
zero, then <em class="parameter"><code>surface</code></em> and all associated resources are freed. See
|
|
277
|
-
<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-reference"><code class="function">cairo_surface_reference()</code></a>.</p>
|
|
278
|
-
<p>
|
|
279
|
-
|
|
280
|
-
</p>
|
|
281
|
-
<div class="variablelist"><table border="0">
|
|
282
|
-
<col align="left" valign="top">
|
|
283
|
-
<tbody><tr>
|
|
284
|
-
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
|
|
285
|
-
<td> a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>
|
|
286
|
-
</td>
|
|
287
|
-
</tr></tbody>
|
|
288
|
-
</table></div>
|
|
289
|
-
</div>
|
|
290
|
-
<hr>
|
|
291
|
-
<div class="refsect2" lang="en">
|
|
292
|
-
<a name="id2662043"></a><h3>
|
|
293
|
-
<a name="cairo-surface-status"></a>cairo_surface_status ()</h3>
|
|
294
|
-
<a class="indexterm" name="id2662054"></a><pre class="programlisting"><a class="link" href="cairo-Error-Handling.html#cairo-status-t">cairo_status_t</a> cairo_surface_status (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);</pre>
|
|
295
|
-
<p>
|
|
296
|
-
Checks whether an error has previously occurred for this
|
|
297
|
-
surface.</p>
|
|
298
|
-
<p>
|
|
299
|
-
|
|
300
|
-
</p>
|
|
301
|
-
<div class="variablelist"><table border="0">
|
|
302
|
-
<col align="left" valign="top">
|
|
303
|
-
<tbody>
|
|
304
|
-
<tr>
|
|
305
|
-
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
|
|
306
|
-
<td> a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>
|
|
307
|
-
</td>
|
|
308
|
-
</tr>
|
|
309
|
-
<tr>
|
|
310
|
-
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
311
|
-
<td> <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>,
|
|
312
|
-
<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>,
|
|
313
|
-
<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
|
|
314
|
-
<a class="link" href="cairo-Error-Handling.html#CAIRO-STATUS-INVALID-VISUAL:CAPS"><code class="literal">CAIRO_STATUS_INVALID_VISUAL</code></a>.
|
|
315
|
-
</td>
|
|
316
|
-
</tr>
|
|
317
|
-
</tbody>
|
|
318
|
-
</table></div>
|
|
319
|
-
</div>
|
|
320
|
-
<hr>
|
|
321
|
-
<div class="refsect2" lang="en">
|
|
322
|
-
<a name="id2662189"></a><h3>
|
|
323
|
-
<a name="cairo-surface-finish"></a>cairo_surface_finish ()</h3>
|
|
324
|
-
<a class="indexterm" name="id2662200"></a><pre class="programlisting">void cairo_surface_finish (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);</pre>
|
|
325
|
-
<p>
|
|
326
|
-
This function finishes the surface and drops all references to
|
|
327
|
-
external resources. For example, for the Xlib backend it means
|
|
328
|
-
that cairo will no longer access the drawable, which can be freed.
|
|
329
|
-
After calling <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-finish"><code class="function">cairo_surface_finish()</code></a> the only valid operations on a
|
|
330
|
-
surface are getting and setting user data and referencing and
|
|
331
|
-
destroying it. Further drawing to the surface will not affect the
|
|
332
|
-
surface but will instead trigger a CAIRO_STATUS_SURFACE_FINISHED
|
|
333
|
-
error.
|
|
334
|
-
</p>
|
|
335
|
-
<p>
|
|
336
|
-
When the last call to <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-destroy"><code class="function">cairo_surface_destroy()</code></a> decreases the
|
|
337
|
-
reference count to zero, cairo will call <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-finish"><code class="function">cairo_surface_finish()</code></a> if
|
|
338
|
-
it hasn't been called already, before freeing the resources
|
|
339
|
-
associated with the surface.</p>
|
|
340
|
-
<p>
|
|
341
|
-
|
|
342
|
-
</p>
|
|
343
|
-
<div class="variablelist"><table border="0">
|
|
344
|
-
<col align="left" valign="top">
|
|
345
|
-
<tbody><tr>
|
|
346
|
-
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
|
|
347
|
-
<td> the <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a> to finish
|
|
348
|
-
</td>
|
|
349
|
-
</tr></tbody>
|
|
350
|
-
</table></div>
|
|
351
|
-
</div>
|
|
352
|
-
<hr>
|
|
353
|
-
<div class="refsect2" lang="en">
|
|
354
|
-
<a name="id2662296"></a><h3>
|
|
355
|
-
<a name="cairo-surface-flush"></a>cairo_surface_flush ()</h3>
|
|
356
|
-
<a class="indexterm" name="id2662309"></a><pre class="programlisting">void cairo_surface_flush (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);</pre>
|
|
357
|
-
<p>
|
|
358
|
-
Do any pending drawing for the surface and also restore any
|
|
359
|
-
temporary modification's cairo has made to the surface's
|
|
360
|
-
state. This function must be called before switching from
|
|
361
|
-
drawing on the surface with cairo to drawing on it directly
|
|
362
|
-
with native APIs. If the surface doesn't support direct access,
|
|
363
|
-
then this function does nothing.</p>
|
|
364
|
-
<p>
|
|
365
|
-
|
|
366
|
-
</p>
|
|
367
|
-
<div class="variablelist"><table border="0">
|
|
368
|
-
<col align="left" valign="top">
|
|
369
|
-
<tbody><tr>
|
|
370
|
-
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
|
|
371
|
-
<td> a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>
|
|
372
|
-
</td>
|
|
373
|
-
</tr></tbody>
|
|
374
|
-
</table></div>
|
|
375
|
-
</div>
|
|
376
|
-
<hr>
|
|
377
|
-
<div class="refsect2" lang="en">
|
|
378
|
-
<a name="id2662371"></a><h3>
|
|
379
|
-
<a name="cairo-surface-get-font-options"></a>cairo_surface_get_font_options ()</h3>
|
|
380
|
-
<a class="indexterm" name="id2662384"></a><pre class="programlisting">void cairo_surface_get_font_options (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface,
|
|
381
|
-
<a class="link" href="cairo-Font-Options.html#cairo-font-options-t">cairo_font_options_t</a> *options);</pre>
|
|
382
|
-
<p>
|
|
383
|
-
Retrieves the default font rendering options for the surface.
|
|
384
|
-
This allows display surfaces to report the correct subpixel order
|
|
385
|
-
for rendering on them, print surfaces to disable hinting of
|
|
386
|
-
metrics and so forth. The result can then be used with
|
|
387
|
-
<a class="link" href="cairo-Scaled-Fonts.html#cairo-scaled-font-create"><code class="function">cairo_scaled_font_create()</code></a>.</p>
|
|
388
|
-
<p>
|
|
389
|
-
|
|
390
|
-
</p>
|
|
391
|
-
<div class="variablelist"><table border="0">
|
|
392
|
-
<col align="left" valign="top">
|
|
393
|
-
<tbody>
|
|
394
|
-
<tr>
|
|
395
|
-
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
|
|
396
|
-
<td> a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>
|
|
397
|
-
</td>
|
|
398
|
-
</tr>
|
|
399
|
-
<tr>
|
|
400
|
-
<td><p><span class="term"><em class="parameter"><code>options</code></em> :</span></p></td>
|
|
401
|
-
<td> a <a class="link" href="cairo-Font-Options.html#cairo-font-options-t"><span class="type">cairo_font_options_t</span></a> object into which to store
|
|
402
|
-
the retrieved options. All existing values are overwritten
|
|
403
|
-
</td>
|
|
404
|
-
</tr>
|
|
405
|
-
</tbody>
|
|
406
|
-
</table></div>
|
|
407
|
-
</div>
|
|
408
|
-
<hr>
|
|
409
|
-
<div class="refsect2" lang="en">
|
|
410
|
-
<a name="id2662484"></a><h3>
|
|
411
|
-
<a name="cairo-surface-get-content"></a>cairo_surface_get_content ()</h3>
|
|
412
|
-
<a class="indexterm" name="id2662498"></a><pre class="programlisting"><a class="link" href="cairo-cairo-surface-t.html#cairo-content-t">cairo_content_t</a> cairo_surface_get_content (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);</pre>
|
|
413
|
-
<p>
|
|
414
|
-
This function returns the content type of <em class="parameter"><code>surface</code></em> which indicates
|
|
415
|
-
whether the surface contains color and/or alpha information. See
|
|
416
|
-
<a class="link" href="cairo-cairo-surface-t.html#cairo-content-t"><span class="type">cairo_content_t</span></a>.</p>
|
|
417
|
-
<p>
|
|
418
|
-
|
|
419
|
-
</p>
|
|
420
|
-
<div class="variablelist"><table border="0">
|
|
421
|
-
<col align="left" valign="top">
|
|
422
|
-
<tbody>
|
|
423
|
-
<tr>
|
|
424
|
-
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
|
|
425
|
-
<td> a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>
|
|
426
|
-
</td>
|
|
427
|
-
</tr>
|
|
428
|
-
<tr>
|
|
429
|
-
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
430
|
-
<td> The content type of <em class="parameter"><code>surface</code></em>.
|
|
431
|
-
|
|
432
|
-
</td>
|
|
433
|
-
</tr>
|
|
434
|
-
</tbody>
|
|
435
|
-
</table></div>
|
|
436
|
-
<p class="since">Since 1.2
|
|
437
|
-
</p>
|
|
438
|
-
</div>
|
|
439
|
-
<hr>
|
|
440
|
-
<div class="refsect2" lang="en">
|
|
441
|
-
<a name="id2662593"></a><h3>
|
|
442
|
-
<a name="cairo-surface-mark-dirty"></a>cairo_surface_mark_dirty ()</h3>
|
|
443
|
-
<a class="indexterm" name="id2662604"></a><pre class="programlisting">void cairo_surface_mark_dirty (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);</pre>
|
|
444
|
-
<p>
|
|
445
|
-
Tells cairo that drawing has been done to surface using means other
|
|
446
|
-
than cairo, and that cairo should reread any cached areas. Note
|
|
447
|
-
that you must call <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-flush"><code class="function">cairo_surface_flush()</code></a> before doing such drawing.</p>
|
|
448
|
-
<p>
|
|
449
|
-
|
|
450
|
-
</p>
|
|
451
|
-
<div class="variablelist"><table border="0">
|
|
452
|
-
<col align="left" valign="top">
|
|
453
|
-
<tbody><tr>
|
|
454
|
-
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
|
|
455
|
-
<td> a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>
|
|
456
|
-
</td>
|
|
457
|
-
</tr></tbody>
|
|
458
|
-
</table></div>
|
|
459
|
-
</div>
|
|
460
|
-
<hr>
|
|
461
|
-
<div class="refsect2" lang="en">
|
|
462
|
-
<a name="id2662673"></a><h3>
|
|
463
|
-
<a name="cairo-surface-mark-dirty-rectangle"></a>cairo_surface_mark_dirty_rectangle ()</h3>
|
|
464
|
-
<a class="indexterm" name="id2662687"></a><pre class="programlisting">void cairo_surface_mark_dirty_rectangle (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface,
|
|
465
|
-
int x,
|
|
466
|
-
int y,
|
|
467
|
-
int width,
|
|
468
|
-
int height);</pre>
|
|
469
|
-
<p>
|
|
470
|
-
Like <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-mark-dirty"><code class="function">cairo_surface_mark_dirty()</code></a>, but drawing has been done only to
|
|
471
|
-
the specified rectangle, so that cairo can retain cached contents
|
|
472
|
-
for other parts of the surface.
|
|
473
|
-
</p>
|
|
474
|
-
<p>
|
|
475
|
-
Any cached clip set on the surface will be reset by this function,
|
|
476
|
-
to make sure that future cairo calls have the clip set that they
|
|
477
|
-
expect.</p>
|
|
478
|
-
<p>
|
|
479
|
-
|
|
480
|
-
</p>
|
|
481
|
-
<div class="variablelist"><table border="0">
|
|
482
|
-
<col align="left" valign="top">
|
|
483
|
-
<tbody>
|
|
484
|
-
<tr>
|
|
485
|
-
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
|
|
486
|
-
<td> a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>
|
|
487
|
-
</td>
|
|
488
|
-
</tr>
|
|
489
|
-
<tr>
|
|
490
|
-
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
|
|
491
|
-
<td> X coordinate of dirty rectangle
|
|
492
|
-
</td>
|
|
493
|
-
</tr>
|
|
494
|
-
<tr>
|
|
495
|
-
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
|
|
496
|
-
<td> Y coordinate of dirty rectangle
|
|
497
|
-
</td>
|
|
498
|
-
</tr>
|
|
499
|
-
<tr>
|
|
500
|
-
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
|
|
501
|
-
<td> width of dirty rectangle
|
|
502
|
-
</td>
|
|
503
|
-
</tr>
|
|
504
|
-
<tr>
|
|
505
|
-
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
|
|
506
|
-
<td> height of dirty rectangle
|
|
507
|
-
</td>
|
|
508
|
-
</tr>
|
|
509
|
-
</tbody>
|
|
510
|
-
</table></div>
|
|
511
|
-
</div>
|
|
512
|
-
<hr>
|
|
513
|
-
<div class="refsect2" lang="en">
|
|
514
|
-
<a name="id2662827"></a><h3>
|
|
515
|
-
<a name="cairo-surface-set-device-offset"></a>cairo_surface_set_device_offset ()</h3>
|
|
516
|
-
<a class="indexterm" name="id2662839"></a><pre class="programlisting">void cairo_surface_set_device_offset (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface,
|
|
517
|
-
double x_offset,
|
|
518
|
-
double y_offset);</pre>
|
|
519
|
-
<p>
|
|
520
|
-
Sets an offset that is added to the device coordinates determined
|
|
521
|
-
by the CTM when drawing to <em class="parameter"><code>surface</code></em>. One use case for this function
|
|
522
|
-
is when we want to create a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a> that redirects drawing
|
|
523
|
-
for a portion of an onscreen surface to an offscreen surface in a
|
|
524
|
-
way that is completely invisible to the user of the cairo
|
|
525
|
-
API. Setting a transformation via <a class="link" href="cairo-Transformations.html#cairo-translate"><code class="function">cairo_translate()</code></a> isn't
|
|
526
|
-
sufficient to do this, since functions like
|
|
527
|
-
<a class="link" href="cairo-Transformations.html#cairo-device-to-user"><code class="function">cairo_device_to_user()</code></a> will expose the hidden offset.
|
|
528
|
-
</p>
|
|
529
|
-
<p>
|
|
530
|
-
Note that the offset affects drawing to the surface as well as
|
|
531
|
-
using the surface in a source pattern.</p>
|
|
532
|
-
<p>
|
|
533
|
-
|
|
534
|
-
</p>
|
|
535
|
-
<div class="variablelist"><table border="0">
|
|
536
|
-
<col align="left" valign="top">
|
|
537
|
-
<tbody>
|
|
538
|
-
<tr>
|
|
539
|
-
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
|
|
540
|
-
<td> a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>
|
|
541
|
-
</td>
|
|
542
|
-
</tr>
|
|
543
|
-
<tr>
|
|
544
|
-
<td><p><span class="term"><em class="parameter"><code>x_offset</code></em> :</span></p></td>
|
|
545
|
-
<td> the offset in the X direction, in device units
|
|
546
|
-
</td>
|
|
547
|
-
</tr>
|
|
548
|
-
<tr>
|
|
549
|
-
<td><p><span class="term"><em class="parameter"><code>y_offset</code></em> :</span></p></td>
|
|
550
|
-
<td> the offset in the Y direction, in device units
|
|
551
|
-
</td>
|
|
552
|
-
</tr>
|
|
553
|
-
</tbody>
|
|
554
|
-
</table></div>
|
|
555
|
-
</div>
|
|
556
|
-
<hr>
|
|
557
|
-
<div class="refsect2" lang="en">
|
|
558
|
-
<a name="id2662971"></a><h3>
|
|
559
|
-
<a name="cairo-surface-get-device-offset"></a>cairo_surface_get_device_offset ()</h3>
|
|
560
|
-
<a class="indexterm" name="id2662986"></a><pre class="programlisting">void cairo_surface_get_device_offset (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface,
|
|
561
|
-
double *x_offset,
|
|
562
|
-
double *y_offset);</pre>
|
|
563
|
-
<p>
|
|
564
|
-
This function returns the previous device offset set by
|
|
565
|
-
<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-set-device-offset"><code class="function">cairo_surface_set_device_offset()</code></a>.</p>
|
|
566
|
-
<p>
|
|
567
|
-
|
|
568
|
-
</p>
|
|
569
|
-
<div class="variablelist"><table border="0">
|
|
570
|
-
<col align="left" valign="top">
|
|
571
|
-
<tbody>
|
|
572
|
-
<tr>
|
|
573
|
-
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
|
|
574
|
-
<td> a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>
|
|
575
|
-
</td>
|
|
576
|
-
</tr>
|
|
577
|
-
<tr>
|
|
578
|
-
<td><p><span class="term"><em class="parameter"><code>x_offset</code></em> :</span></p></td>
|
|
579
|
-
<td> the offset in the X direction, in device units
|
|
580
|
-
</td>
|
|
581
|
-
</tr>
|
|
582
|
-
<tr>
|
|
583
|
-
<td><p><span class="term"><em class="parameter"><code>y_offset</code></em> :</span></p></td>
|
|
584
|
-
<td> the offset in the Y direction, in device units
|
|
585
|
-
</td>
|
|
586
|
-
</tr>
|
|
587
|
-
</tbody>
|
|
588
|
-
</table></div>
|
|
589
|
-
<p class="since">Since 1.2
|
|
590
|
-
</p>
|
|
591
|
-
</div>
|
|
592
|
-
<hr>
|
|
593
|
-
<div class="refsect2" lang="en">
|
|
594
|
-
<a name="id2663094"></a><h3>
|
|
595
|
-
<a name="cairo-surface-set-fallback-resolution"></a>cairo_surface_set_fallback_resolution ()</h3>
|
|
596
|
-
<a class="indexterm" name="id2663108"></a><pre class="programlisting">void cairo_surface_set_fallback_resolution
|
|
597
|
-
(<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface,
|
|
598
|
-
double x_pixels_per_inch,
|
|
599
|
-
double y_pixels_per_inch);</pre>
|
|
600
|
-
<p>
|
|
601
|
-
Set the horizontal and vertical resolution for image fallbacks.
|
|
602
|
-
</p>
|
|
603
|
-
<p>
|
|
604
|
-
When certain operations aren't supported natively by a backend,
|
|
605
|
-
cairo will fallback by rendering operations to an image and then
|
|
606
|
-
overlaying that image onto the output. For backends that are
|
|
607
|
-
natively vector-oriented, this function can be used to set the
|
|
608
|
-
resolution used for these image fallbacks, (larger values will
|
|
609
|
-
result in more detailed images, but also larger file sizes).
|
|
610
|
-
</p>
|
|
611
|
-
<p>
|
|
612
|
-
Some examples of natively vector-oriented backends are the ps, pdf,
|
|
613
|
-
and svg backends.
|
|
614
|
-
</p>
|
|
615
|
-
<p>
|
|
616
|
-
For backends that are natively raster-oriented, image fallbacks are
|
|
617
|
-
still possible, but they are always performed at the native
|
|
618
|
-
device resolution. So this function has no effect on those
|
|
619
|
-
backends.
|
|
620
|
-
</p>
|
|
621
|
-
<p>
|
|
622
|
-
Note: The fallback resolution only takes effect at the time of
|
|
623
|
-
completing a page (with <a class="link" href="cairo-cairo-t.html#cairo-show-page"><code class="function">cairo_show_page()</code></a> or <a class="link" href="cairo-cairo-t.html#cairo-copy-page"><code class="function">cairo_copy_page()</code></a>) so
|
|
624
|
-
there is currently no way to have more than one fallback resolution
|
|
625
|
-
in effect on a single page.
|
|
626
|
-
</p>
|
|
627
|
-
<p>
|
|
628
|
-
The default fallback resoultion is 300 pixels per inch in both
|
|
629
|
-
dimensions.</p>
|
|
630
|
-
<p>
|
|
631
|
-
|
|
632
|
-
</p>
|
|
633
|
-
<div class="variablelist"><table border="0">
|
|
634
|
-
<col align="left" valign="top">
|
|
635
|
-
<tbody>
|
|
636
|
-
<tr>
|
|
637
|
-
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
|
|
638
|
-
<td> a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>
|
|
639
|
-
</td>
|
|
640
|
-
</tr>
|
|
641
|
-
<tr>
|
|
642
|
-
<td><p><span class="term"><em class="parameter"><code>x_pixels_per_inch</code></em> :</span></p></td>
|
|
643
|
-
<td> horizontal setting for pixels per inch
|
|
644
|
-
</td>
|
|
645
|
-
</tr>
|
|
646
|
-
<tr>
|
|
647
|
-
<td><p><span class="term"><em class="parameter"><code>y_pixels_per_inch</code></em> :</span></p></td>
|
|
648
|
-
<td> vertical setting for pixels per inch
|
|
649
|
-
</td>
|
|
650
|
-
</tr>
|
|
651
|
-
</tbody>
|
|
652
|
-
</table></div>
|
|
653
|
-
<p class="since">Since 1.2
|
|
654
|
-
</p>
|
|
655
|
-
</div>
|
|
656
|
-
<hr>
|
|
657
|
-
<div class="refsect2" lang="en">
|
|
658
|
-
<a name="id2663257"></a><h3>
|
|
659
|
-
<a name="cairo-surface-type-t"></a>enum cairo_surface_type_t</h3>
|
|
660
|
-
<a class="indexterm" name="id2663269"></a><pre class="programlisting">typedef enum _cairo_surface_type {
|
|
661
|
-
CAIRO_SURFACE_TYPE_IMAGE,
|
|
662
|
-
CAIRO_SURFACE_TYPE_PDF,
|
|
663
|
-
CAIRO_SURFACE_TYPE_PS,
|
|
664
|
-
CAIRO_SURFACE_TYPE_XLIB,
|
|
665
|
-
CAIRO_SURFACE_TYPE_XCB,
|
|
666
|
-
CAIRO_SURFACE_TYPE_GLITZ,
|
|
667
|
-
CAIRO_SURFACE_TYPE_QUARTZ,
|
|
668
|
-
CAIRO_SURFACE_TYPE_WIN32,
|
|
669
|
-
CAIRO_SURFACE_TYPE_BEOS,
|
|
670
|
-
CAIRO_SURFACE_TYPE_DIRECTFB,
|
|
671
|
-
CAIRO_SURFACE_TYPE_SVG,
|
|
672
|
-
CAIRO_SURFACE_TYPE_OS2,
|
|
673
|
-
CAIRO_SURFACE_TYPE_WIN32_PRINTING,
|
|
674
|
-
CAIRO_SURFACE_TYPE_QUARTZ_IMAGE
|
|
675
|
-
} cairo_surface_type_t;
|
|
676
|
-
</pre>
|
|
677
|
-
<p>
|
|
678
|
-
<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-type-t"><span class="type">cairo_surface_type_t</span></a> is used to describe the type of a given
|
|
679
|
-
surface. The surface types are also known as "backends" or "surface
|
|
680
|
-
backends" within cairo.
|
|
681
|
-
</p>
|
|
682
|
-
<p>
|
|
683
|
-
The type of a surface is determined by the function used to create
|
|
684
|
-
it, which will generally be of the form cairo_<span class="emphasis"><em>type</em></span><code class="function">_surface_create()</code>,
|
|
685
|
-
(though see <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-create-similar"><code class="function">cairo_surface_create_similar()</code></a> as well).
|
|
686
|
-
</p>
|
|
687
|
-
<p>
|
|
688
|
-
The surface type can be queried with <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-get-type"><code class="function">cairo_surface_get_type()</code></a>
|
|
689
|
-
</p>
|
|
690
|
-
<p>
|
|
691
|
-
The various <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a> functions can be used with surfaces of
|
|
692
|
-
any type, but some backends also provide type-specific functions
|
|
693
|
-
that must only be called with a surface of the appropriate
|
|
694
|
-
type. These functions have names that begin with
|
|
695
|
-
cairo_<span class="emphasis"><em>type</em></span>_surface such as <a class="link" href="cairo-Image-Surfaces.html#cairo-image-surface-get-width"><code class="function">cairo_image_surface_get_width()</code></a>.
|
|
696
|
-
</p>
|
|
697
|
-
<p>
|
|
698
|
-
The behavior of calling a type-specific function with a surface of
|
|
699
|
-
the wrong type is undefined.
|
|
700
|
-
</p>
|
|
701
|
-
<p>
|
|
702
|
-
New entries may be added in future versions.</p>
|
|
703
|
-
<p>
|
|
704
|
-
|
|
705
|
-
</p>
|
|
706
|
-
<div class="variablelist"><table border="0">
|
|
707
|
-
<col align="left" valign="top">
|
|
708
|
-
<tbody>
|
|
709
|
-
<tr>
|
|
710
|
-
<td><p><span class="term"><a name="CAIRO-SURFACE-TYPE-IMAGE:CAPS"></a><code class="literal">CAIRO_SURFACE_TYPE_IMAGE</code></span></p></td>
|
|
711
|
-
<td> The surface is of type image
|
|
712
|
-
</td>
|
|
713
|
-
</tr>
|
|
714
|
-
<tr>
|
|
715
|
-
<td><p><span class="term"><a name="CAIRO-SURFACE-TYPE-PDF:CAPS"></a><code class="literal">CAIRO_SURFACE_TYPE_PDF</code></span></p></td>
|
|
716
|
-
<td> The surface is of type pdf
|
|
717
|
-
</td>
|
|
718
|
-
</tr>
|
|
719
|
-
<tr>
|
|
720
|
-
<td><p><span class="term"><a name="CAIRO-SURFACE-TYPE-PS:CAPS"></a><code class="literal">CAIRO_SURFACE_TYPE_PS</code></span></p></td>
|
|
721
|
-
<td> The surface is of type ps
|
|
722
|
-
</td>
|
|
723
|
-
</tr>
|
|
724
|
-
<tr>
|
|
725
|
-
<td><p><span class="term"><a name="CAIRO-SURFACE-TYPE-XLIB:CAPS"></a><code class="literal">CAIRO_SURFACE_TYPE_XLIB</code></span></p></td>
|
|
726
|
-
<td> The surface is of type xlib
|
|
727
|
-
</td>
|
|
728
|
-
</tr>
|
|
729
|
-
<tr>
|
|
730
|
-
<td><p><span class="term"><a name="CAIRO-SURFACE-TYPE-XCB:CAPS"></a><code class="literal">CAIRO_SURFACE_TYPE_XCB</code></span></p></td>
|
|
731
|
-
<td> The surface is of type xcb
|
|
732
|
-
</td>
|
|
733
|
-
</tr>
|
|
734
|
-
<tr>
|
|
735
|
-
<td><p><span class="term"><a name="CAIRO-SURFACE-TYPE-GLITZ:CAPS"></a><code class="literal">CAIRO_SURFACE_TYPE_GLITZ</code></span></p></td>
|
|
736
|
-
<td> The surface is of type glitz
|
|
737
|
-
</td>
|
|
738
|
-
</tr>
|
|
739
|
-
<tr>
|
|
740
|
-
<td><p><span class="term"><a name="CAIRO-SURFACE-TYPE-QUARTZ:CAPS"></a><code class="literal">CAIRO_SURFACE_TYPE_QUARTZ</code></span></p></td>
|
|
741
|
-
<td> The surface is of type quartz
|
|
742
|
-
</td>
|
|
743
|
-
</tr>
|
|
744
|
-
<tr>
|
|
745
|
-
<td><p><span class="term"><a name="CAIRO-SURFACE-TYPE-WIN32:CAPS"></a><code class="literal">CAIRO_SURFACE_TYPE_WIN32</code></span></p></td>
|
|
746
|
-
<td> The surface is of type win32
|
|
747
|
-
</td>
|
|
748
|
-
</tr>
|
|
749
|
-
<tr>
|
|
750
|
-
<td><p><span class="term"><a name="CAIRO-SURFACE-TYPE-BEOS:CAPS"></a><code class="literal">CAIRO_SURFACE_TYPE_BEOS</code></span></p></td>
|
|
751
|
-
<td> The surface is of type beos
|
|
752
|
-
</td>
|
|
753
|
-
</tr>
|
|
754
|
-
<tr>
|
|
755
|
-
<td><p><span class="term"><a name="CAIRO-SURFACE-TYPE-DIRECTFB:CAPS"></a><code class="literal">CAIRO_SURFACE_TYPE_DIRECTFB</code></span></p></td>
|
|
756
|
-
<td> The surface is of type directfb
|
|
757
|
-
</td>
|
|
758
|
-
</tr>
|
|
759
|
-
<tr>
|
|
760
|
-
<td><p><span class="term"><a name="CAIRO-SURFACE-TYPE-SVG:CAPS"></a><code class="literal">CAIRO_SURFACE_TYPE_SVG</code></span></p></td>
|
|
761
|
-
<td> The surface is of type svg
|
|
762
|
-
</td>
|
|
763
|
-
</tr>
|
|
764
|
-
<tr>
|
|
765
|
-
<td><p><span class="term"><a name="CAIRO-SURFACE-TYPE-OS2:CAPS"></a><code class="literal">CAIRO_SURFACE_TYPE_OS2</code></span></p></td>
|
|
766
|
-
<td> The surface is of type os2
|
|
767
|
-
</td>
|
|
768
|
-
</tr>
|
|
769
|
-
<tr>
|
|
770
|
-
<td><p><span class="term"><a name="CAIRO-SURFACE-TYPE-WIN32-PRINTING:CAPS"></a><code class="literal">CAIRO_SURFACE_TYPE_WIN32_PRINTING</code></span></p></td>
|
|
771
|
-
<td> The surface is a win32 printing surface
|
|
772
|
-
</td>
|
|
773
|
-
</tr>
|
|
774
|
-
<tr>
|
|
775
|
-
<td><p><span class="term"><a name="CAIRO-SURFACE-TYPE-QUARTZ-IMAGE:CAPS"></a><code class="literal">CAIRO_SURFACE_TYPE_QUARTZ_IMAGE</code></span></p></td>
|
|
776
|
-
<td> The surface is of type quartz_image
|
|
777
|
-
</td>
|
|
778
|
-
</tr>
|
|
779
|
-
</tbody>
|
|
780
|
-
</table></div>
|
|
781
|
-
<p class="since">Since 1.2
|
|
782
|
-
</p>
|
|
783
|
-
</div>
|
|
784
|
-
<hr>
|
|
785
|
-
<div class="refsect2" lang="en">
|
|
786
|
-
<a name="id2663672"></a><h3>
|
|
787
|
-
<a name="cairo-surface-get-type"></a>cairo_surface_get_type ()</h3>
|
|
788
|
-
<a class="indexterm" name="id2663684"></a><pre class="programlisting"><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-type-t">cairo_surface_type_t</a> cairo_surface_get_type (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);</pre>
|
|
789
|
-
<p>
|
|
790
|
-
This function returns the type of the backend used to create
|
|
791
|
-
a surface. See <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-type-t"><span class="type">cairo_surface_type_t</span></a> for available types.</p>
|
|
792
|
-
<p>
|
|
793
|
-
|
|
794
|
-
</p>
|
|
795
|
-
<div class="variablelist"><table border="0">
|
|
796
|
-
<col align="left" valign="top">
|
|
797
|
-
<tbody>
|
|
798
|
-
<tr>
|
|
799
|
-
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
|
|
800
|
-
<td> a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>
|
|
801
|
-
</td>
|
|
802
|
-
</tr>
|
|
803
|
-
<tr>
|
|
804
|
-
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
805
|
-
<td> The type of <em class="parameter"><code>surface</code></em>.
|
|
806
|
-
|
|
807
|
-
</td>
|
|
808
|
-
</tr>
|
|
809
|
-
</tbody>
|
|
810
|
-
</table></div>
|
|
811
|
-
<p class="since">Since 1.2
|
|
812
|
-
</p>
|
|
813
|
-
</div>
|
|
814
|
-
<hr>
|
|
815
|
-
<div class="refsect2" lang="en">
|
|
816
|
-
<a name="id2663763"></a><h3>
|
|
817
|
-
<a name="cairo-surface-get-reference-count"></a>cairo_surface_get_reference_count ()</h3>
|
|
818
|
-
<a class="indexterm" name="id2663778"></a><pre class="programlisting">unsigned int cairo_surface_get_reference_count (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);</pre>
|
|
819
|
-
<p>
|
|
820
|
-
Returns the current reference count of <em class="parameter"><code>surface</code></em>.</p>
|
|
821
|
-
<p>
|
|
822
|
-
|
|
823
|
-
</p>
|
|
824
|
-
<div class="variablelist"><table border="0">
|
|
825
|
-
<col align="left" valign="top">
|
|
826
|
-
<tbody>
|
|
827
|
-
<tr>
|
|
828
|
-
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
|
|
829
|
-
<td> a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>
|
|
830
|
-
</td>
|
|
831
|
-
</tr>
|
|
832
|
-
<tr>
|
|
833
|
-
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
834
|
-
<td> the current reference count of <em class="parameter"><code>surface</code></em>. If the
|
|
835
|
-
object is a nil object, 0 will be returned.
|
|
836
|
-
|
|
837
|
-
</td>
|
|
838
|
-
</tr>
|
|
839
|
-
</tbody>
|
|
840
|
-
</table></div>
|
|
841
|
-
<p class="since">Since 1.4
|
|
842
|
-
</p>
|
|
843
|
-
</div>
|
|
844
|
-
<hr>
|
|
845
|
-
<div class="refsect2" lang="en">
|
|
846
|
-
<a name="id2663858"></a><h3>
|
|
847
|
-
<a name="cairo-surface-set-user-data"></a>cairo_surface_set_user_data ()</h3>
|
|
848
|
-
<a class="indexterm" name="id2663869"></a><pre class="programlisting"><a class="link" href="cairo-Error-Handling.html#cairo-status-t">cairo_status_t</a> cairo_surface_set_user_data (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface,
|
|
849
|
-
const <a class="link" href="cairo-Types.html#cairo-user-data-key-t">cairo_user_data_key_t</a> *key,
|
|
850
|
-
void *user_data,
|
|
851
|
-
<a class="link" href="cairo-Types.html#cairo-destroy-func-t">cairo_destroy_func_t</a> destroy);</pre>
|
|
852
|
-
<p>
|
|
853
|
-
Attach user data to <em class="parameter"><code>surface</code></em>. To remove user data from a surface,
|
|
854
|
-
call this function with the key that was used to set it and <code class="literal">NULL</code>
|
|
855
|
-
for <em class="parameter"><code>data</code></em>.</p>
|
|
856
|
-
<p>
|
|
857
|
-
|
|
858
|
-
</p>
|
|
859
|
-
<div class="variablelist"><table border="0">
|
|
860
|
-
<col align="left" valign="top">
|
|
861
|
-
<tbody>
|
|
862
|
-
<tr>
|
|
863
|
-
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
|
|
864
|
-
<td> a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>
|
|
865
|
-
</td>
|
|
866
|
-
</tr>
|
|
867
|
-
<tr>
|
|
868
|
-
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
|
|
869
|
-
<td> the address of a <a class="link" href="cairo-Types.html#cairo-user-data-key-t"><span class="type">cairo_user_data_key_t</span></a> to attach the user data to
|
|
870
|
-
</td>
|
|
871
|
-
</tr>
|
|
872
|
-
<tr>
|
|
873
|
-
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
|
|
874
|
-
<td> the user data to attach to the surface
|
|
875
|
-
</td>
|
|
876
|
-
</tr>
|
|
877
|
-
<tr>
|
|
878
|
-
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
|
|
879
|
-
<td> a <a class="link" href="cairo-Types.html#cairo-destroy-func-t"><span class="type">cairo_destroy_func_t</span></a> which will be called when the
|
|
880
|
-
surface is destroyed or when new user data is attached using the
|
|
881
|
-
same key.
|
|
882
|
-
</td>
|
|
883
|
-
</tr>
|
|
884
|
-
<tr>
|
|
885
|
-
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
886
|
-
<td> <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
|
|
887
|
-
slot could not be allocated for the user data.
|
|
888
|
-
</td>
|
|
889
|
-
</tr>
|
|
890
|
-
</tbody>
|
|
891
|
-
</table></div>
|
|
892
|
-
</div>
|
|
893
|
-
<hr>
|
|
894
|
-
<div class="refsect2" lang="en">
|
|
895
|
-
<a name="id2664040"></a><h3>
|
|
896
|
-
<a name="cairo-surface-get-user-data"></a>cairo_surface_get_user_data ()</h3>
|
|
897
|
-
<a class="indexterm" name="id2664051"></a><pre class="programlisting">void* cairo_surface_get_user_data (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface,
|
|
898
|
-
const <a class="link" href="cairo-Types.html#cairo-user-data-key-t">cairo_user_data_key_t</a> *key);</pre>
|
|
899
|
-
<p>
|
|
900
|
-
Return user data previously attached to <em class="parameter"><code>surface</code></em> using the specified
|
|
901
|
-
key. If no user data has been attached with the given key this
|
|
902
|
-
function returns <code class="literal">NULL</code>.</p>
|
|
903
|
-
<p>
|
|
904
|
-
|
|
905
|
-
</p>
|
|
906
|
-
<div class="variablelist"><table border="0">
|
|
907
|
-
<col align="left" valign="top">
|
|
908
|
-
<tbody>
|
|
909
|
-
<tr>
|
|
910
|
-
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
|
|
911
|
-
<td> a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>
|
|
912
|
-
</td>
|
|
913
|
-
</tr>
|
|
914
|
-
<tr>
|
|
915
|
-
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
|
|
916
|
-
<td> the address of the <a class="link" href="cairo-Types.html#cairo-user-data-key-t"><span class="type">cairo_user_data_key_t</span></a> the user data was
|
|
917
|
-
attached to
|
|
918
|
-
</td>
|
|
919
|
-
</tr>
|
|
920
|
-
<tr>
|
|
921
|
-
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
922
|
-
<td> the user data previously attached or <code class="literal">NULL</code>.
|
|
923
|
-
</td>
|
|
924
|
-
</tr>
|
|
925
|
-
</tbody>
|
|
926
|
-
</table></div>
|
|
927
|
-
</div>
|
|
928
|
-
<hr>
|
|
929
|
-
<div class="refsect2" lang="en">
|
|
930
|
-
<a name="id2664162"></a><h3>
|
|
931
|
-
<a name="cairo-surface-copy-page"></a>cairo_surface_copy_page ()</h3>
|
|
932
|
-
<a class="indexterm" name="id2664174"></a><pre class="programlisting">void cairo_surface_copy_page (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);</pre>
|
|
933
|
-
<p>
|
|
934
|
-
Emits the current page for backends that support multiple pages,
|
|
935
|
-
but doesn't clear it, so that the contents of the current page will
|
|
936
|
-
be retained for the next page. Use <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-show-page"><code class="function">cairo_surface_show_page()</code></a> if you
|
|
937
|
-
want to get an empty page after the emission.</p>
|
|
938
|
-
<p>
|
|
939
|
-
|
|
940
|
-
</p>
|
|
941
|
-
<div class="variablelist"><table border="0">
|
|
942
|
-
<col align="left" valign="top">
|
|
943
|
-
<tbody><tr>
|
|
944
|
-
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
|
|
945
|
-
<td> a <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a>
|
|
946
|
-
</td>
|
|
947
|
-
</tr></tbody>
|
|
948
|
-
</table></div>
|
|
949
|
-
<p class="since">Since 1.6
|
|
950
|
-
</p>
|
|
951
|
-
</div>
|
|
952
|
-
<hr>
|
|
953
|
-
<div class="refsect2" lang="en">
|
|
954
|
-
<a name="id2664243"></a><h3>
|
|
955
|
-
<a name="cairo-surface-show-page"></a>cairo_surface_show_page ()</h3>
|
|
956
|
-
<a class="indexterm" name="id2664255"></a><pre class="programlisting">void cairo_surface_show_page (<a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t">cairo_surface_t</a> *surface);</pre>
|
|
957
|
-
<p>
|
|
958
|
-
Emits and clears the current page for backends that support multiple
|
|
959
|
-
pages. Use <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-copy-page"><code class="function">cairo_surface_copy_page()</code></a> if you don't want to clear the page.</p>
|
|
960
|
-
<p>
|
|
961
|
-
|
|
962
|
-
</p>
|
|
963
|
-
<div class="variablelist"><table border="0">
|
|
964
|
-
<col align="left" valign="top">
|
|
965
|
-
<tbody><tr>
|
|
966
|
-
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
|
|
967
|
-
<td> a <span class="type">cairo_Surface_t</span>
|
|
968
|
-
</td>
|
|
969
|
-
</tr></tbody>
|
|
970
|
-
</table></div>
|
|
971
|
-
<p class="since">Since 1.6
|
|
972
|
-
</p>
|
|
973
|
-
</div>
|
|
974
|
-
</div>
|
|
975
|
-
<div class="refsect1" lang="en">
|
|
976
|
-
<a name="id2664323"></a><h2>See Also</h2>
|
|
977
|
-
<p>
|
|
978
|
-
</p>
|
|
979
|
-
<div class="itemizedlist"><ul type="disc">
|
|
980
|
-
<li>#<a class="link" href="cairo-cairo-t.html#cairo-t"><code class="function">cairo_t()</code></a>
|
|
981
|
-
</li>
|
|
982
|
-
<li>#<a class="link" href="cairo-Patterns.html#cairo-pattern-t"><code class="function">cairo_pattern_t()</code></a>
|
|
983
|
-
</li>
|
|
984
|
-
</ul></div>
|
|
985
|
-
<p>
|
|
986
|
-
</p>
|
|
987
|
-
</div>
|
|
988
|
-
<div class="refsect1" lang="en">
|
|
989
|
-
<a name="id2664357"></a><div class="refsect2" lang="en"><a name="id2664358"></a></div>
|
|
990
|
-
<hr>
|
|
991
|
-
<div class="refsect2" lang="en"><a name="id2664359"></a></div>
|
|
992
|
-
</div>
|
|
993
|
-
</div>
|
|
994
|
-
</body>
|
|
995
|
-
</html>
|