summaryrefslogtreecommitdiff
path: root/lib/libX11/man/XEmptyRegion.man
diff options
context:
space:
mode:
Diffstat (limited to 'lib/libX11/man/XEmptyRegion.man')
-rw-r--r--lib/libX11/man/XEmptyRegion.man77
1 files changed, 22 insertions, 55 deletions
diff --git a/lib/libX11/man/XEmptyRegion.man b/lib/libX11/man/XEmptyRegion.man
index b87687f9b..b00961447 100644
--- a/lib/libX11/man/XEmptyRegion.man
+++ b/lib/libX11/man/XEmptyRegion.man
@@ -38,59 +38,26 @@
.\" 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.
-.\"
+.\" It is provided "as is" without express or implied warranty.
+.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
.ds xL Xlib \- C Language X Interface
.ds xC Inter-Client Communication Conventions Manual
-.na
-.de Ds
-.nf
-.\\$1D \\$2 \\$1
-.ft CW
-.\".ps \\n(PS
-.\".if \\n(VS>=40 .vs \\n(VSu
-.\".if \\n(VS<=39 .vs \\n(VSp
-..
-.de De
-.ce 0
-.if \\n(BD .DF
-.nr BD 0
-.in \\n(OIu
-.if \\n(TM .ls 2
-.sp \\n(DDu
-.fi
-..
-.de IN \" send an index entry to the stderr
-..
-.de Pn
-.ie t \\$1\fB\^\\$2\^\fR\\$3
-.el \\$1\fI\^\\$2\^\fP\\$3
-..
-.de ZN
-.ie t \fB\^\\$1\^\fR\\$2
-.el \fI\^\\$1\^\fP\\$2
-..
-.de hN
-.ie t <\fB\\$1\fR>\\$2
-.el <\fI\\$1\fP>\\$2
-..
-.ny0
.TH XEmptyRegion __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
.SH NAME
XEmptyRegion, XEqualRegion, XPointInRegion, XRectInRegion \- determine if regions are empty or equal
.SH SYNTAX
.HP
-Bool XEmptyRegion\^(\^Region \fIr\fP\^);
+Bool XEmptyRegion\^(\^Region \fIr\fP\^);
.HP
-Bool XEqualRegion\^(\^Region \fIr1\fP\^, Region \fIr2\fP\^);
+Bool XEqualRegion\^(\^Region \fIr1\fP\^, Region \fIr2\fP\^);
.HP
-Bool XPointInRegion\^(\^Region \fIr\fP\^, int \fIx\fP\^, int \fIy\fP\^);
+Bool XPointInRegion\^(\^Region \fIr\fP\^, int \fIx\fP\^, int \fIy\fP\^);
.HP
int XRectInRegion\^(\^Region \fIr\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned
-int \fIwidth\fP\^, unsigned int \fIheight\fP\^);
+int \fIwidth\fP\^, unsigned int \fIheight\fP\^);
.SH ARGUMENTS
.IP \fIr\fP 1i
Specifies the region.
@@ -99,47 +66,47 @@ Specifies the region.
.ns
.IP \fIr2\fP 1i
Specify the two regions.
-.ds Wh , which define the rectangle
+.ds Wh
.IP \fIwidth\fP 1i
.br
.ns
.IP \fIheight\fP 1i
-Specify the width and height\*(Wh.
-.ds Xy , which define the point \
-or the coordinates of the upper-left corner of the rectangle
+Specify the width and height, which define the rectangle.
+.ds Xy
.IP \fIx\fP 1i
.br
.ns
.IP \fIy\fP 1i
-Specify the x and y coordinates\*(Xy.
+Specify the x and y coordinates, which define the point
+or the coordinates of the upper-left corner of the rectangle.
.SH DESCRIPTION
The
-.ZN XEmptyRegion
+.B XEmptyRegion
function returns
-.ZN True
+.B True
if the region is empty.
.LP
The
-.ZN XEqualRegion
+.B XEqualRegion
function returns
-.ZN True
+.B True
if the two regions have the same offset, size, and shape.
.LP
The
-.ZN XPointInRegion
-function returns
-.ZN True
+.B XPointInRegion
+function returns
+.B True
if the point (x, y) is contained in the region r.
.LP
The
-.ZN XRectInRegion
+.B XRectInRegion
function returns
-.ZN RectangleIn
+.B RectangleIn
if the rectangle is entirely in the specified region,
-.ZN RectangleOut
+.B RectangleOut
if the rectangle is entirely out of the specified region,
and
-.ZN RectanglePart
+.B RectanglePart
if the rectangle is partially in the specified region.
.SH "SEE ALSO"
XCreateRegion(__libmansuffix__),