Imported Upstream version 2.8.14

This commit is contained in:
Ari Pollak
2014-09-20 13:16:57 -04:00
parent b8aa0b67d1
commit bf2f572083
929 changed files with 308006 additions and 240437 deletions

View File

@ -2,30 +2,26 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimprectangle</title>
<title>GIMP Base Library Reference Manual: gimprectangle</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part I. GIMP Base Library">
<link rel="prev" href="libgimpbase-gimpmemsize.html" title="gimpmemsize">
<link rel="next" href="libgimpbase-gimpparasite.html" title="gimpparasite">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimpmemsize.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimpparasite.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgimpbase-gimprectangle.synopsis" class="shortcut">Top</a>
 | 
<a href="#libgimpbase-gimprectangle.description" class="shortcut">Description</a>
</td></tr>
</table>
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#libgimpbase-gimprectangle.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimpbase-gimpmemsize.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimpbase-gimpparasite.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimpbase-gimprectangle"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
@ -33,204 +29,234 @@
<h2><span class="refentrytitle"><a name="libgimpbase-gimprectangle.top_of_page"></a>gimprectangle</span></h2>
<p>gimprectangle — Utility functions dealing with rectangle extents.</p>
</td>
<td valign="top" align="right"></td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgimpbase-gimprectangle.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">gboolean</span> <a class="link" href="libgimpbase-gimprectangle.html#gimp-rectangle-intersect" title="gimp_rectangle_intersect ()">gimp_rectangle_intersect</a> (<em class="parameter"><code><span class="type">gint</span> x1</code></em>,
<em class="parameter"><code><span class="type">gint</span> y1</code></em>,
<em class="parameter"><code><span class="type">gint</span> width1</code></em>,
<em class="parameter"><code><span class="type">gint</span> height1</code></em>,
<em class="parameter"><code><span class="type">gint</span> x2</code></em>,
<em class="parameter"><code><span class="type">gint</span> y2</code></em>,
<em class="parameter"><code><span class="type">gint</span> width2</code></em>,
<em class="parameter"><code><span class="type">gint</span> height2</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_x</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_y</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_width</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_height</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgimpbase-gimprectangle.html#gimp-rectangle-union" title="gimp_rectangle_union ()">gimp_rectangle_union</a> (<em class="parameter"><code><span class="type">gint</span> x1</code></em>,
<em class="parameter"><code><span class="type">gint</span> y1</code></em>,
<em class="parameter"><code><span class="type">gint</span> width1</code></em>,
<em class="parameter"><code><span class="type">gint</span> height1</code></em>,
<em class="parameter"><code><span class="type">gint</span> x2</code></em>,
<em class="parameter"><code><span class="type">gint</span> y2</code></em>,
<em class="parameter"><code><span class="type">gint</span> width2</code></em>,
<em class="parameter"><code><span class="type">gint</span> height2</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_x</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_y</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_width</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_height</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgimpbase-gimprectangle.description"></a><h2>Description</h2>
<p>
Utility functions dealing with rectangle extents.
</p>
</div>
<div class="refsect1">
<a name="libgimpbase-gimprectangle.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gimp-rectangle-intersect"></a><h3>gimp_rectangle_intersect ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gimp_rectangle_intersect (<em class="parameter"><code><span class="type">gint</span> x1</code></em>,
<em class="parameter"><code><span class="type">gint</span> y1</code></em>,
<em class="parameter"><code><span class="type">gint</span> width1</code></em>,
<em class="parameter"><code><span class="type">gint</span> height1</code></em>,
<em class="parameter"><code><span class="type">gint</span> x2</code></em>,
<em class="parameter"><code><span class="type">gint</span> y2</code></em>,
<em class="parameter"><code><span class="type">gint</span> width2</code></em>,
<em class="parameter"><code><span class="type">gint</span> height2</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_x</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_y</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_width</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_height</code></em>);</pre>
<p>
Calculates the intersection of two rectangles.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<a name="libgimpbase-gimprectangle.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col align="left" valign="top">
<col>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x1</code></em> :</span></p></td>
<td>origin of first rectangle</td>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimpbase-gimprectangle.html#gimp-rectangle-intersect" title="gimp_rectangle_intersect ()">gimp_rectangle_intersect</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y1</code></em> :</span></p></td>
<td>origin of first rectangle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width1</code></em> :</span></p></td>
<td>width of first rectangle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height1</code></em> :</span></p></td>
<td>height of first rectangle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x2</code></em> :</span></p></td>
<td>origin of second rectangle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y2</code></em> :</span></p></td>
<td>origin of second rectangle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width2</code></em> :</span></p></td>
<td>width of second rectangle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height2</code></em> :</span></p></td>
<td>height of second rectangle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_x</code></em> :</span></p></td>
<td>return location for origin of intersection (may be <code class="literal">NULL</code>)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_y</code></em> :</span></p></td>
<td>return location for origin of intersection (may be <code class="literal">NULL</code>)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_width</code></em> :</span></p></td>
<td>return location for width of intersection (may be <code class="literal">NULL</code>)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_height</code></em> :</span></p></td>
<td>return location for height of intersection (may be <code class="literal">NULL</code>)</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the intersection is non-empty, <code class="literal">FALSE</code> otherwise</td>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgimpbase-gimprectangle.html#gimp-rectangle-union" title="gimp_rectangle_union ()">gimp_rectangle_union</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimpbase-gimprectangle.description"></a><h2>Description</h2>
<p>Utility functions dealing with rectangle extents.</p>
</div>
<div class="refsect1">
<a name="libgimpbase-gimprectangle.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-rectangle-intersect"></a><h3>gimp_rectangle_intersect ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_rectangle_intersect (<em class="parameter"><code><span class="type">gint</span> x1</code></em>,
<em class="parameter"><code><span class="type">gint</span> y1</code></em>,
<em class="parameter"><code><span class="type">gint</span> width1</code></em>,
<em class="parameter"><code><span class="type">gint</span> height1</code></em>,
<em class="parameter"><code><span class="type">gint</span> x2</code></em>,
<em class="parameter"><code><span class="type">gint</span> y2</code></em>,
<em class="parameter"><code><span class="type">gint</span> width2</code></em>,
<em class="parameter"><code><span class="type">gint</span> height2</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_x</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_y</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_width</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_height</code></em>);</pre>
<p>Calculates the intersection of two rectangles.</p>
<div class="refsect3">
<a name="id-1.2.12.5.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>x1</p></td>
<td class="parameter_description"><p>origin of first rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y1</p></td>
<td class="parameter_description"><p>origin of first rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width1</p></td>
<td class="parameter_description"><p>width of first rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height1</p></td>
<td class="parameter_description"><p>height of first rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x2</p></td>
<td class="parameter_description"><p>origin of second rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y2</p></td>
<td class="parameter_description"><p>origin of second rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width2</p></td>
<td class="parameter_description"><p>width of second rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height2</p></td>
<td class="parameter_description"><p>height of second rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dest_x</p></td>
<td class="parameter_description"><p>return location for origin of intersection (may be <code class="literal">NULL</code>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dest_y</p></td>
<td class="parameter_description"><p>return location for origin of intersection (may be <code class="literal">NULL</code>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dest_width</p></td>
<td class="parameter_description"><p>return location for width of intersection (may be <code class="literal">NULL</code>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dest_height</p></td>
<td class="parameter_description"><p>return location for height of intersection (may be <code class="literal">NULL</code>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.12.5.2.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the intersection is non-empty, <code class="literal">FALSE</code> otherwise</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-rectangle-union"></a><h3>gimp_rectangle_union ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gimp_rectangle_union (<em class="parameter"><code><span class="type">gint</span> x1</code></em>,
<em class="parameter"><code><span class="type">gint</span> y1</code></em>,
<em class="parameter"><code><span class="type">gint</span> width1</code></em>,
<em class="parameter"><code><span class="type">gint</span> height1</code></em>,
<em class="parameter"><code><span class="type">gint</span> x2</code></em>,
<em class="parameter"><code><span class="type">gint</span> y2</code></em>,
<em class="parameter"><code><span class="type">gint</span> width2</code></em>,
<em class="parameter"><code><span class="type">gint</span> height2</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_x</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_y</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_width</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_height</code></em>);</pre>
<p>
Calculates the union of two rectangles.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<a name="gimp-rectangle-union"></a><h3>gimp_rectangle_union ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_rectangle_union (<em class="parameter"><code><span class="type">gint</span> x1</code></em>,
<em class="parameter"><code><span class="type">gint</span> y1</code></em>,
<em class="parameter"><code><span class="type">gint</span> width1</code></em>,
<em class="parameter"><code><span class="type">gint</span> height1</code></em>,
<em class="parameter"><code><span class="type">gint</span> x2</code></em>,
<em class="parameter"><code><span class="type">gint</span> y2</code></em>,
<em class="parameter"><code><span class="type">gint</span> width2</code></em>,
<em class="parameter"><code><span class="type">gint</span> height2</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_x</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_y</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_width</code></em>,
<em class="parameter"><code><span class="type">gint</span> *dest_height</code></em>);</pre>
<p>Calculates the union of two rectangles.</p>
<div class="refsect3">
<a name="id-1.2.12.5.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col align="left" valign="top">
<col>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x1</code></em> :</span></p></td>
<td>origin of first rectangle</td>
<td class="parameter_name"><p>x1</p></td>
<td class="parameter_description"><p>origin of first rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y1</code></em> :</span></p></td>
<td>origin of first rectangle</td>
<td class="parameter_name"><p>y1</p></td>
<td class="parameter_description"><p>origin of first rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width1</code></em> :</span></p></td>
<td>width of first rectangle</td>
<td class="parameter_name"><p>width1</p></td>
<td class="parameter_description"><p>width of first rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height1</code></em> :</span></p></td>
<td>height of first rectangle</td>
<td class="parameter_name"><p>height1</p></td>
<td class="parameter_description"><p>height of first rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x2</code></em> :</span></p></td>
<td>origin of second rectangle</td>
<td class="parameter_name"><p>x2</p></td>
<td class="parameter_description"><p>origin of second rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y2</code></em> :</span></p></td>
<td>origin of second rectangle</td>
<td class="parameter_name"><p>y2</p></td>
<td class="parameter_description"><p>origin of second rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width2</code></em> :</span></p></td>
<td>width of second rectangle</td>
<td class="parameter_name"><p>width2</p></td>
<td class="parameter_description"><p>width of second rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height2</code></em> :</span></p></td>
<td>height of second rectangle</td>
<td class="parameter_name"><p>height2</p></td>
<td class="parameter_description"><p>height of second rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_x</code></em> :</span></p></td>
<td>return location for origin of union (may be <code class="literal">NULL</code>)</td>
<td class="parameter_name"><p>dest_x</p></td>
<td class="parameter_description"><p>return location for origin of union (may be <code class="literal">NULL</code>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_y</code></em> :</span></p></td>
<td>return location for origin of union (may be <code class="literal">NULL</code>)</td>
<td class="parameter_name"><p>dest_y</p></td>
<td class="parameter_description"><p>return location for origin of union (may be <code class="literal">NULL</code>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_width</code></em> :</span></p></td>
<td>return location for width of union (may be <code class="literal">NULL</code>)</td>
<td class="parameter_name"><p>dest_width</p></td>
<td class="parameter_description"><p>return location for width of union (may be <code class="literal">NULL</code>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_height</code></em> :</span></p></td>
<td>return location for height of union (may be <code class="literal">NULL</code>)</td>
<td class="parameter_name"><p>dest_height</p></td>
<td class="parameter_description"><p>return location for height of union (may be <code class="literal">NULL</code>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since GIMP 2.8</p>
</div>
</div>
<div class="refsect1">
<a name="libgimpbase-gimprectangle.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
Generated by GTK-Doc V1.21</div>
</body>
</html>