XPointInRegion (3)

Leading comments

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 foll...

(The comments found at the beginning of the groff file "man3/XPointInRegion.3".)

NAME

XEmptyRegion, XEqualRegion, XPointInRegion, XRectInRegion - determine if regions are empty or equal

SYNTAX

Bool XEmptyRegion(Region r);

Bool XEqualRegion(Region r1, Region r2);

Bool XPointInRegion(Region r, int x, int y);

int XRectInRegion(Region r, int x, int y, unsigned int width, unsigned int height);

ARGUMENTS

r

Specifies the region.

r1

r2

Specify the two regions.

width

height

Specify the width and height, which define the rectangle.

x

y

Specify the x and y coordinates, which define the point or the coordinates of the upper-left corner of the rectangle.

DESCRIPTION

The XEmptyRegion function returns True if the region is empty.

The XEqualRegion function returns True if the two regions have the same offset, size, and shape.

The XPointInRegion function returns True if the point (x, y) is contained in the region r.

The XRectInRegion function returns RectangleIn if the rectangle is entirely in the specified region, RectangleOut if the rectangle is entirely out of the specified region, and RectanglePart if the rectangle is partially in the specified region.

SEE ALSO

XCreateRegion(3), XIntersectRegion(3)
Xlib - C Language X Interface