callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
e2447b3b1045caebd5e03ea2fa1c16af8ef94a5b
gimp/devel-docs/libgimpbase/html/libgimpbase-gimprectangle.html
Simon McVittie c6b46b63b5 New upstream version 2.10.20
2020-08-26 11:05:56 +01:00

257 lines
12 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimprectangle: GIMP Base Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="pt01.html" title="Part I. GIMP Base Library">
<link rel="prev" href="libgimpbase-GimpMetadata.html" title="GimpMetadata">
<link rel="next" href="libgimpbase-GimpParasite.html" title="GimpParasite">
<meta name="generator" content="GTK-Doc V1.32 (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="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="pt01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimpbase-GimpMetadata.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>
<td valign="top">
<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 class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimpbase-gimprectangle.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<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 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="gimp-rectangle-intersect.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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="gimp-rectangle-intersect.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the intersection is non-empty, <code class="literal">FALSE</code> otherwise</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></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="refsect3">
<a name="gimp-rectangle-union.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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 union (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 union (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 union (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 union (may be <code class="literal">NULL</code>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-8.html#api-index-2.8">2.8</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink