From b3462c12542a69eeaa3fe90fddfbb15d30c18158 Mon Sep 17 00:00:00 2001 From: marha Date: Mon, 27 Aug 2012 08:17:50 +0200 Subject: xwininfo fontconfig libX11 libXau libXext libxcb mesa pixman xkeyboard-config git update 27 Aug 2012 --- libX11/man/XSetClipOrigin.man | 527 +++++++++++++++++++----------------------- 1 file changed, 233 insertions(+), 294 deletions(-) (limited to 'libX11/man/XSetClipOrigin.man') diff --git a/libX11/man/XSetClipOrigin.man b/libX11/man/XSetClipOrigin.man index c9d67ac79..a227ebc63 100644 --- a/libX11/man/XSetClipOrigin.man +++ b/libX11/man/XSetClipOrigin.man @@ -1,294 +1,233 @@ -.\" 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. -.\" -.\" -.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 1 -.\".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 FD -.LP -.KS -.TA .5i 3i -.ta .5i 3i -.nf -.. -.de FN -.fi -.KE -.LP -.. -.de IN \" send an index entry to the stderr -.. -.de C{ -.KS -.nf -.D -.\" -.\" choose appropriate monospace font -.\" the imagen conditional, 480, -.\" may be changed to L if LB is too -.\" heavy for your eyes... -.\" -.ie "\\*(.T"480" .ft L -.el .ie "\\*(.T"300" .ft L -.el .ie "\\*(.T"202" .ft PO -.el .ie "\\*(.T"aps" .ft CW -.el .ft R -.ps \\n(PS -.ie \\n(VS>40 .vs \\n(VSu -.el .vs \\n(VSp -.. -.de C} -.DE -.R -.. -.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 -.. -.de NT -.ne 7 -.ds NO Note -.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2 -.if \\n(.$ .if !'\\$1'C' .ds NO \\$1 -.ie n .sp -.el .sp 10p -.TB -.ce -\\*(NO -.ie n .sp -.el .sp 5p -.if '\\$1'C' .ce 99 -.if '\\$2'C' .ce 99 -.in +5n -.ll -5n -.R -.. -. \" Note End -- doug kraft 3/85 -.de NE -.ce 0 -.in -5n -.ll +5n -.ie n .sp -.el .sp 10p -.. -.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\^); -.HP -int XSetClipMask\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, Pixmap -\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\^); -.SH ARGUMENTS -.IP \fIdisplay\fP 1i -Specifies the connection to the X server. -.IP \fIclip_x_origin\fP 1i -.br -.ns -.IP \fIclip_y_origin\fP 1i -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. -.IP \fIordering\fP 1i -Specifies the ordering relations on the rectangles. -You can pass -.ZN Unsorted , -.ZN YSorted , -.ZN YXSorted , -or -.ZN YXBanded . -.IP \fIpixmap\fP 1i -Specifies the pixmap or -.ZN None . -.IP \fIrectangles\fP 1i -Specifies an array of rectangles that define the clip-mask. -.SH DESCRIPTION -The -.ZN 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 -can generate -.ZN BadAlloc -and -.ZN BadGC -errors. -.LP -The -.ZN XSetClipMask -function sets the clip-mask in the specified GC to the specified pixmap. -If the clip-mask is set to -.ZN None , -the pixels are are always drawn (regardless of the clip-origin). -.LP -.ZN XSetClipMask -can generate -.ZN BadAlloc , -.ZN BadGC , -.ZN BadMatch , -and -.ZN BadValue -errors. -.LP -The -.ZN 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. -The rectangles should be nonintersecting, or the graphics results will be -undefined. -Note that the list of rectangles can be empty, -which effectively disables output. -This is the opposite of passing -.ZN None -as the clip-mask in -.ZN XCreateGC , -.ZN XChangeGC , -and -.ZN XSetClipMask . -.LP -If known by the client, ordering relations on the rectangles can be -specified with the ordering argument. -This may provide faster operation -by the server. -If an incorrect ordering is specified, the X server may generate a -.ZN BadMatch -error, but it is not required to do so. -If no error is generated, the graphics -results are undefined. -.ZN Unsorted -means the rectangles are in arbitrary order. -.ZN YSorted -means that the rectangles are nondecreasing in their Y origin. -.ZN YXSorted -additionally constrains -.ZN YSorted -order in that all -rectangles with an equal Y origin are nondecreasing in their X -origin. -.ZN YXBanded -additionally constrains -.ZN 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 -can generate -.ZN BadAlloc , -.ZN BadGC , -.ZN BadMatch , -and -.ZN BadValue -errors. -.SH DIAGNOSTICS -.TP 1i -.ZN BadAlloc -The server failed to allocate the requested resource or server memory. -.TP 1i -.ZN BadGC -A value for a GContext argument does not name a defined GContext. -.TP 1i -.ZN 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 -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 -alternatives can generate this error. -.SH "SEE ALSO" -XCreateGC(__libmansuffix__), -XDrawRectangle(__libmansuffix__), -XQueryBestSize(__libmansuffix__), -XSetArcMode(__libmansuffix__), -XSetFillStyle(__libmansuffix__), -XSetFont(__libmansuffix__), -XSetLineAttributes(__libmansuffix__), -XSetState(__libmansuffix__), -XSetTile(__libmansuffix__) -.br -\fI\*(xL\fP +.\" 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. +.\" +.\" +.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\^); +.HP +int XSetClipMask\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, Pixmap +\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\^); +.SH ARGUMENTS +.IP \fIdisplay\fP 1i +Specifies the connection to the X server. +.IP \fIclip_x_origin\fP 1i +.br +.ns +.IP \fIclip_y_origin\fP 1i +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. +.IP \fIordering\fP 1i +Specifies the ordering relations on the rectangles. +You can pass +.ZN Unsorted , +.ZN YSorted , +.ZN YXSorted , +or +.ZN YXBanded . +.IP \fIpixmap\fP 1i +Specifies the pixmap or +.ZN None . +.IP \fIrectangles\fP 1i +Specifies an array of rectangles that define the clip-mask. +.SH DESCRIPTION +The +.ZN 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 +can generate +.ZN BadAlloc +and +.ZN BadGC +errors. +.LP +The +.ZN XSetClipMask +function sets the clip-mask in the specified GC to the specified pixmap. +If the clip-mask is set to +.ZN None , +the pixels are are always drawn (regardless of the clip-origin). +.LP +.ZN XSetClipMask +can generate +.ZN BadAlloc , +.ZN BadGC , +.ZN BadMatch , +and +.ZN BadValue +errors. +.LP +The +.ZN 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. +The rectangles should be nonintersecting, or the graphics results will be +undefined. +Note that the list of rectangles can be empty, +which effectively disables output. +This is the opposite of passing +.ZN None +as the clip-mask in +.ZN XCreateGC , +.ZN XChangeGC , +and +.ZN XSetClipMask . +.LP +If known by the client, ordering relations on the rectangles can be +specified with the ordering argument. +This may provide faster operation +by the server. +If an incorrect ordering is specified, the X server may generate a +.ZN BadMatch +error, but it is not required to do so. +If no error is generated, the graphics +results are undefined. +.ZN Unsorted +means the rectangles are in arbitrary order. +.ZN YSorted +means that the rectangles are nondecreasing in their Y origin. +.ZN YXSorted +additionally constrains +.ZN YSorted +order in that all +rectangles with an equal Y origin are nondecreasing in their X +origin. +.ZN YXBanded +additionally constrains +.ZN 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 +can generate +.ZN BadAlloc , +.ZN BadGC , +.ZN BadMatch , +and +.ZN BadValue +errors. +.SH DIAGNOSTICS +.TP 1i +.ZN BadAlloc +The server failed to allocate the requested resource or server memory. +.TP 1i +.ZN BadGC +A value for a GContext argument does not name a defined GContext. +.TP 1i +.ZN 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 +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 +alternatives can generate this error. +.SH "SEE ALSO" +XCreateGC(__libmansuffix__), +XDrawRectangle(__libmansuffix__), +XQueryBestSize(__libmansuffix__), +XSetArcMode(__libmansuffix__), +XSetFillStyle(__libmansuffix__), +XSetFont(__libmansuffix__), +XSetLineAttributes(__libmansuffix__), +XSetState(__libmansuffix__), +XSetTile(__libmansuffix__) +.br +\fI\*(xL\fP -- cgit v1.2.3