<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Types</title> <meta name="generator" content="DocBook XSL Stylesheets V1.73.2"> <link rel="start" href="index.html" title="Cairo: A Vector Graphics Library"> <link rel="up" href="cairo-support.html" title="Utilities"> <link rel="prev" href="cairo-version-info.html" title="Version Information"> <link rel="next" href="index-all.html" title="Index"> <meta name="generator" content="GTK-Doc V1.11 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> <link rel="chapter" href="cairo-drawing.html" title="Drawing"> <link rel="chapter" href="cairo-fonts.html" title="Fonts"> <link rel="chapter" href="cairo-surfaces.html" title="Surfaces"> <link rel="chapter" href="cairo-support.html" title="Utilities"> <link rel="index" href="index-all.html" title="Index"> <link rel="index" href="index-1.2.html" title="Index of new symbols in 1.2"> <link rel="index" href="index-1.4.html" title="Index of new symbols in 1.4"> <link rel="index" href="index-1.6.html" title="Index of new symbols in 1.6"> <link rel="index" href="index-1.8.html" title="Index of new symbols in 1.8"> <link rel="appendix" href="language-bindings.html" title="Appendix A. 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-info.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> <td><a accesskey="u" href="cairo-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="index-all.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr> <tr><td colspan="5" class="shortcuts"> <a href="#cairo-types.synopsis" class="shortcut">Top</a> | <a href="#cairo-types.description" class="shortcut">Description</a> </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><span class="refentrytitle"><a name="cairo-types.top_of_page"></a>Types</span></h2> <p>Types — Generic data types</p> </td> <td valign="top" align="right"></td> </tr></table></div> <div class="refsynopsisdiv"> <a name="cairo-types.synopsis"></a><h2>Synopsis</h2> <pre class="synopsis"> typedef <a class="link" href="cairo-types.html#cairo-bool-t" title="cairo_bool_t">cairo_bool_t</a>; <a class="link" href="cairo-types.html#cairo-user-data-key-t" title="cairo_user_data_key_t">cairo_user_data_key_t</a>; void (<a class="link" href="cairo-types.html#cairo-destroy-func-t" title="cairo_destroy_func_t ()">*cairo_destroy_func_t</a>) (void *data); </pre> </div> <div class="refsect1" lang="en"> <a name="cairo-types.description"></a><h2>Description</h2> <p> Generic data types used in the cairo API </p> </div> <div class="refsect1" lang="en"> <a name="cairo-types.details"></a><h2>Details</h2> <div class="refsect2" lang="en"> <a name="cairo-bool-t"></a><h3>cairo_bool_t</h3> <pre class="programlisting">typedef int cairo_bool_t; </pre> <p> <a class="link" href="cairo-types.html#cairo-bool-t" title="cairo_bool_t"><span class="type">cairo_bool_t</span></a> is used for boolean values. Returns of type <a class="link" href="cairo-types.html#cairo-bool-t" title="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="cairo-user-data-key-t"></a><h3>cairo_user_data_key_t</h3> <pre class="programlisting">typedef struct { int unused; } cairo_user_data_key_t; </pre> <p> <a class="link" href="cairo-types.html#cairo-user-data-key-t" title="cairo_user_data_key_t"><span class="type">cairo_user_data_key_t</span></a> 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><p><span class="term">int <em class="structfield"><code>unused</code></em>;</span></p></td> <td> not used; ignore. </td> </tr></tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="cairo-destroy-func-t"></a><h3>cairo_destroy_func_t ()</h3> <pre class="programlisting">void (*cairo_destroy_func_t) (void *data);</pre> <p> <a class="link" href="cairo-types.html#cairo-destroy-func-t" title="cairo_destroy_func_t ()"><span class="type">cairo_destroy_func_t</span></a> 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><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> <td> The data element being destroyed. </td> </tr></tbody> </table></div> </div> </div> </div> <div class="footer"> <hr> Generated by GTK-Doc V1.11</div> </body> </html>