summaryrefslogtreecommitdiff
path: root/lib/libX11/man/XSetClipOrigin.man
diff options
context:
space:
mode:
authorMatthieu Herrb <matthieu@cvs.openbsd.org>2020-01-04 17:55:18 +0000
committerMatthieu Herrb <matthieu@cvs.openbsd.org>2020-01-04 17:55:18 +0000
commit1128148d76d7952d7aacfa2b083f5b5a96b4b4d5 (patch)
tree9291b9dfdfb4da1828705353be85e340f302e651 /lib/libX11/man/XSetClipOrigin.man
parent7b7fd95cb6ee85ebe6d6d08b126b770770e86688 (diff)
Uppdate to libX11 1.6.9. Tested by krw@ and naddy@
Diffstat (limited to 'lib/libX11/man/XSetClipOrigin.man')
-rw-r--r--lib/libX11/man/XSetClipOrigin.man140
1 files changed, 54 insertions, 86 deletions
diff --git a/lib/libX11/man/XSetClipOrigin.man b/lib/libX11/man/XSetClipOrigin.man
index a227ebc63..207de4cc4 100644
--- a/lib/libX11/man/XSetClipOrigin.man
+++ b/lib/libX11/man/XSetClipOrigin.man
@@ -38,60 +38,27 @@
.\" 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 XSetClipOrigin __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
.SH NAME
XSetClipOrigin, XSetClipMask, XSetClipRectangles \- GC convenience routines
.SH SYNTAX
.HP
int XSetClipOrigin\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, int
-\fIclip_x_origin\fP\^, int \fIclip_y_origin\fP\^);
+\fIclip_x_origin\fP\^, int \fIclip_y_origin\fP\^);
.HP
int XSetClipMask\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, Pixmap
-\fIpixmap\fP\^);
+\fIpixmap\fP\^);
.HP
int XSetClipRectangles\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, int
\fIclip_x_origin\fP\^, int \fIclip_y_origin\fP\^, XRectangle
-\fIrectangles\fP[]\^, int \fIn\fP\^, int \fIordering\fP\^);
+\fIrectangles\fP[]\^, int \fIn\fP\^, int \fIordering\fP\^);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
@@ -103,121 +70,122 @@ Specify the x and y coordinates of the clip-mask origin.
.IP \fIgc\fP 1i
Specifies the GC.
.IP \fIn\fP 1i
-Specifies the number of rectangles.
+Specifies the number of rectangles.
.IP \fIordering\fP 1i
Specifies the ordering relations on the rectangles.
You can pass
-.ZN Unsorted ,
-.ZN YSorted ,
-.ZN YXSorted ,
+.BR Unsorted ,
+.BR YSorted ,
+.BR YXSorted ,
or
-.ZN YXBanded .
+.BR YXBanded .
.IP \fIpixmap\fP 1i
Specifies the pixmap or
-.ZN None .
+.BR None .
.IP \fIrectangles\fP 1i
Specifies an array of rectangles that define the clip-mask.
.SH DESCRIPTION
The
-.ZN XSetClipOrigin
+.B XSetClipOrigin
function sets the clip origin in the specified GC.
The clip-mask origin is interpreted relative to the origin of whatever
destination drawable is specified in the graphics request.
.LP
-.ZN XSetClipOrigin
+.B XSetClipOrigin
can generate
-.ZN BadAlloc
+.B BadAlloc
and
-.ZN BadGC
+.B BadGC
errors.
.LP
The
-.ZN XSetClipMask
+.B XSetClipMask
function sets the clip-mask in the specified GC to the specified pixmap.
If the clip-mask is set to
-.ZN None ,
+.BR None ,
the pixels are are always drawn (regardless of the clip-origin).
.LP
-.ZN XSetClipMask
+.B XSetClipMask
can generate
-.ZN BadAlloc ,
-.ZN BadGC ,
-.ZN BadMatch ,
+.BR BadAlloc ,
+.BR BadGC ,
+.BR BadMatch ,
and
-.ZN BadValue
+.B BadValue
errors.
.LP
The
-.ZN XSetClipRectangles
-function changes the clip-mask in the specified GC
+.B XSetClipRectangles
+function changes the clip-mask in the specified GC
to the specified list of rectangles and sets the clip origin.
The output is clipped to remain contained within the
rectangles.
The clip-origin is interpreted relative to the origin of
-whatever destination drawable is specified in a graphics request.
-The rectangle coordinates are interpreted relative to the clip-origin.
+whatever destination drawable is specified in a graphics request.
+The rectangle coordinates are interpreted relative to the clip-origin.
The rectangles should be nonintersecting, or the graphics results will be
undefined.
-Note that the list of rectangles can be empty,
+Note that the list of rectangles can be empty,
which effectively disables output.
This is the opposite of passing
-.ZN None
+.B None
as the clip-mask in
-.ZN XCreateGC ,
-.ZN XChangeGC ,
+.BR XCreateGC ,
+.BR XChangeGC ,
and
-.ZN XSetClipMask .
+.BR XSetClipMask .
.LP
If known by the client, ordering relations on the rectangles can be
-specified with the ordering argument.
+specified with the ordering argument.
This may provide faster operation
-by the server.
+by the server.
If an incorrect ordering is specified, the X server may generate a
-.ZN BadMatch
+.B BadMatch
error, but it is not required to do so.
If no error is generated, the graphics
results are undefined.
-.ZN Unsorted
+.B Unsorted
means the rectangles are in arbitrary order.
-.ZN YSorted
+.B YSorted
means that the rectangles are nondecreasing in their Y origin.
-.ZN YXSorted
-additionally constrains
-.ZN YSorted
+.B YXSorted
+additionally constrains
+.B YSorted
order in that all
rectangles with an equal Y origin are nondecreasing in their X
-origin.
-.ZN YXBanded
-additionally constrains
-.ZN YXSorted
+origin.
+.B YXBanded
+additionally constrains
+.B YXSorted
by requiring that,
for every possible Y scanline, all rectangles that include that
scanline have an identical Y origins and Y extents.
.LP
-.ZN XSetClipRectangles
+.B XSetClipRectangles
can generate
-.ZN BadAlloc ,
-.ZN BadGC ,
-.ZN BadMatch ,
+.BR BadAlloc ,
+.BR BadGC ,
+.BR BadMatch ,
and
-.ZN BadValue
+.B BadValue
errors.
.SH DIAGNOSTICS
.TP 1i
-.ZN BadAlloc
+.B BadAlloc
The server failed to allocate the requested resource or server memory.
.TP 1i
-.ZN BadGC
+.B BadGC
A value for a GContext argument does not name a defined GContext.
.TP 1i
-.ZN BadMatch
+.B BadMatch
Some argument or pair of arguments has the correct type and range but fails
to match in some other way required by the request.
.TP 1i
-.ZN BadValue
+.B BadValue
Some numeric value falls outside the range of values accepted by the request.
Unless a specific range is specified for an argument, the full range defined
-by the argument's type is accepted. Any argument defined as a set of
+by the argument's type is accepted.
+Any argument defined as a set of
alternatives can generate this error.
.SH "SEE ALSO"
XCreateGC(__libmansuffix__),