File: cairo-Types.html

package info (click to toggle)
libcairo 1.2.4-4
  • links: PTS
  • area: main
  • in suites: etch-m68k
  • size: 10,404 kB
  • ctags: 6,985
  • sloc: ansic: 59,757; xml: 9,125; sh: 8,864; makefile: 1,035; cpp: 864; perl: 155
file content (140 lines) | stat: -rw-r--r-- 5,651 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Types</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="Cairo: A Vector Graphics Library">
<link rel="up" href="Support.html" title="Utilities">
<link rel="prev" href="cairo-Version-Information.html" title="Version Information">
<link rel="next" href="ix01.html" title="Index">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="pt01.html" title="Part&#160;I.&#160;Tutorial">
<link rel="part" href="pt02.html" title="Part&#160;II.&#160;Reference">
<link rel="chapter" href="Drawing.html" title="Drawing">
<link rel="chapter" href="Fonts.html" title="Fonts">
<link rel="chapter" href="Surfaces.html" title="Surfaces">
<link rel="chapter" href="Support.html" title="Utilities">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of new symbols in 1.2">
<link rel="appendix" href="language-bindings.html" title="Appendix&#160;A.&#160;Creating a language binding for cairo">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="cairo-Version-Information.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Support.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Cairo: A Vector Graphics Library</th>
<td><a accesskey="n" href="ix01.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2539930" class="shortcut">Top</a>
                  &#160;|&#160;
                  <a href="#id2563336" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="cairo-Types"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2539930"></a><span class="refentrytitle">Types</span>
</h2>
<p>Types &#8212; Generic data types used in the cairo API</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">



typedef     <a href="cairo-Types.html#cairo-bool-t">cairo_bool_t</a>;
            <a href="cairo-Types.html#cairo-user-data-key-t">cairo_user_data_key_t</a>;
void        (<a href="cairo-Types.html#cairo-destroy-func-t">*cairo_destroy_func_t</a>)         (void *data);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2563336"></a><h2>Description</h2>
<p>

</p>
</div>
<div class="refsect1" lang="en">
<a name="id2606884"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2606894"></a><h3>
<a name="cairo-bool-t"></a>cairo_bool_t</h3>
<a class="indexterm" name="id2606905"></a><pre class="programlisting">typedef int cairo_bool_t;
</pre>
<p>
<a href="cairo-Types.html#cairo-bool-t"><span class="type">cairo_bool_t</span></a> is used for boolean values. Returns of type
<a href="cairo-Types.html#cairo-bool-t"><span class="type">cairo_bool_t</span></a> will always be either 0 or 1, but testing against
these values explicitly is not encouraged; just use the
value as a boolean condition.
</p>
<p>
</p>
<div class="informalexample"><pre class="programlisting">
 if (cairo_in_stroke (cr, x, y)) {
     /* do something */
 }
</pre></div>
<p>

</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606954"></a><h3>
<a name="cairo-user-data-key-t"></a>cairo_user_data_key_t</h3>
<a class="indexterm" name="id2606965"></a><pre class="programlisting">typedef struct {
    int unused;
} cairo_user_data_key_t;
</pre>
<p>
<a href="cairo-Types.html#cairo-user-data-key-t"><span class="type">cairo_user_data_key_t</span></a> is used for attaching user data to cairo
data structures.  The actual contents of the struct is never used,
and there is no need to initialize the object; only the unique
address of a <span class="type">cairo_data_key_t</span> object is used.  Typically, you
would just use the address of a static <span class="type">cairo_data_key_t</span> object.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term">int&#160;<em class="structfield"><code>unused</code></em>;</span></td>
<td> not used; ignore.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610973"></a><h3>
<a name="cairo-destroy-func-t"></a>cairo_destroy_func_t ()</h3>
<a class="indexterm" name="id2610984"></a><pre class="programlisting">void        (*cairo_destroy_func_t)         (void *data);</pre>
<p>
<a href="cairo-Types.html#cairo-destroy-func-t"><span class="type">cairo_destroy_func_t</span></a> the type of function which is called when a
data element is destroyed. It is passed the pointer to the data
element and should free any memory and resources allocated for it.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>data</code></em>&#160;:</span></td>
<td> The data element being destroyed.
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>