Mercurial > repos > rliterman > csp2

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