<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<!-- lifted from troff+man by doclifter -->
<refentry id='xeregionman'>
<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium -->

<!--  Permission is hereby granted, free of charge, to any person obtaining -->
<!--  a copy of this software and associated documentation files (the -->
<!--  "Software"), to deal in the Software without restriction, including -->
<!--  without limitation the rights to use, copy, modify, merge, publish, -->
<!--  distribute, sublicense, and/or sell copies of the Software, and to -->
<!--  permit persons to whom the Software is furnished to do so, subject to -->
<!--  the following conditions: -->

<!--  The above copyright notice and this permission notice shall be included -->
<!--  in all copies or substantial portions of the Software. -->

<!--  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS -->
<!--  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -->
<!--  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -->
<!--  IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR -->
<!--  OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, -->
<!--  ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -->
<!--  OTHER DEALINGS IN THE SOFTWARE. -->

<!--  Except as contained in this notice, the name of the X Consortium shall -->
<!--  not be used in advertising or otherwise to promote the sale, use or -->
<!--  other dealings in this Software without prior written authorization -->
<!--  from the X Consortium. -->

<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by -->
<!--  Digital Equipment Corporation -->

<!--  Portions Copyright \(co 1990, 1991 by -->
<!--  Tektronix, Inc. -->

<!--  Permission to use, copy, modify and distribute this documentation for -->
<!--  any purpose and without fee is hereby granted, provided that the above -->
<!--  copyright notice appears in all copies and that both that copyright notice -->
<!--  and this permission notice appear in all copies, and that the names of -->
<!--  Digital and Tektronix not be used in in advertising or publicity pertaining -->
<!--  to this documentation without specific, written prior permission. -->
<!--  Digital and Tektronix makes no representations about the suitability -->
<!--  of this documentation for any purpose. -->
<!--  It is provided ``as is'' without express or implied warranty. -->
<!--   -->
<!--  $XFree86: xc/doc/man/X11/XERegion.man,v 1.4 2003/04/28 22:17:54 herrb Exp $ -->

<!-- .na -->
<!-- Ds listing suppressed (not used) -->
<!-- De listing suppressed (not used) -->
<!-- FD listing suppressed (not used) -->
<!-- FN listing suppressed (not used) -->
<!-- IN listing suppressed (not used) -->
<!-- C{ listing suppressed (not used) -->
<!-- C} listing suppressed (not used) -->
<!-- Pn listing suppressed (not used) -->
<!-- hN listing suppressed (not used) -->
<!-- NT listing suppressed (not used) -->
<!-- .		\" Note End \-\- doug kraft 3/85 -->
<!-- NE listing suppressed (not used) -->
<!-- .ny0 -->
<refmeta>
<refentrytitle>XEmptyRegion</refentrytitle>
<manvolnum>3X11</manvolnum>
<refmiscinfo class='date'>__xorgversion__</refmiscinfo>
<refmiscinfo class='source'>XLIB FUNCTIONS</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>XEmptyRegion</refname>
<refname>XEqualRegion</refname>
<refname>XPointInRegion</refname>
<refname>XRectInRegion</refname>
<refpurpose>determine if regions are empty or equal</refpurpose>
</refnamediv>
<!-- body begins here -->

<refsect1 id='syntax'><title>SYNTAX</title>

<para>Bool XEmptyRegion&hairsp;(&hairsp;Region <emphasis remap='I'>r</emphasis>&hairsp;);</para> 

<para>Bool XEqualRegion&hairsp;(&hairsp;Region <emphasis remap='I'>r1</emphasis>&hairsp;, Region <emphasis remap='I'>r2</emphasis>&hairsp;);</para> 

<para>Bool XPointInRegion&hairsp;(&hairsp;Region <emphasis remap='I'>r</emphasis>&hairsp;, int <emphasis remap='I'>x</emphasis>&hairsp;, int <emphasis remap='I'>y</emphasis>&hairsp;);</para> 

<para>int XRectInRegion&hairsp;(&hairsp;Region <emphasis remap='I'>r</emphasis>&hairsp;, int <emphasis remap='I'>x</emphasis>&hairsp;, int <emphasis remap='I'>y</emphasis>&hairsp;, unsigned
int <emphasis remap='I'>width</emphasis>&hairsp;, unsigned int <emphasis remap='I'>height</emphasis>&hairsp;);</para> 
</refsect1>

<refsect1 id='arguments'><title>ARGUMENTS</title>
<variablelist remap='IP'>
  <varlistentry>
  <term><emphasis remap='I'>r</emphasis></term>
  <listitem>
<para>Specifies the region.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>r1</emphasis></term>
<!-- .br -->
<!-- .ns -->
  <term><emphasis remap='I'>r2</emphasis></term>
  <listitem>
<para>Specify the two regions.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>width</emphasis></term>
<!-- .br -->
<!-- .ns -->
  <term><emphasis remap='I'>height</emphasis></term>
  <listitem>
<para>Specify the width and height, which define the rectangle.
or the coordinates of the upper-left corner of the rectangle</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>x</emphasis></term>
<!-- .br -->
<!-- .ns -->
  <term><emphasis remap='I'>y</emphasis></term>
  <listitem>
<para>Specify the x and y coordinates, which define the point.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>The
<emphasis remap='I'>&hairsp;XEmptyRegion&hairsp;</emphasis>
function returns
<emphasis remap='I'>&hairsp;True&hairsp;</emphasis>
if the region is empty.</para>

<para>The
<emphasis remap='I'>&hairsp;XEqualRegion&hairsp;</emphasis>
function returns
<emphasis remap='I'>&hairsp;True&hairsp;</emphasis>
if the two regions have the same offset, size, and shape.</para>

<para>The
<emphasis remap='I'>&hairsp;XPointInRegion&hairsp;</emphasis>
function returns 
<emphasis remap='I'>&hairsp;True&hairsp;</emphasis>
if the point (x, y) is contained in the region r.</para>

<para>The
<emphasis remap='I'>&hairsp;XRectInRegion&hairsp;</emphasis>
function returns
<emphasis remap='I'>&hairsp;RectangleIn&hairsp;</emphasis>
if the rectangle is entirely in the specified region,
<emphasis remap='I'>&hairsp;RectangleOut&hairsp;</emphasis>
if the rectangle is entirely out of the specified region,
and
<emphasis remap='I'>&hairsp;RectanglePart&hairsp;</emphasis>
if the rectangle is partially in the specified region.</para>
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para>XCreateRegion(3X11),
XIntersectRegion(3X11)
<!-- .br -->
<userinput>Xlib - C Language X Interface</userinput></para>
</refsect1>
</refentry>

