Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/gtk-doc/html/cairo/cairo-Regions.html @ 68:5028fdace37b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 16:23:26 -0400
parents
children
rev   line source
jpayne@68 1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
jpayne@68 2 <html>
jpayne@68 3 <head>
jpayne@68 4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
jpayne@68 5 <title>Regions: Cairo: A Vector Graphics Library</title>
jpayne@68 6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
jpayne@68 7 <link rel="home" href="index.html" title="Cairo: A Vector Graphics Library">
jpayne@68 8 <link rel="up" href="cairo-drawing.html" title="Drawing">
jpayne@68 9 <link rel="prev" href="cairo-cairo-pattern-t.html" title="cairo_pattern_t">
jpayne@68 10 <link rel="next" href="cairo-Transformations.html" title="Transformations">
jpayne@68 11 <meta name="generator" content="GTK-Doc V1.27 (XML mode)">
jpayne@68 12 <link rel="stylesheet" href="style.css" type="text/css">
jpayne@68 13 </head>
jpayne@68 14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
jpayne@68 15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
jpayne@68 16 <td width="100%" align="left" class="shortcuts">
jpayne@68 17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
jpayne@68 18 <a href="#cairo-Regions.description" class="shortcut">Description</a></span>
jpayne@68 19 </td>
jpayne@68 20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
jpayne@68 21 <td><a accesskey="u" href="cairo-drawing.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
jpayne@68 22 <td><a accesskey="p" href="cairo-cairo-pattern-t.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
jpayne@68 23 <td><a accesskey="n" href="cairo-Transformations.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
jpayne@68 24 </tr></table>
jpayne@68 25 <div class="refentry">
jpayne@68 26 <a name="cairo-Regions"></a><div class="titlepage"></div>
jpayne@68 27 <div class="refnamediv"><table width="100%"><tr>
jpayne@68 28 <td valign="top">
jpayne@68 29 <h2><span class="refentrytitle"><a name="cairo-Regions.top_of_page"></a>Regions</span></h2>
jpayne@68 30 <p>Regions — Representing a pixel-aligned area</p>
jpayne@68 31 </td>
jpayne@68 32 <td class="gallery_image" valign="top" align="right"></td>
jpayne@68 33 </tr></table></div>
jpayne@68 34 <div class="refsect1">
jpayne@68 35 <a name="cairo-Regions.functions"></a><h2>Functions</h2>
jpayne@68 36 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 37 <colgroup>
jpayne@68 38 <col width="150px" class="functions_return">
jpayne@68 39 <col class="functions_name">
jpayne@68 40 </colgroup>
jpayne@68 41 <tbody>
jpayne@68 42 <tr>
jpayne@68 43 <td class="function_type">
jpayne@68 44 <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="returnvalue">cairo_region_t</span></a> *
jpayne@68 45 </td>
jpayne@68 46 <td class="function_name">
jpayne@68 47 <a class="link" href="cairo-Regions.html#cairo-region-create" title="cairo_region_create ()">cairo_region_create</a> <span class="c_punctuation">()</span>
jpayne@68 48 </td>
jpayne@68 49 </tr>
jpayne@68 50 <tr>
jpayne@68 51 <td class="function_type">
jpayne@68 52 <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="returnvalue">cairo_region_t</span></a> *
jpayne@68 53 </td>
jpayne@68 54 <td class="function_name">
jpayne@68 55 <a class="link" href="cairo-Regions.html#cairo-region-create-rectangle" title="cairo_region_create_rectangle ()">cairo_region_create_rectangle</a> <span class="c_punctuation">()</span>
jpayne@68 56 </td>
jpayne@68 57 </tr>
jpayne@68 58 <tr>
jpayne@68 59 <td class="function_type">
jpayne@68 60 <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="returnvalue">cairo_region_t</span></a> *
jpayne@68 61 </td>
jpayne@68 62 <td class="function_name">
jpayne@68 63 <a class="link" href="cairo-Regions.html#cairo-region-create-rectangles" title="cairo_region_create_rectangles ()">cairo_region_create_rectangles</a> <span class="c_punctuation">()</span>
jpayne@68 64 </td>
jpayne@68 65 </tr>
jpayne@68 66 <tr>
jpayne@68 67 <td class="function_type">
jpayne@68 68 <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="returnvalue">cairo_region_t</span></a> *
jpayne@68 69 </td>
jpayne@68 70 <td class="function_name">
jpayne@68 71 <a class="link" href="cairo-Regions.html#cairo-region-copy" title="cairo_region_copy ()">cairo_region_copy</a> <span class="c_punctuation">()</span>
jpayne@68 72 </td>
jpayne@68 73 </tr>
jpayne@68 74 <tr>
jpayne@68 75 <td class="function_type">
jpayne@68 76 <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="returnvalue">cairo_region_t</span></a> *
jpayne@68 77 </td>
jpayne@68 78 <td class="function_name">
jpayne@68 79 <a class="link" href="cairo-Regions.html#cairo-region-reference" title="cairo_region_reference ()">cairo_region_reference</a> <span class="c_punctuation">()</span>
jpayne@68 80 </td>
jpayne@68 81 </tr>
jpayne@68 82 <tr>
jpayne@68 83 <td class="function_type">
jpayne@68 84 <span class="returnvalue">void</span>
jpayne@68 85 </td>
jpayne@68 86 <td class="function_name">
jpayne@68 87 <a class="link" href="cairo-Regions.html#cairo-region-destroy" title="cairo_region_destroy ()">cairo_region_destroy</a> <span class="c_punctuation">()</span>
jpayne@68 88 </td>
jpayne@68 89 </tr>
jpayne@68 90 <tr>
jpayne@68 91 <td class="function_type">
jpayne@68 92 <a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 93 </td>
jpayne@68 94 <td class="function_name">
jpayne@68 95 <a class="link" href="cairo-Regions.html#cairo-region-status" title="cairo_region_status ()">cairo_region_status</a> <span class="c_punctuation">()</span>
jpayne@68 96 </td>
jpayne@68 97 </tr>
jpayne@68 98 <tr>
jpayne@68 99 <td class="function_type">
jpayne@68 100 <span class="returnvalue">void</span>
jpayne@68 101 </td>
jpayne@68 102 <td class="function_name">
jpayne@68 103 <a class="link" href="cairo-Regions.html#cairo-region-get-extents" title="cairo_region_get_extents ()">cairo_region_get_extents</a> <span class="c_punctuation">()</span>
jpayne@68 104 </td>
jpayne@68 105 </tr>
jpayne@68 106 <tr>
jpayne@68 107 <td class="function_type">
jpayne@68 108 <span class="returnvalue">int</span>
jpayne@68 109 </td>
jpayne@68 110 <td class="function_name">
jpayne@68 111 <a class="link" href="cairo-Regions.html#cairo-region-num-rectangles" title="cairo_region_num_rectangles ()">cairo_region_num_rectangles</a> <span class="c_punctuation">()</span>
jpayne@68 112 </td>
jpayne@68 113 </tr>
jpayne@68 114 <tr>
jpayne@68 115 <td class="function_type">
jpayne@68 116 <span class="returnvalue">void</span>
jpayne@68 117 </td>
jpayne@68 118 <td class="function_name">
jpayne@68 119 <a class="link" href="cairo-Regions.html#cairo-region-get-rectangle" title="cairo_region_get_rectangle ()">cairo_region_get_rectangle</a> <span class="c_punctuation">()</span>
jpayne@68 120 </td>
jpayne@68 121 </tr>
jpayne@68 122 <tr>
jpayne@68 123 <td class="function_type">
jpayne@68 124 <a class="link" href="cairo-Types.html#cairo-bool-t" title="cairo_bool_t"><span class="returnvalue">cairo_bool_t</span></a>
jpayne@68 125 </td>
jpayne@68 126 <td class="function_name">
jpayne@68 127 <a class="link" href="cairo-Regions.html#cairo-region-is-empty" title="cairo_region_is_empty ()">cairo_region_is_empty</a> <span class="c_punctuation">()</span>
jpayne@68 128 </td>
jpayne@68 129 </tr>
jpayne@68 130 <tr>
jpayne@68 131 <td class="function_type">
jpayne@68 132 <a class="link" href="cairo-Types.html#cairo-bool-t" title="cairo_bool_t"><span class="returnvalue">cairo_bool_t</span></a>
jpayne@68 133 </td>
jpayne@68 134 <td class="function_name">
jpayne@68 135 <a class="link" href="cairo-Regions.html#cairo-region-contains-point" title="cairo_region_contains_point ()">cairo_region_contains_point</a> <span class="c_punctuation">()</span>
jpayne@68 136 </td>
jpayne@68 137 </tr>
jpayne@68 138 <tr>
jpayne@68 139 <td class="function_type">
jpayne@68 140 <a class="link" href="cairo-Regions.html#cairo-region-overlap-t" title="enum cairo_region_overlap_t"><span class="returnvalue">cairo_region_overlap_t</span></a>
jpayne@68 141 </td>
jpayne@68 142 <td class="function_name">
jpayne@68 143 <a class="link" href="cairo-Regions.html#cairo-region-contains-rectangle" title="cairo_region_contains_rectangle ()">cairo_region_contains_rectangle</a> <span class="c_punctuation">()</span>
jpayne@68 144 </td>
jpayne@68 145 </tr>
jpayne@68 146 <tr>
jpayne@68 147 <td class="function_type">
jpayne@68 148 <a class="link" href="cairo-Types.html#cairo-bool-t" title="cairo_bool_t"><span class="returnvalue">cairo_bool_t</span></a>
jpayne@68 149 </td>
jpayne@68 150 <td class="function_name">
jpayne@68 151 <a class="link" href="cairo-Regions.html#cairo-region-equal" title="cairo_region_equal ()">cairo_region_equal</a> <span class="c_punctuation">()</span>
jpayne@68 152 </td>
jpayne@68 153 </tr>
jpayne@68 154 <tr>
jpayne@68 155 <td class="function_type">
jpayne@68 156 <span class="returnvalue">void</span>
jpayne@68 157 </td>
jpayne@68 158 <td class="function_name">
jpayne@68 159 <a class="link" href="cairo-Regions.html#cairo-region-translate" title="cairo_region_translate ()">cairo_region_translate</a> <span class="c_punctuation">()</span>
jpayne@68 160 </td>
jpayne@68 161 </tr>
jpayne@68 162 <tr>
jpayne@68 163 <td class="function_type">
jpayne@68 164 <a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 165 </td>
jpayne@68 166 <td class="function_name">
jpayne@68 167 <a class="link" href="cairo-Regions.html#cairo-region-intersect" title="cairo_region_intersect ()">cairo_region_intersect</a> <span class="c_punctuation">()</span>
jpayne@68 168 </td>
jpayne@68 169 </tr>
jpayne@68 170 <tr>
jpayne@68 171 <td class="function_type">
jpayne@68 172 <a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 173 </td>
jpayne@68 174 <td class="function_name">
jpayne@68 175 <a class="link" href="cairo-Regions.html#cairo-region-intersect-rectangle" title="cairo_region_intersect_rectangle ()">cairo_region_intersect_rectangle</a> <span class="c_punctuation">()</span>
jpayne@68 176 </td>
jpayne@68 177 </tr>
jpayne@68 178 <tr>
jpayne@68 179 <td class="function_type">
jpayne@68 180 <a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 181 </td>
jpayne@68 182 <td class="function_name">
jpayne@68 183 <a class="link" href="cairo-Regions.html#cairo-region-subtract" title="cairo_region_subtract ()">cairo_region_subtract</a> <span class="c_punctuation">()</span>
jpayne@68 184 </td>
jpayne@68 185 </tr>
jpayne@68 186 <tr>
jpayne@68 187 <td class="function_type">
jpayne@68 188 <a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 189 </td>
jpayne@68 190 <td class="function_name">
jpayne@68 191 <a class="link" href="cairo-Regions.html#cairo-region-subtract-rectangle" title="cairo_region_subtract_rectangle ()">cairo_region_subtract_rectangle</a> <span class="c_punctuation">()</span>
jpayne@68 192 </td>
jpayne@68 193 </tr>
jpayne@68 194 <tr>
jpayne@68 195 <td class="function_type">
jpayne@68 196 <a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 197 </td>
jpayne@68 198 <td class="function_name">
jpayne@68 199 <a class="link" href="cairo-Regions.html#cairo-region-union" title="cairo_region_union ()">cairo_region_union</a> <span class="c_punctuation">()</span>
jpayne@68 200 </td>
jpayne@68 201 </tr>
jpayne@68 202 <tr>
jpayne@68 203 <td class="function_type">
jpayne@68 204 <a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 205 </td>
jpayne@68 206 <td class="function_name">
jpayne@68 207 <a class="link" href="cairo-Regions.html#cairo-region-union-rectangle" title="cairo_region_union_rectangle ()">cairo_region_union_rectangle</a> <span class="c_punctuation">()</span>
jpayne@68 208 </td>
jpayne@68 209 </tr>
jpayne@68 210 <tr>
jpayne@68 211 <td class="function_type">
jpayne@68 212 <a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 213 </td>
jpayne@68 214 <td class="function_name">
jpayne@68 215 <a class="link" href="cairo-Regions.html#cairo-region-xor" title="cairo_region_xor ()">cairo_region_xor</a> <span class="c_punctuation">()</span>
jpayne@68 216 </td>
jpayne@68 217 </tr>
jpayne@68 218 <tr>
jpayne@68 219 <td class="function_type">
jpayne@68 220 <a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 221 </td>
jpayne@68 222 <td class="function_name">
jpayne@68 223 <a class="link" href="cairo-Regions.html#cairo-region-xor-rectangle" title="cairo_region_xor_rectangle ()">cairo_region_xor_rectangle</a> <span class="c_punctuation">()</span>
jpayne@68 224 </td>
jpayne@68 225 </tr>
jpayne@68 226 </tbody>
jpayne@68 227 </table></div>
jpayne@68 228 </div>
jpayne@68 229 <div class="refsect1">
jpayne@68 230 <a name="cairo-Regions.other"></a><h2>Types and Values</h2>
jpayne@68 231 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 232 <colgroup>
jpayne@68 233 <col width="150px" class="name">
jpayne@68 234 <col class="description">
jpayne@68 235 </colgroup>
jpayne@68 236 <tbody>
jpayne@68 237 <tr>
jpayne@68 238 <td class="typedef_keyword">typedef</td>
jpayne@68 239 <td class="function_name"><a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t">cairo_region_t</a></td>
jpayne@68 240 </tr>
jpayne@68 241 <tr>
jpayne@68 242 <td class="datatype_keyword">enum</td>
jpayne@68 243 <td class="function_name"><a class="link" href="cairo-Regions.html#cairo-region-overlap-t" title="enum cairo_region_overlap_t">cairo_region_overlap_t</a></td>
jpayne@68 244 </tr>
jpayne@68 245 </tbody>
jpayne@68 246 </table></div>
jpayne@68 247 </div>
jpayne@68 248 <div class="refsect1">
jpayne@68 249 <a name="cairo-Regions.description"></a><h2>Description</h2>
jpayne@68 250 <p>Regions are a simple graphical data type representing an area of
jpayne@68 251 integer-aligned rectangles. They are often used on raster surfaces
jpayne@68 252 to track areas of interest, such as change or clip areas.</p>
jpayne@68 253 </div>
jpayne@68 254 <div class="refsect1">
jpayne@68 255 <a name="cairo-Regions.functions_details"></a><h2>Functions</h2>
jpayne@68 256 <div class="refsect2">
jpayne@68 257 <a name="cairo-region-create"></a><h3>cairo_region_create ()</h3>
jpayne@68 258 <pre class="programlisting"><a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="returnvalue">cairo_region_t</span></a> *
jpayne@68 259 cairo_region_create (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
jpayne@68 260 <p>Allocates a new empty region object.</p>
jpayne@68 261 <div class="refsect3">
jpayne@68 262 <a name="cairo-region-create.returns"></a><h4>Returns</h4>
jpayne@68 263 <p> A newly allocated <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a>. Free with
jpayne@68 264 <a class="link" href="cairo-Regions.html#cairo-region-destroy" title="cairo_region_destroy ()"><code class="function">cairo_region_destroy()</code></a>. This function always returns a
jpayne@68 265 valid pointer; if memory cannot be allocated, then a special
jpayne@68 266 error object is returned where all operations on the object do nothing.
jpayne@68 267 You can check for this with <a class="link" href="cairo-Regions.html#cairo-region-status" title="cairo_region_status ()"><code class="function">cairo_region_status()</code></a>.</p>
jpayne@68 268 </div>
jpayne@68 269 <p class="since">Since: 1.10</p>
jpayne@68 270 </div>
jpayne@68 271 <hr>
jpayne@68 272 <div class="refsect2">
jpayne@68 273 <a name="cairo-region-create-rectangle"></a><h3>cairo_region_create_rectangle ()</h3>
jpayne@68 274 <pre class="programlisting"><a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="returnvalue">cairo_region_t</span></a> *
jpayne@68 275 cairo_region_create_rectangle (<em class="parameter"><code>const <a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t"><span class="type">cairo_rectangle_int_t</span></a> *rectangle</code></em>);</pre>
jpayne@68 276 <p>Allocates a new region object containing <em class="parameter"><code>rectangle</code></em>
jpayne@68 277 .</p>
jpayne@68 278 <div class="refsect3">
jpayne@68 279 <a name="cairo-region-create-rectangle.parameters"></a><h4>Parameters</h4>
jpayne@68 280 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 281 <colgroup>
jpayne@68 282 <col width="150px" class="parameters_name">
jpayne@68 283 <col class="parameters_description">
jpayne@68 284 <col width="200px" class="parameters_annotations">
jpayne@68 285 </colgroup>
jpayne@68 286 <tbody><tr>
jpayne@68 287 <td class="parameter_name"><p>rectangle</p></td>
jpayne@68 288 <td class="parameter_description"><p>a <a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t"><span class="type">cairo_rectangle_int_t</span></a></p></td>
jpayne@68 289 <td class="parameter_annotations"> </td>
jpayne@68 290 </tr></tbody>
jpayne@68 291 </table></div>
jpayne@68 292 </div>
jpayne@68 293 <div class="refsect3">
jpayne@68 294 <a name="cairo-region-create-rectangle.returns"></a><h4>Returns</h4>
jpayne@68 295 <p> A newly allocated <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a>. Free with
jpayne@68 296 <a class="link" href="cairo-Regions.html#cairo-region-destroy" title="cairo_region_destroy ()"><code class="function">cairo_region_destroy()</code></a>. This function always returns a
jpayne@68 297 valid pointer; if memory cannot be allocated, then a special
jpayne@68 298 error object is returned where all operations on the object do nothing.
jpayne@68 299 You can check for this with <a class="link" href="cairo-Regions.html#cairo-region-status" title="cairo_region_status ()"><code class="function">cairo_region_status()</code></a>.</p>
jpayne@68 300 </div>
jpayne@68 301 <p class="since">Since: 1.10</p>
jpayne@68 302 </div>
jpayne@68 303 <hr>
jpayne@68 304 <div class="refsect2">
jpayne@68 305 <a name="cairo-region-create-rectangles"></a><h3>cairo_region_create_rectangles ()</h3>
jpayne@68 306 <pre class="programlisting"><a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="returnvalue">cairo_region_t</span></a> *
jpayne@68 307 cairo_region_create_rectangles (<em class="parameter"><code>const <a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t"><span class="type">cairo_rectangle_int_t</span></a> *rects</code></em>,
jpayne@68 308 <em class="parameter"><code><span class="type">int</span> count</code></em>);</pre>
jpayne@68 309 <p>Allocates a new region object containing the union of all given <em class="parameter"><code>rects</code></em>
jpayne@68 310 .</p>
jpayne@68 311 <div class="refsect3">
jpayne@68 312 <a name="cairo-region-create-rectangles.parameters"></a><h4>Parameters</h4>
jpayne@68 313 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 314 <colgroup>
jpayne@68 315 <col width="150px" class="parameters_name">
jpayne@68 316 <col class="parameters_description">
jpayne@68 317 <col width="200px" class="parameters_annotations">
jpayne@68 318 </colgroup>
jpayne@68 319 <tbody>
jpayne@68 320 <tr>
jpayne@68 321 <td class="parameter_name"><p>rects</p></td>
jpayne@68 322 <td class="parameter_description"><p>an array of <em class="parameter"><code>count</code></em>
jpayne@68 323 rectangles</p></td>
jpayne@68 324 <td class="parameter_annotations"> </td>
jpayne@68 325 </tr>
jpayne@68 326 <tr>
jpayne@68 327 <td class="parameter_name"><p>count</p></td>
jpayne@68 328 <td class="parameter_description"><p>number of rectangles</p></td>
jpayne@68 329 <td class="parameter_annotations"> </td>
jpayne@68 330 </tr>
jpayne@68 331 </tbody>
jpayne@68 332 </table></div>
jpayne@68 333 </div>
jpayne@68 334 <div class="refsect3">
jpayne@68 335 <a name="cairo-region-create-rectangles.returns"></a><h4>Returns</h4>
jpayne@68 336 <p> A newly allocated <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a>. Free with
jpayne@68 337 <a class="link" href="cairo-Regions.html#cairo-region-destroy" title="cairo_region_destroy ()"><code class="function">cairo_region_destroy()</code></a>. This function always returns a
jpayne@68 338 valid pointer; if memory cannot be allocated, then a special
jpayne@68 339 error object is returned where all operations on the object do nothing.
jpayne@68 340 You can check for this with <a class="link" href="cairo-Regions.html#cairo-region-status" title="cairo_region_status ()"><code class="function">cairo_region_status()</code></a>.</p>
jpayne@68 341 </div>
jpayne@68 342 <p class="since">Since: 1.10</p>
jpayne@68 343 </div>
jpayne@68 344 <hr>
jpayne@68 345 <div class="refsect2">
jpayne@68 346 <a name="cairo-region-copy"></a><h3>cairo_region_copy ()</h3>
jpayne@68 347 <pre class="programlisting"><a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="returnvalue">cairo_region_t</span></a> *
jpayne@68 348 cairo_region_copy (<em class="parameter"><code>const <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *original</code></em>);</pre>
jpayne@68 349 <p>Allocates a new region object copying the area from <em class="parameter"><code>original</code></em>
jpayne@68 350 .</p>
jpayne@68 351 <div class="refsect3">
jpayne@68 352 <a name="cairo-region-copy.parameters"></a><h4>Parameters</h4>
jpayne@68 353 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 354 <colgroup>
jpayne@68 355 <col width="150px" class="parameters_name">
jpayne@68 356 <col class="parameters_description">
jpayne@68 357 <col width="200px" class="parameters_annotations">
jpayne@68 358 </colgroup>
jpayne@68 359 <tbody><tr>
jpayne@68 360 <td class="parameter_name"><p>original</p></td>
jpayne@68 361 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 362 <td class="parameter_annotations"> </td>
jpayne@68 363 </tr></tbody>
jpayne@68 364 </table></div>
jpayne@68 365 </div>
jpayne@68 366 <div class="refsect3">
jpayne@68 367 <a name="cairo-region-copy.returns"></a><h4>Returns</h4>
jpayne@68 368 <p> A newly allocated <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a>. Free with
jpayne@68 369 <a class="link" href="cairo-Regions.html#cairo-region-destroy" title="cairo_region_destroy ()"><code class="function">cairo_region_destroy()</code></a>. This function always returns a
jpayne@68 370 valid pointer; if memory cannot be allocated, then a special
jpayne@68 371 error object is returned where all operations on the object do nothing.
jpayne@68 372 You can check for this with <a class="link" href="cairo-Regions.html#cairo-region-status" title="cairo_region_status ()"><code class="function">cairo_region_status()</code></a>.</p>
jpayne@68 373 </div>
jpayne@68 374 <p class="since">Since: 1.10</p>
jpayne@68 375 </div>
jpayne@68 376 <hr>
jpayne@68 377 <div class="refsect2">
jpayne@68 378 <a name="cairo-region-reference"></a><h3>cairo_region_reference ()</h3>
jpayne@68 379 <pre class="programlisting"><a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="returnvalue">cairo_region_t</span></a> *
jpayne@68 380 cairo_region_reference (<em class="parameter"><code><a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *region</code></em>);</pre>
jpayne@68 381 <p>Increases the reference count on <em class="parameter"><code>region</code></em>
jpayne@68 382 by one. This prevents
jpayne@68 383 <em class="parameter"><code>region</code></em>
jpayne@68 384 from being destroyed until a matching call to
jpayne@68 385 <a class="link" href="cairo-Regions.html#cairo-region-destroy" title="cairo_region_destroy ()"><code class="function">cairo_region_destroy()</code></a> is made.</p>
jpayne@68 386 <div class="refsect3">
jpayne@68 387 <a name="cairo-region-reference.parameters"></a><h4>Parameters</h4>
jpayne@68 388 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 389 <colgroup>
jpayne@68 390 <col width="150px" class="parameters_name">
jpayne@68 391 <col class="parameters_description">
jpayne@68 392 <col width="200px" class="parameters_annotations">
jpayne@68 393 </colgroup>
jpayne@68 394 <tbody><tr>
jpayne@68 395 <td class="parameter_name"><p>region</p></td>
jpayne@68 396 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 397 <td class="parameter_annotations"> </td>
jpayne@68 398 </tr></tbody>
jpayne@68 399 </table></div>
jpayne@68 400 </div>
jpayne@68 401 <div class="refsect3">
jpayne@68 402 <a name="cairo-region-reference.returns"></a><h4>Returns</h4>
jpayne@68 403 <p> the referenced <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a>.</p>
jpayne@68 404 </div>
jpayne@68 405 <p class="since">Since: 1.10</p>
jpayne@68 406 </div>
jpayne@68 407 <hr>
jpayne@68 408 <div class="refsect2">
jpayne@68 409 <a name="cairo-region-destroy"></a><h3>cairo_region_destroy ()</h3>
jpayne@68 410 <pre class="programlisting"><span class="returnvalue">void</span>
jpayne@68 411 cairo_region_destroy (<em class="parameter"><code><a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *region</code></em>);</pre>
jpayne@68 412 <p>Destroys a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> object created with
jpayne@68 413 <a class="link" href="cairo-Regions.html#cairo-region-create" title="cairo_region_create ()"><code class="function">cairo_region_create()</code></a>, <a class="link" href="cairo-Regions.html#cairo-region-copy" title="cairo_region_copy ()"><code class="function">cairo_region_copy()</code></a>, or
jpayne@68 414 or <a class="link" href="cairo-Regions.html#cairo-region-create-rectangle" title="cairo_region_create_rectangle ()"><code class="function">cairo_region_create_rectangle()</code></a>.</p>
jpayne@68 415 <div class="refsect3">
jpayne@68 416 <a name="cairo-region-destroy.parameters"></a><h4>Parameters</h4>
jpayne@68 417 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 418 <colgroup>
jpayne@68 419 <col width="150px" class="parameters_name">
jpayne@68 420 <col class="parameters_description">
jpayne@68 421 <col width="200px" class="parameters_annotations">
jpayne@68 422 </colgroup>
jpayne@68 423 <tbody><tr>
jpayne@68 424 <td class="parameter_name"><p>region</p></td>
jpayne@68 425 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 426 <td class="parameter_annotations"> </td>
jpayne@68 427 </tr></tbody>
jpayne@68 428 </table></div>
jpayne@68 429 </div>
jpayne@68 430 <p class="since">Since: 1.10</p>
jpayne@68 431 </div>
jpayne@68 432 <hr>
jpayne@68 433 <div class="refsect2">
jpayne@68 434 <a name="cairo-region-status"></a><h3>cairo_region_status ()</h3>
jpayne@68 435 <pre class="programlisting"><a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 436 cairo_region_status (<em class="parameter"><code>const <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *region</code></em>);</pre>
jpayne@68 437 <p>Checks whether an error has previous occurred for this
jpayne@68 438 region object.</p>
jpayne@68 439 <div class="refsect3">
jpayne@68 440 <a name="cairo-region-status.parameters"></a><h4>Parameters</h4>
jpayne@68 441 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 442 <colgroup>
jpayne@68 443 <col width="150px" class="parameters_name">
jpayne@68 444 <col class="parameters_description">
jpayne@68 445 <col width="200px" class="parameters_annotations">
jpayne@68 446 </colgroup>
jpayne@68 447 <tbody><tr>
jpayne@68 448 <td class="parameter_name"><p>region</p></td>
jpayne@68 449 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 450 <td class="parameter_annotations"> </td>
jpayne@68 451 </tr></tbody>
jpayne@68 452 </table></div>
jpayne@68 453 </div>
jpayne@68 454 <div class="refsect3">
jpayne@68 455 <a name="cairo-region-status.returns"></a><h4>Returns</h4>
jpayne@68 456 <p> <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-SUCCESS:CAPS"><code class="literal">CAIRO_STATUS_SUCCESS</code></a> or <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-NO-MEMORY:CAPS"><code class="literal">CAIRO_STATUS_NO_MEMORY</code></a></p>
jpayne@68 457 </div>
jpayne@68 458 <p class="since">Since: 1.10</p>
jpayne@68 459 </div>
jpayne@68 460 <hr>
jpayne@68 461 <div class="refsect2">
jpayne@68 462 <a name="cairo-region-get-extents"></a><h3>cairo_region_get_extents ()</h3>
jpayne@68 463 <pre class="programlisting"><span class="returnvalue">void</span>
jpayne@68 464 cairo_region_get_extents (<em class="parameter"><code>const <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *region</code></em>,
jpayne@68 465 <em class="parameter"><code><a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t"><span class="type">cairo_rectangle_int_t</span></a> *extents</code></em>);</pre>
jpayne@68 466 <p>Gets the bounding rectangle of <em class="parameter"><code>region</code></em>
jpayne@68 467 as a <a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t"><span class="type">cairo_rectangle_int_t</span></a></p>
jpayne@68 468 <div class="refsect3">
jpayne@68 469 <a name="cairo-region-get-extents.parameters"></a><h4>Parameters</h4>
jpayne@68 470 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 471 <colgroup>
jpayne@68 472 <col width="150px" class="parameters_name">
jpayne@68 473 <col class="parameters_description">
jpayne@68 474 <col width="200px" class="parameters_annotations">
jpayne@68 475 </colgroup>
jpayne@68 476 <tbody>
jpayne@68 477 <tr>
jpayne@68 478 <td class="parameter_name"><p>region</p></td>
jpayne@68 479 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 480 <td class="parameter_annotations"> </td>
jpayne@68 481 </tr>
jpayne@68 482 <tr>
jpayne@68 483 <td class="parameter_name"><p>extents</p></td>
jpayne@68 484 <td class="parameter_description"><p>rectangle into which to store the extents</p></td>
jpayne@68 485 <td class="parameter_annotations"> </td>
jpayne@68 486 </tr>
jpayne@68 487 </tbody>
jpayne@68 488 </table></div>
jpayne@68 489 </div>
jpayne@68 490 <p class="since">Since: 1.10</p>
jpayne@68 491 </div>
jpayne@68 492 <hr>
jpayne@68 493 <div class="refsect2">
jpayne@68 494 <a name="cairo-region-num-rectangles"></a><h3>cairo_region_num_rectangles ()</h3>
jpayne@68 495 <pre class="programlisting"><span class="returnvalue">int</span>
jpayne@68 496 cairo_region_num_rectangles (<em class="parameter"><code>const <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *region</code></em>);</pre>
jpayne@68 497 <p>Returns the number of rectangles contained in <em class="parameter"><code>region</code></em>
jpayne@68 498 .</p>
jpayne@68 499 <div class="refsect3">
jpayne@68 500 <a name="cairo-region-num-rectangles.parameters"></a><h4>Parameters</h4>
jpayne@68 501 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 502 <colgroup>
jpayne@68 503 <col width="150px" class="parameters_name">
jpayne@68 504 <col class="parameters_description">
jpayne@68 505 <col width="200px" class="parameters_annotations">
jpayne@68 506 </colgroup>
jpayne@68 507 <tbody><tr>
jpayne@68 508 <td class="parameter_name"><p>region</p></td>
jpayne@68 509 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 510 <td class="parameter_annotations"> </td>
jpayne@68 511 </tr></tbody>
jpayne@68 512 </table></div>
jpayne@68 513 </div>
jpayne@68 514 <div class="refsect3">
jpayne@68 515 <a name="cairo-region-num-rectangles.returns"></a><h4>Returns</h4>
jpayne@68 516 <p> The number of rectangles contained in <em class="parameter"><code>region</code></em>
jpayne@68 517 .</p>
jpayne@68 518 </div>
jpayne@68 519 <p class="since">Since: 1.10</p>
jpayne@68 520 </div>
jpayne@68 521 <hr>
jpayne@68 522 <div class="refsect2">
jpayne@68 523 <a name="cairo-region-get-rectangle"></a><h3>cairo_region_get_rectangle ()</h3>
jpayne@68 524 <pre class="programlisting"><span class="returnvalue">void</span>
jpayne@68 525 cairo_region_get_rectangle (<em class="parameter"><code>const <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *region</code></em>,
jpayne@68 526 <em class="parameter"><code><span class="type">int</span> nth</code></em>,
jpayne@68 527 <em class="parameter"><code><a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t"><span class="type">cairo_rectangle_int_t</span></a> *rectangle</code></em>);</pre>
jpayne@68 528 <p>Stores the <em class="parameter"><code>nth</code></em>
jpayne@68 529 rectangle from the region in <em class="parameter"><code>rectangle</code></em>
jpayne@68 530 .</p>
jpayne@68 531 <div class="refsect3">
jpayne@68 532 <a name="cairo-region-get-rectangle.parameters"></a><h4>Parameters</h4>
jpayne@68 533 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 534 <colgroup>
jpayne@68 535 <col width="150px" class="parameters_name">
jpayne@68 536 <col class="parameters_description">
jpayne@68 537 <col width="200px" class="parameters_annotations">
jpayne@68 538 </colgroup>
jpayne@68 539 <tbody>
jpayne@68 540 <tr>
jpayne@68 541 <td class="parameter_name"><p>region</p></td>
jpayne@68 542 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 543 <td class="parameter_annotations"> </td>
jpayne@68 544 </tr>
jpayne@68 545 <tr>
jpayne@68 546 <td class="parameter_name"><p>nth</p></td>
jpayne@68 547 <td class="parameter_description"><p>a number indicating which rectangle should be returned</p></td>
jpayne@68 548 <td class="parameter_annotations"> </td>
jpayne@68 549 </tr>
jpayne@68 550 <tr>
jpayne@68 551 <td class="parameter_name"><p>rectangle</p></td>
jpayne@68 552 <td class="parameter_description"><p>return location for a <a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t"><span class="type">cairo_rectangle_int_t</span></a></p></td>
jpayne@68 553 <td class="parameter_annotations"> </td>
jpayne@68 554 </tr>
jpayne@68 555 </tbody>
jpayne@68 556 </table></div>
jpayne@68 557 </div>
jpayne@68 558 <p class="since">Since: 1.10</p>
jpayne@68 559 </div>
jpayne@68 560 <hr>
jpayne@68 561 <div class="refsect2">
jpayne@68 562 <a name="cairo-region-is-empty"></a><h3>cairo_region_is_empty ()</h3>
jpayne@68 563 <pre class="programlisting"><a class="link" href="cairo-Types.html#cairo-bool-t" title="cairo_bool_t"><span class="returnvalue">cairo_bool_t</span></a>
jpayne@68 564 cairo_region_is_empty (<em class="parameter"><code>const <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *region</code></em>);</pre>
jpayne@68 565 <p>Checks whether <em class="parameter"><code>region</code></em>
jpayne@68 566 is empty.</p>
jpayne@68 567 <div class="refsect3">
jpayne@68 568 <a name="cairo-region-is-empty.parameters"></a><h4>Parameters</h4>
jpayne@68 569 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 570 <colgroup>
jpayne@68 571 <col width="150px" class="parameters_name">
jpayne@68 572 <col class="parameters_description">
jpayne@68 573 <col width="200px" class="parameters_annotations">
jpayne@68 574 </colgroup>
jpayne@68 575 <tbody><tr>
jpayne@68 576 <td class="parameter_name"><p>region</p></td>
jpayne@68 577 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 578 <td class="parameter_annotations"> </td>
jpayne@68 579 </tr></tbody>
jpayne@68 580 </table></div>
jpayne@68 581 </div>
jpayne@68 582 <div class="refsect3">
jpayne@68 583 <a name="cairo-region-is-empty.returns"></a><h4>Returns</h4>
jpayne@68 584 <p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>region</code></em>
jpayne@68 585 is empty, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it isn't.</p>
jpayne@68 586 </div>
jpayne@68 587 <p class="since">Since: 1.10</p>
jpayne@68 588 </div>
jpayne@68 589 <hr>
jpayne@68 590 <div class="refsect2">
jpayne@68 591 <a name="cairo-region-contains-point"></a><h3>cairo_region_contains_point ()</h3>
jpayne@68 592 <pre class="programlisting"><a class="link" href="cairo-Types.html#cairo-bool-t" title="cairo_bool_t"><span class="returnvalue">cairo_bool_t</span></a>
jpayne@68 593 cairo_region_contains_point (<em class="parameter"><code>const <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *region</code></em>,
jpayne@68 594 <em class="parameter"><code><span class="type">int</span> x</code></em>,
jpayne@68 595 <em class="parameter"><code><span class="type">int</span> y</code></em>);</pre>
jpayne@68 596 <p>Checks whether (<em class="parameter"><code>x</code></em>
jpayne@68 597 , <em class="parameter"><code>y</code></em>
jpayne@68 598 ) is contained in <em class="parameter"><code>region</code></em>
jpayne@68 599 .</p>
jpayne@68 600 <div class="refsect3">
jpayne@68 601 <a name="cairo-region-contains-point.parameters"></a><h4>Parameters</h4>
jpayne@68 602 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 603 <colgroup>
jpayne@68 604 <col width="150px" class="parameters_name">
jpayne@68 605 <col class="parameters_description">
jpayne@68 606 <col width="200px" class="parameters_annotations">
jpayne@68 607 </colgroup>
jpayne@68 608 <tbody>
jpayne@68 609 <tr>
jpayne@68 610 <td class="parameter_name"><p>region</p></td>
jpayne@68 611 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 612 <td class="parameter_annotations"> </td>
jpayne@68 613 </tr>
jpayne@68 614 <tr>
jpayne@68 615 <td class="parameter_name"><p>x</p></td>
jpayne@68 616 <td class="parameter_description"><p>the x coordinate of a point</p></td>
jpayne@68 617 <td class="parameter_annotations"> </td>
jpayne@68 618 </tr>
jpayne@68 619 <tr>
jpayne@68 620 <td class="parameter_name"><p>y</p></td>
jpayne@68 621 <td class="parameter_description"><p>the y coordinate of a point</p></td>
jpayne@68 622 <td class="parameter_annotations"> </td>
jpayne@68 623 </tr>
jpayne@68 624 </tbody>
jpayne@68 625 </table></div>
jpayne@68 626 </div>
jpayne@68 627 <div class="refsect3">
jpayne@68 628 <a name="cairo-region-contains-point.returns"></a><h4>Returns</h4>
jpayne@68 629 <p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if (<em class="parameter"><code>x</code></em>
jpayne@68 630 , <em class="parameter"><code>y</code></em>
jpayne@68 631 ) is contained in <em class="parameter"><code>region</code></em>
jpayne@68 632 , <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it is not.</p>
jpayne@68 633 </div>
jpayne@68 634 <p class="since">Since: 1.10</p>
jpayne@68 635 </div>
jpayne@68 636 <hr>
jpayne@68 637 <div class="refsect2">
jpayne@68 638 <a name="cairo-region-contains-rectangle"></a><h3>cairo_region_contains_rectangle ()</h3>
jpayne@68 639 <pre class="programlisting"><a class="link" href="cairo-Regions.html#cairo-region-overlap-t" title="enum cairo_region_overlap_t"><span class="returnvalue">cairo_region_overlap_t</span></a>
jpayne@68 640 cairo_region_contains_rectangle (<em class="parameter"><code>const <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *region</code></em>,
jpayne@68 641 <em class="parameter"><code>const <a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t"><span class="type">cairo_rectangle_int_t</span></a> *rectangle</code></em>);</pre>
jpayne@68 642 <p>Checks whether <em class="parameter"><code>rectangle</code></em>
jpayne@68 643 is inside, outside or partially contained
jpayne@68 644 in <em class="parameter"><code>region</code></em>
jpayne@68 645 </p>
jpayne@68 646 <div class="refsect3">
jpayne@68 647 <a name="cairo-region-contains-rectangle.parameters"></a><h4>Parameters</h4>
jpayne@68 648 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 649 <colgroup>
jpayne@68 650 <col width="150px" class="parameters_name">
jpayne@68 651 <col class="parameters_description">
jpayne@68 652 <col width="200px" class="parameters_annotations">
jpayne@68 653 </colgroup>
jpayne@68 654 <tbody>
jpayne@68 655 <tr>
jpayne@68 656 <td class="parameter_name"><p>region</p></td>
jpayne@68 657 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 658 <td class="parameter_annotations"> </td>
jpayne@68 659 </tr>
jpayne@68 660 <tr>
jpayne@68 661 <td class="parameter_name"><p>rectangle</p></td>
jpayne@68 662 <td class="parameter_description"><p>a <a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t"><span class="type">cairo_rectangle_int_t</span></a></p></td>
jpayne@68 663 <td class="parameter_annotations"> </td>
jpayne@68 664 </tr>
jpayne@68 665 </tbody>
jpayne@68 666 </table></div>
jpayne@68 667 </div>
jpayne@68 668 <div class="refsect3">
jpayne@68 669 <a name="cairo-region-contains-rectangle.returns"></a><h4>Returns</h4>
jpayne@68 670 <p> <a class="link" href="cairo-Regions.html#CAIRO-REGION-OVERLAP-IN:CAPS"><code class="literal">CAIRO_REGION_OVERLAP_IN</code></a> if <em class="parameter"><code>rectangle</code></em>
jpayne@68 671 is entirely inside <em class="parameter"><code>region</code></em>
jpayne@68 672 ,
jpayne@68 673 <a class="link" href="cairo-Regions.html#CAIRO-REGION-OVERLAP-OUT:CAPS"><code class="literal">CAIRO_REGION_OVERLAP_OUT</code></a> if <em class="parameter"><code>rectangle</code></em>
jpayne@68 674 is entirely outside <em class="parameter"><code>region</code></em>
jpayne@68 675 , or
jpayne@68 676 <a class="link" href="cairo-Regions.html#CAIRO-REGION-OVERLAP-PART:CAPS"><code class="literal">CAIRO_REGION_OVERLAP_PART</code></a> if <em class="parameter"><code>rectangle</code></em>
jpayne@68 677 is partially inside and partially outside <em class="parameter"><code>region</code></em>
jpayne@68 678 .</p>
jpayne@68 679 </div>
jpayne@68 680 <p class="since">Since: 1.10</p>
jpayne@68 681 </div>
jpayne@68 682 <hr>
jpayne@68 683 <div class="refsect2">
jpayne@68 684 <a name="cairo-region-equal"></a><h3>cairo_region_equal ()</h3>
jpayne@68 685 <pre class="programlisting"><a class="link" href="cairo-Types.html#cairo-bool-t" title="cairo_bool_t"><span class="returnvalue">cairo_bool_t</span></a>
jpayne@68 686 cairo_region_equal (<em class="parameter"><code>const <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *a</code></em>,
jpayne@68 687 <em class="parameter"><code>const <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *b</code></em>);</pre>
jpayne@68 688 <p>Compares whether region_a is equivalent to region_b. <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> as an argument
jpayne@68 689 is equal to itself, but not to any non-<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> region.</p>
jpayne@68 690 <div class="refsect3">
jpayne@68 691 <a name="cairo-region-equal.parameters"></a><h4>Parameters</h4>
jpayne@68 692 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 693 <colgroup>
jpayne@68 694 <col width="150px" class="parameters_name">
jpayne@68 695 <col class="parameters_description">
jpayne@68 696 <col width="200px" class="parameters_annotations">
jpayne@68 697 </colgroup>
jpayne@68 698 <tbody>
jpayne@68 699 <tr>
jpayne@68 700 <td class="parameter_name"><p>a</p></td>
jpayne@68 701 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
jpayne@68 702 <td class="parameter_annotations"> </td>
jpayne@68 703 </tr>
jpayne@68 704 <tr>
jpayne@68 705 <td class="parameter_name"><p>b</p></td>
jpayne@68 706 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
jpayne@68 707 <td class="parameter_annotations"> </td>
jpayne@68 708 </tr>
jpayne@68 709 </tbody>
jpayne@68 710 </table></div>
jpayne@68 711 </div>
jpayne@68 712 <div class="refsect3">
jpayne@68 713 <a name="cairo-region-equal.returns"></a><h4>Returns</h4>
jpayne@68 714 <p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if both regions contained the same coverage,
jpayne@68 715 <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it is not or any region is in an error status.</p>
jpayne@68 716 </div>
jpayne@68 717 <p class="since">Since: 1.10</p>
jpayne@68 718 </div>
jpayne@68 719 <hr>
jpayne@68 720 <div class="refsect2">
jpayne@68 721 <a name="cairo-region-translate"></a><h3>cairo_region_translate ()</h3>
jpayne@68 722 <pre class="programlisting"><span class="returnvalue">void</span>
jpayne@68 723 cairo_region_translate (<em class="parameter"><code><a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *region</code></em>,
jpayne@68 724 <em class="parameter"><code><span class="type">int</span> dx</code></em>,
jpayne@68 725 <em class="parameter"><code><span class="type">int</span> dy</code></em>);</pre>
jpayne@68 726 <p>Translates <em class="parameter"><code>region</code></em>
jpayne@68 727 by (<em class="parameter"><code>dx</code></em>
jpayne@68 728 , <em class="parameter"><code>dy</code></em>
jpayne@68 729 ).</p>
jpayne@68 730 <div class="refsect3">
jpayne@68 731 <a name="cairo-region-translate.parameters"></a><h4>Parameters</h4>
jpayne@68 732 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 733 <colgroup>
jpayne@68 734 <col width="150px" class="parameters_name">
jpayne@68 735 <col class="parameters_description">
jpayne@68 736 <col width="200px" class="parameters_annotations">
jpayne@68 737 </colgroup>
jpayne@68 738 <tbody>
jpayne@68 739 <tr>
jpayne@68 740 <td class="parameter_name"><p>region</p></td>
jpayne@68 741 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 742 <td class="parameter_annotations"> </td>
jpayne@68 743 </tr>
jpayne@68 744 <tr>
jpayne@68 745 <td class="parameter_name"><p>dx</p></td>
jpayne@68 746 <td class="parameter_description"><p>Amount to translate in the x direction</p></td>
jpayne@68 747 <td class="parameter_annotations"> </td>
jpayne@68 748 </tr>
jpayne@68 749 <tr>
jpayne@68 750 <td class="parameter_name"><p>dy</p></td>
jpayne@68 751 <td class="parameter_description"><p>Amount to translate in the y direction</p></td>
jpayne@68 752 <td class="parameter_annotations"> </td>
jpayne@68 753 </tr>
jpayne@68 754 </tbody>
jpayne@68 755 </table></div>
jpayne@68 756 </div>
jpayne@68 757 <p class="since">Since: 1.10</p>
jpayne@68 758 </div>
jpayne@68 759 <hr>
jpayne@68 760 <div class="refsect2">
jpayne@68 761 <a name="cairo-region-intersect"></a><h3>cairo_region_intersect ()</h3>
jpayne@68 762 <pre class="programlisting"><a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 763 cairo_region_intersect (<em class="parameter"><code><a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *dst</code></em>,
jpayne@68 764 <em class="parameter"><code>const <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *other</code></em>);</pre>
jpayne@68 765 <p>Computes the intersection of <em class="parameter"><code>dst</code></em>
jpayne@68 766 with <em class="parameter"><code>other</code></em>
jpayne@68 767 and places the result in <em class="parameter"><code>dst</code></em>
jpayne@68 768 </p>
jpayne@68 769 <div class="refsect3">
jpayne@68 770 <a name="cairo-region-intersect.parameters"></a><h4>Parameters</h4>
jpayne@68 771 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 772 <colgroup>
jpayne@68 773 <col width="150px" class="parameters_name">
jpayne@68 774 <col class="parameters_description">
jpayne@68 775 <col width="200px" class="parameters_annotations">
jpayne@68 776 </colgroup>
jpayne@68 777 <tbody>
jpayne@68 778 <tr>
jpayne@68 779 <td class="parameter_name"><p>dst</p></td>
jpayne@68 780 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 781 <td class="parameter_annotations"> </td>
jpayne@68 782 </tr>
jpayne@68 783 <tr>
jpayne@68 784 <td class="parameter_name"><p>other</p></td>
jpayne@68 785 <td class="parameter_description"><p>another <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 786 <td class="parameter_annotations"> </td>
jpayne@68 787 </tr>
jpayne@68 788 </tbody>
jpayne@68 789 </table></div>
jpayne@68 790 </div>
jpayne@68 791 <div class="refsect3">
jpayne@68 792 <a name="cairo-region-intersect.returns"></a><h4>Returns</h4>
jpayne@68 793 <p> <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-SUCCESS:CAPS"><code class="literal">CAIRO_STATUS_SUCCESS</code></a> or <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-NO-MEMORY:CAPS"><code class="literal">CAIRO_STATUS_NO_MEMORY</code></a></p>
jpayne@68 794 </div>
jpayne@68 795 <p class="since">Since: 1.10</p>
jpayne@68 796 </div>
jpayne@68 797 <hr>
jpayne@68 798 <div class="refsect2">
jpayne@68 799 <a name="cairo-region-intersect-rectangle"></a><h3>cairo_region_intersect_rectangle ()</h3>
jpayne@68 800 <pre class="programlisting"><a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 801 cairo_region_intersect_rectangle (<em class="parameter"><code><a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *dst</code></em>,
jpayne@68 802 <em class="parameter"><code>const <a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t"><span class="type">cairo_rectangle_int_t</span></a> *rectangle</code></em>);</pre>
jpayne@68 803 <p>Computes the intersection of <em class="parameter"><code>dst</code></em>
jpayne@68 804 with <em class="parameter"><code>rectangle</code></em>
jpayne@68 805 and places the
jpayne@68 806 result in <em class="parameter"><code>dst</code></em>
jpayne@68 807 </p>
jpayne@68 808 <div class="refsect3">
jpayne@68 809 <a name="cairo-region-intersect-rectangle.parameters"></a><h4>Parameters</h4>
jpayne@68 810 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 811 <colgroup>
jpayne@68 812 <col width="150px" class="parameters_name">
jpayne@68 813 <col class="parameters_description">
jpayne@68 814 <col width="200px" class="parameters_annotations">
jpayne@68 815 </colgroup>
jpayne@68 816 <tbody>
jpayne@68 817 <tr>
jpayne@68 818 <td class="parameter_name"><p>dst</p></td>
jpayne@68 819 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 820 <td class="parameter_annotations"> </td>
jpayne@68 821 </tr>
jpayne@68 822 <tr>
jpayne@68 823 <td class="parameter_name"><p>rectangle</p></td>
jpayne@68 824 <td class="parameter_description"><p>a <a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t"><span class="type">cairo_rectangle_int_t</span></a></p></td>
jpayne@68 825 <td class="parameter_annotations"> </td>
jpayne@68 826 </tr>
jpayne@68 827 </tbody>
jpayne@68 828 </table></div>
jpayne@68 829 </div>
jpayne@68 830 <div class="refsect3">
jpayne@68 831 <a name="cairo-region-intersect-rectangle.returns"></a><h4>Returns</h4>
jpayne@68 832 <p> <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-SUCCESS:CAPS"><code class="literal">CAIRO_STATUS_SUCCESS</code></a> or <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-NO-MEMORY:CAPS"><code class="literal">CAIRO_STATUS_NO_MEMORY</code></a></p>
jpayne@68 833 </div>
jpayne@68 834 <p class="since">Since: 1.10</p>
jpayne@68 835 </div>
jpayne@68 836 <hr>
jpayne@68 837 <div class="refsect2">
jpayne@68 838 <a name="cairo-region-subtract"></a><h3>cairo_region_subtract ()</h3>
jpayne@68 839 <pre class="programlisting"><a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 840 cairo_region_subtract (<em class="parameter"><code><a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *dst</code></em>,
jpayne@68 841 <em class="parameter"><code>const <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *other</code></em>);</pre>
jpayne@68 842 <p>Subtracts <em class="parameter"><code>other</code></em>
jpayne@68 843 from <em class="parameter"><code>dst</code></em>
jpayne@68 844 and places the result in <em class="parameter"><code>dst</code></em>
jpayne@68 845 </p>
jpayne@68 846 <div class="refsect3">
jpayne@68 847 <a name="cairo-region-subtract.parameters"></a><h4>Parameters</h4>
jpayne@68 848 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 849 <colgroup>
jpayne@68 850 <col width="150px" class="parameters_name">
jpayne@68 851 <col class="parameters_description">
jpayne@68 852 <col width="200px" class="parameters_annotations">
jpayne@68 853 </colgroup>
jpayne@68 854 <tbody>
jpayne@68 855 <tr>
jpayne@68 856 <td class="parameter_name"><p>dst</p></td>
jpayne@68 857 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 858 <td class="parameter_annotations"> </td>
jpayne@68 859 </tr>
jpayne@68 860 <tr>
jpayne@68 861 <td class="parameter_name"><p>other</p></td>
jpayne@68 862 <td class="parameter_description"><p>another <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 863 <td class="parameter_annotations"> </td>
jpayne@68 864 </tr>
jpayne@68 865 </tbody>
jpayne@68 866 </table></div>
jpayne@68 867 </div>
jpayne@68 868 <div class="refsect3">
jpayne@68 869 <a name="cairo-region-subtract.returns"></a><h4>Returns</h4>
jpayne@68 870 <p> <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-SUCCESS:CAPS"><code class="literal">CAIRO_STATUS_SUCCESS</code></a> or <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-NO-MEMORY:CAPS"><code class="literal">CAIRO_STATUS_NO_MEMORY</code></a></p>
jpayne@68 871 </div>
jpayne@68 872 <p class="since">Since: 1.10</p>
jpayne@68 873 </div>
jpayne@68 874 <hr>
jpayne@68 875 <div class="refsect2">
jpayne@68 876 <a name="cairo-region-subtract-rectangle"></a><h3>cairo_region_subtract_rectangle ()</h3>
jpayne@68 877 <pre class="programlisting"><a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 878 cairo_region_subtract_rectangle (<em class="parameter"><code><a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *dst</code></em>,
jpayne@68 879 <em class="parameter"><code>const <a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t"><span class="type">cairo_rectangle_int_t</span></a> *rectangle</code></em>);</pre>
jpayne@68 880 <p>Subtracts <em class="parameter"><code>rectangle</code></em>
jpayne@68 881 from <em class="parameter"><code>dst</code></em>
jpayne@68 882 and places the result in <em class="parameter"><code>dst</code></em>
jpayne@68 883 </p>
jpayne@68 884 <div class="refsect3">
jpayne@68 885 <a name="cairo-region-subtract-rectangle.parameters"></a><h4>Parameters</h4>
jpayne@68 886 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 887 <colgroup>
jpayne@68 888 <col width="150px" class="parameters_name">
jpayne@68 889 <col class="parameters_description">
jpayne@68 890 <col width="200px" class="parameters_annotations">
jpayne@68 891 </colgroup>
jpayne@68 892 <tbody>
jpayne@68 893 <tr>
jpayne@68 894 <td class="parameter_name"><p>dst</p></td>
jpayne@68 895 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 896 <td class="parameter_annotations"> </td>
jpayne@68 897 </tr>
jpayne@68 898 <tr>
jpayne@68 899 <td class="parameter_name"><p>rectangle</p></td>
jpayne@68 900 <td class="parameter_description"><p>a <a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t"><span class="type">cairo_rectangle_int_t</span></a></p></td>
jpayne@68 901 <td class="parameter_annotations"> </td>
jpayne@68 902 </tr>
jpayne@68 903 </tbody>
jpayne@68 904 </table></div>
jpayne@68 905 </div>
jpayne@68 906 <div class="refsect3">
jpayne@68 907 <a name="cairo-region-subtract-rectangle.returns"></a><h4>Returns</h4>
jpayne@68 908 <p> <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-SUCCESS:CAPS"><code class="literal">CAIRO_STATUS_SUCCESS</code></a> or <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-NO-MEMORY:CAPS"><code class="literal">CAIRO_STATUS_NO_MEMORY</code></a></p>
jpayne@68 909 </div>
jpayne@68 910 <p class="since">Since: 1.10</p>
jpayne@68 911 </div>
jpayne@68 912 <hr>
jpayne@68 913 <div class="refsect2">
jpayne@68 914 <a name="cairo-region-union"></a><h3>cairo_region_union ()</h3>
jpayne@68 915 <pre class="programlisting"><a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 916 cairo_region_union (<em class="parameter"><code><a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *dst</code></em>,
jpayne@68 917 <em class="parameter"><code>const <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *other</code></em>);</pre>
jpayne@68 918 <p>Computes the union of <em class="parameter"><code>dst</code></em>
jpayne@68 919 with <em class="parameter"><code>other</code></em>
jpayne@68 920 and places the result in <em class="parameter"><code>dst</code></em>
jpayne@68 921 </p>
jpayne@68 922 <div class="refsect3">
jpayne@68 923 <a name="cairo-region-union.parameters"></a><h4>Parameters</h4>
jpayne@68 924 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 925 <colgroup>
jpayne@68 926 <col width="150px" class="parameters_name">
jpayne@68 927 <col class="parameters_description">
jpayne@68 928 <col width="200px" class="parameters_annotations">
jpayne@68 929 </colgroup>
jpayne@68 930 <tbody>
jpayne@68 931 <tr>
jpayne@68 932 <td class="parameter_name"><p>dst</p></td>
jpayne@68 933 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 934 <td class="parameter_annotations"> </td>
jpayne@68 935 </tr>
jpayne@68 936 <tr>
jpayne@68 937 <td class="parameter_name"><p>other</p></td>
jpayne@68 938 <td class="parameter_description"><p>another <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 939 <td class="parameter_annotations"> </td>
jpayne@68 940 </tr>
jpayne@68 941 </tbody>
jpayne@68 942 </table></div>
jpayne@68 943 </div>
jpayne@68 944 <div class="refsect3">
jpayne@68 945 <a name="cairo-region-union.returns"></a><h4>Returns</h4>
jpayne@68 946 <p> <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-SUCCESS:CAPS"><code class="literal">CAIRO_STATUS_SUCCESS</code></a> or <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-NO-MEMORY:CAPS"><code class="literal">CAIRO_STATUS_NO_MEMORY</code></a></p>
jpayne@68 947 </div>
jpayne@68 948 <p class="since">Since: 1.10</p>
jpayne@68 949 </div>
jpayne@68 950 <hr>
jpayne@68 951 <div class="refsect2">
jpayne@68 952 <a name="cairo-region-union-rectangle"></a><h3>cairo_region_union_rectangle ()</h3>
jpayne@68 953 <pre class="programlisting"><a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 954 cairo_region_union_rectangle (<em class="parameter"><code><a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *dst</code></em>,
jpayne@68 955 <em class="parameter"><code>const <a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t"><span class="type">cairo_rectangle_int_t</span></a> *rectangle</code></em>);</pre>
jpayne@68 956 <p>Computes the union of <em class="parameter"><code>dst</code></em>
jpayne@68 957 with <em class="parameter"><code>rectangle</code></em>
jpayne@68 958 and places the result in <em class="parameter"><code>dst</code></em>
jpayne@68 959 .</p>
jpayne@68 960 <div class="refsect3">
jpayne@68 961 <a name="cairo-region-union-rectangle.parameters"></a><h4>Parameters</h4>
jpayne@68 962 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 963 <colgroup>
jpayne@68 964 <col width="150px" class="parameters_name">
jpayne@68 965 <col class="parameters_description">
jpayne@68 966 <col width="200px" class="parameters_annotations">
jpayne@68 967 </colgroup>
jpayne@68 968 <tbody>
jpayne@68 969 <tr>
jpayne@68 970 <td class="parameter_name"><p>dst</p></td>
jpayne@68 971 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 972 <td class="parameter_annotations"> </td>
jpayne@68 973 </tr>
jpayne@68 974 <tr>
jpayne@68 975 <td class="parameter_name"><p>rectangle</p></td>
jpayne@68 976 <td class="parameter_description"><p>a <a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t"><span class="type">cairo_rectangle_int_t</span></a></p></td>
jpayne@68 977 <td class="parameter_annotations"> </td>
jpayne@68 978 </tr>
jpayne@68 979 </tbody>
jpayne@68 980 </table></div>
jpayne@68 981 </div>
jpayne@68 982 <div class="refsect3">
jpayne@68 983 <a name="cairo-region-union-rectangle.returns"></a><h4>Returns</h4>
jpayne@68 984 <p> <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-SUCCESS:CAPS"><code class="literal">CAIRO_STATUS_SUCCESS</code></a> or <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-NO-MEMORY:CAPS"><code class="literal">CAIRO_STATUS_NO_MEMORY</code></a></p>
jpayne@68 985 </div>
jpayne@68 986 <p class="since">Since: 1.10</p>
jpayne@68 987 </div>
jpayne@68 988 <hr>
jpayne@68 989 <div class="refsect2">
jpayne@68 990 <a name="cairo-region-xor"></a><h3>cairo_region_xor ()</h3>
jpayne@68 991 <pre class="programlisting"><a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 992 cairo_region_xor (<em class="parameter"><code><a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *dst</code></em>,
jpayne@68 993 <em class="parameter"><code>const <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *other</code></em>);</pre>
jpayne@68 994 <p>Computes the exclusive difference of <em class="parameter"><code>dst</code></em>
jpayne@68 995 with <em class="parameter"><code>other</code></em>
jpayne@68 996 and places the
jpayne@68 997 result in <em class="parameter"><code>dst</code></em>
jpayne@68 998 . That is, <em class="parameter"><code>dst</code></em>
jpayne@68 999 will be set to contain all areas that
jpayne@68 1000 are either in <em class="parameter"><code>dst</code></em>
jpayne@68 1001 or in <em class="parameter"><code>other</code></em>
jpayne@68 1002 , but not in both.</p>
jpayne@68 1003 <div class="refsect3">
jpayne@68 1004 <a name="cairo-region-xor.parameters"></a><h4>Parameters</h4>
jpayne@68 1005 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 1006 <colgroup>
jpayne@68 1007 <col width="150px" class="parameters_name">
jpayne@68 1008 <col class="parameters_description">
jpayne@68 1009 <col width="200px" class="parameters_annotations">
jpayne@68 1010 </colgroup>
jpayne@68 1011 <tbody>
jpayne@68 1012 <tr>
jpayne@68 1013 <td class="parameter_name"><p>dst</p></td>
jpayne@68 1014 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 1015 <td class="parameter_annotations"> </td>
jpayne@68 1016 </tr>
jpayne@68 1017 <tr>
jpayne@68 1018 <td class="parameter_name"><p>other</p></td>
jpayne@68 1019 <td class="parameter_description"><p>another <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 1020 <td class="parameter_annotations"> </td>
jpayne@68 1021 </tr>
jpayne@68 1022 </tbody>
jpayne@68 1023 </table></div>
jpayne@68 1024 </div>
jpayne@68 1025 <div class="refsect3">
jpayne@68 1026 <a name="cairo-region-xor.returns"></a><h4>Returns</h4>
jpayne@68 1027 <p> <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-SUCCESS:CAPS"><code class="literal">CAIRO_STATUS_SUCCESS</code></a> or <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-NO-MEMORY:CAPS"><code class="literal">CAIRO_STATUS_NO_MEMORY</code></a></p>
jpayne@68 1028 </div>
jpayne@68 1029 <p class="since">Since: 1.10</p>
jpayne@68 1030 </div>
jpayne@68 1031 <hr>
jpayne@68 1032 <div class="refsect2">
jpayne@68 1033 <a name="cairo-region-xor-rectangle"></a><h3>cairo_region_xor_rectangle ()</h3>
jpayne@68 1034 <pre class="programlisting"><a class="link" href="cairo-Error-handling.html#cairo-status-t" title="enum cairo_status_t"><span class="returnvalue">cairo_status_t</span></a>
jpayne@68 1035 cairo_region_xor_rectangle (<em class="parameter"><code><a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> *dst</code></em>,
jpayne@68 1036 <em class="parameter"><code>const <a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t"><span class="type">cairo_rectangle_int_t</span></a> *rectangle</code></em>);</pre>
jpayne@68 1037 <p>Computes the exclusive difference of <em class="parameter"><code>dst</code></em>
jpayne@68 1038 with <em class="parameter"><code>rectangle</code></em>
jpayne@68 1039 and places the
jpayne@68 1040 result in <em class="parameter"><code>dst</code></em>
jpayne@68 1041 . That is, <em class="parameter"><code>dst</code></em>
jpayne@68 1042 will be set to contain all areas that are
jpayne@68 1043 either in <em class="parameter"><code>dst</code></em>
jpayne@68 1044 or in <em class="parameter"><code>rectangle</code></em>
jpayne@68 1045 , but not in both.</p>
jpayne@68 1046 <div class="refsect3">
jpayne@68 1047 <a name="cairo-region-xor-rectangle.parameters"></a><h4>Parameters</h4>
jpayne@68 1048 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 1049 <colgroup>
jpayne@68 1050 <col width="150px" class="parameters_name">
jpayne@68 1051 <col class="parameters_description">
jpayne@68 1052 <col width="200px" class="parameters_annotations">
jpayne@68 1053 </colgroup>
jpayne@68 1054 <tbody>
jpayne@68 1055 <tr>
jpayne@68 1056 <td class="parameter_name"><p>dst</p></td>
jpayne@68 1057 <td class="parameter_description"><p>a <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a></p></td>
jpayne@68 1058 <td class="parameter_annotations"> </td>
jpayne@68 1059 </tr>
jpayne@68 1060 <tr>
jpayne@68 1061 <td class="parameter_name"><p>rectangle</p></td>
jpayne@68 1062 <td class="parameter_description"><p>a <a class="link" href="cairo-Types.html#cairo-rectangle-int-t" title="cairo_rectangle_int_t"><span class="type">cairo_rectangle_int_t</span></a></p></td>
jpayne@68 1063 <td class="parameter_annotations"> </td>
jpayne@68 1064 </tr>
jpayne@68 1065 </tbody>
jpayne@68 1066 </table></div>
jpayne@68 1067 </div>
jpayne@68 1068 <div class="refsect3">
jpayne@68 1069 <a name="cairo-region-xor-rectangle.returns"></a><h4>Returns</h4>
jpayne@68 1070 <p> <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-SUCCESS:CAPS"><code class="literal">CAIRO_STATUS_SUCCESS</code></a> or <a class="link" href="cairo-Error-handling.html#CAIRO-STATUS-NO-MEMORY:CAPS"><code class="literal">CAIRO_STATUS_NO_MEMORY</code></a></p>
jpayne@68 1071 </div>
jpayne@68 1072 <p class="since">Since: 1.10</p>
jpayne@68 1073 </div>
jpayne@68 1074 </div>
jpayne@68 1075 <div class="refsect1">
jpayne@68 1076 <a name="cairo-Regions.other_details"></a><h2>Types and Values</h2>
jpayne@68 1077 <div class="refsect2">
jpayne@68 1078 <a name="cairo-region-t"></a><h3>cairo_region_t</h3>
jpayne@68 1079 <pre class="programlisting">typedef struct _cairo_region cairo_region_t;
jpayne@68 1080 </pre>
jpayne@68 1081 <p>A <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> represents a set of integer-aligned rectangles.</p>
jpayne@68 1082 <p>It allows set-theoretical operations like <a class="link" href="cairo-Regions.html#cairo-region-union" title="cairo_region_union ()"><code class="function">cairo_region_union()</code></a> and
jpayne@68 1083 <a class="link" href="cairo-Regions.html#cairo-region-intersect" title="cairo_region_intersect ()"><code class="function">cairo_region_intersect()</code></a> to be performed on them.</p>
jpayne@68 1084 <p>Memory management of <a class="link" href="cairo-Regions.html#cairo-region-t" title="cairo_region_t"><span class="type">cairo_region_t</span></a> is done with
jpayne@68 1085 <a class="link" href="cairo-Regions.html#cairo-region-reference" title="cairo_region_reference ()"><code class="function">cairo_region_reference()</code></a> and <a class="link" href="cairo-Regions.html#cairo-region-destroy" title="cairo_region_destroy ()"><code class="function">cairo_region_destroy()</code></a>.</p>
jpayne@68 1086 <p class="since">Since: 1.10</p>
jpayne@68 1087 </div>
jpayne@68 1088 <hr>
jpayne@68 1089 <div class="refsect2">
jpayne@68 1090 <a name="cairo-region-overlap-t"></a><h3>enum cairo_region_overlap_t</h3>
jpayne@68 1091 <p>Used as the return value for <a class="link" href="cairo-Regions.html#cairo-region-contains-rectangle" title="cairo_region_contains_rectangle ()"><code class="function">cairo_region_contains_rectangle()</code></a>.</p>
jpayne@68 1092 <div class="refsect3">
jpayne@68 1093 <a name="cairo-region-overlap-t.members"></a><h4>Members</h4>
jpayne@68 1094 <div class="informaltable"><table class="informaltable" width="100%" border="0">
jpayne@68 1095 <colgroup>
jpayne@68 1096 <col width="300px" class="enum_members_name">
jpayne@68 1097 <col class="enum_members_description">
jpayne@68 1098 <col width="200px" class="enum_members_annotations">
jpayne@68 1099 </colgroup>
jpayne@68 1100 <tbody>
jpayne@68 1101 <tr>
jpayne@68 1102 <td class="enum_member_name"><p><a name="CAIRO-REGION-OVERLAP-IN:CAPS"></a>CAIRO_REGION_OVERLAP_IN</p></td>
jpayne@68 1103 <td class="enum_member_description">
jpayne@68 1104 <p>The contents are entirely inside the region. (Since 1.10)</p>
jpayne@68 1105 </td>
jpayne@68 1106 <td class="enum_member_annotations"> </td>
jpayne@68 1107 </tr>
jpayne@68 1108 <tr>
jpayne@68 1109 <td class="enum_member_name"><p><a name="CAIRO-REGION-OVERLAP-OUT:CAPS"></a>CAIRO_REGION_OVERLAP_OUT</p></td>
jpayne@68 1110 <td class="enum_member_description">
jpayne@68 1111 <p>The contents are entirely outside the region. (Since 1.10)</p>
jpayne@68 1112 </td>
jpayne@68 1113 <td class="enum_member_annotations"> </td>
jpayne@68 1114 </tr>
jpayne@68 1115 <tr>
jpayne@68 1116 <td class="enum_member_name"><p><a name="CAIRO-REGION-OVERLAP-PART:CAPS"></a>CAIRO_REGION_OVERLAP_PART</p></td>
jpayne@68 1117 <td class="enum_member_description">
jpayne@68 1118 <p>The contents are partially inside and
jpayne@68 1119 partially outside the region. (Since 1.10)</p>
jpayne@68 1120 </td>
jpayne@68 1121 <td class="enum_member_annotations"> </td>
jpayne@68 1122 </tr>
jpayne@68 1123 </tbody>
jpayne@68 1124 </table></div>
jpayne@68 1125 </div>
jpayne@68 1126 <p class="since">Since: 1.10</p>
jpayne@68 1127 </div>
jpayne@68 1128 </div>
jpayne@68 1129 </div>
jpayne@68 1130 <div class="footer">
jpayne@68 1131 <hr>Generated by GTK-Doc V1.27</div>
jpayne@68 1132 </body>
jpayne@68 1133 </html>