diff options
Diffstat (limited to 'doc/public/html/cairo-Types.html')
-rw-r--r-- | doc/public/html/cairo-Types.html | 206 |
1 files changed, 206 insertions, 0 deletions
diff --git a/doc/public/html/cairo-Types.html b/doc/public/html/cairo-Types.html new file mode 100644 index 000000000..9ab8167a6 --- /dev/null +++ b/doc/public/html/cairo-Types.html @@ -0,0 +1,206 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Cairo: A Vector Graphics Library: Types</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="Cairo: A Vector Graphics Library"> +<link rel="up" href="cairo-support.html" title="Utilities"> +<link rel="prev" href="cairo-Version-Information.html" title="Version Information"> +<link rel="next" href="index-all.html" title="Index"> +<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</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="10"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#cairo-Types.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#cairo-Types.object-hierarchy" class="shortcut">Object Hierarchy</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="cairo-support.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="cairo-Version-Information.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="index-all.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<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 class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="cairo-Types.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody><tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<span class="c_punctuation">(</span><a class="link" href="cairo-Types.html#cairo-destroy-func-t" title="cairo_destroy_func_t ()">*cairo_destroy_func_t</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> +</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="cairo-Types.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="typedef_keyword">typedef</td> +<td class="function_name"><a class="link" href="cairo-Types.html#cairo-bool-t" title="cairo_bool_t">cairo_bool_t</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="cairo-Types.html#cairo-user-data-key-t" title="cairo_user_data_key_t">cairo_user_data_key_t</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t">cairo_rectangle_int_t</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="cairo-Types.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> +</pre> +</div> +<div class="refsect1"> +<a name="cairo-Types.description"></a><h2>Description</h2> +<p>This section lists generic data types used in the cairo API.</p> +</div> +<div class="refsect1"> +<a name="cairo-Types.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="cairo-destroy-func-t"></a><h3>cairo_destroy_func_t ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +<span class="c_punctuation">(</span>*cairo_destroy_func_t<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">void</span> *data</code></em>);</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> +<div class="refsect3"> +<a name="id-1.6.5.7.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>The data element being destroyed.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<p class="since">Since 1.0</p> +</div> +</div> +<div class="refsect1"> +<a name="cairo-Types.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<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> +<div class="informalexample"><pre class="programlisting"> + if (cairo_in_stroke (cr, x, y)) { + /* do something */ + } +</pre></div> +<p class="since">Since 1.0</p> +</div> +<hr> +<div class="refsect2"> +<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> +<div class="refsect3"> +<a name="id-1.6.5.8.3.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody><tr> +<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="cairo-user-data-key-t.unused"></a>unused</code></em>;</p></td> +<td class="struct_member_description"><p>not used; ignore.</p></td> +<td class="struct_member_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<p class="since">Since 1.0</p> +</div> +<hr> +<div class="refsect2"> +<a name="cairo-rectangle-int-t"></a><h3>cairo_rectangle_int_t</h3> +<pre class="programlisting">typedef struct { + int x, y; + int width, height; +} cairo_rectangle_int_t; +</pre> +<p>A data structure for holding a rectangle with integer coordinates.</p> +<div class="refsect3"> +<a name="id-1.6.5.8.4.5"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="cairo-rectangle-int-t.x"></a>x</code></em>;</p></td> +<td class="struct_member_description"><p>X coordinate of the left side of the rectangle</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="cairo-rectangle-int-t.y"></a>y</code></em>;</p></td> +<td class="struct_member_description"><p>Y coordinate of the the top side of the rectangle</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="cairo-rectangle-int-t.width"></a>width</code></em>;</p></td> +<td class="struct_member_description"><p>width of the rectangle</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="cairo-rectangle-int-t.height"></a>height</code></em>;</p></td> +<td class="struct_member_description"><p>height of the rectangle</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since 1.10</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.20</div> +</body> +</html>
\ No newline at end of file |