2006-11-25 09:33:55 -07:00
|
|
|
.\" 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
|
2013-04-28 10:55:55 -06:00
|
|
|
.ft CW
|
2006-11-25 09:33:55 -07:00
|
|
|
.\".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 XDrawRectangle __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
|
|
|
|
|
.SH NAME
|
|
|
|
|
XDrawRectangle, XDrawRectangles, XRectangle \- draw rectangles and rectangles structure
|
|
|
|
|
.SH SYNTAX
|
|
|
|
|
.HP
|
|
|
|
|
int XDrawRectangle\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
|
|
|
|
|
\fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned
|
|
|
|
|
int \fIheight\fP\^);
|
|
|
|
|
.HP
|
|
|
|
|
int XDrawRectangles\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
|
|
|
|
|
\fIgc\fP\^, XRectangle \fIrectangles\fP\^[\^]\^, int \fInrectangles\fP\^);
|
|
|
|
|
.SH ARGUMENTS
|
|
|
|
|
.IP \fId\fP 1i
|
|
|
|
|
Specifies the drawable.
|
|
|
|
|
.IP \fIdisplay\fP 1i
|
|
|
|
|
Specifies the connection to the X server.
|
|
|
|
|
.IP \fIgc\fP 1i
|
|
|
|
|
Specifies the GC.
|
|
|
|
|
.IP \fInrectangles\fP 1i
|
|
|
|
|
Specifies the number of rectangles in the array.
|
|
|
|
|
.IP \fIrectangles\fP 1i
|
|
|
|
|
Specifies an array of rectangles.
|
|
|
|
|
.ds Wh , which specify the dimensions of the rectangle
|
|
|
|
|
.IP \fIwidth\fP 1i
|
|
|
|
|
.br
|
|
|
|
|
.ns
|
|
|
|
|
.IP \fIheight\fP 1i
|
|
|
|
|
Specify the width and height\*(Wh.
|
|
|
|
|
.ds Xy , which specify the upper-left corner of the rectangle
|
|
|
|
|
.IP \fIx\fP 1i
|
|
|
|
|
.br
|
|
|
|
|
.ns
|
|
|
|
|
.IP \fIy\fP 1i
|
|
|
|
|
Specify the x and y coordinates\*(Xy.
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.ZN XDrawRectangle
|
|
|
|
|
and
|
|
|
|
|
.ZN XDrawRectangles
|
|
|
|
|
functions draw the outlines of the specified rectangle or rectangles as
|
|
|
|
|
if a five-point
|
|
|
|
|
.ZN PolyLine
|
|
|
|
|
protocol request were specified for each rectangle:
|
|
|
|
|
.IP
|
|
|
|
|
[x,y] [x+width,y] [x+width,y+height] [x,y+height] [x,y]
|
|
|
|
|
.LP
|
|
|
|
|
For the specified rectangle or rectangles,
|
|
|
|
|
these functions do not draw a pixel more than once.
|
|
|
|
|
.ZN XDrawRectangles
|
|
|
|
|
draws the rectangles in the order listed in the array.
|
|
|
|
|
If rectangles intersect,
|
|
|
|
|
the intersecting pixels are drawn multiple times.
|
|
|
|
|
.LP
|
|
|
|
|
Both functions use these GC components:
|
|
|
|
|
function, plane-mask, line-width,
|
|
|
|
|
line-style, cap-style, join-style, fill-style,
|
|
|
|
|
subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask.
|
|
|
|
|
They also use these GC mode-dependent components:
|
|
|
|
|
foreground, background, tile, stipple, tile-stipple-x-origin,
|
|
|
|
|
tile-stipple-y-origin, dash-offset, and dash-list.
|
|
|
|
|
.LP
|
|
|
|
|
.ZN XDrawRectangle
|
|
|
|
|
and
|
|
|
|
|
.ZN XDrawRectangles
|
|
|
|
|
can generate
|
|
|
|
|
.ZN BadDrawable ,
|
|
|
|
|
.ZN BadGC ,
|
|
|
|
|
and
|
|
|
|
|
.ZN BadMatch
|
|
|
|
|
errors.
|
|
|
|
|
.SH STRUCTURES
|
|
|
|
|
The
|
|
|
|
|
.ZN XRectangle
|
|
|
|
|
structure contains:
|
|
|
|
|
.LP
|
|
|
|
|
.Ds 0
|
|
|
|
|
typedef struct {
|
2013-04-28 10:55:55 -06:00
|
|
|
short x, y;
|
|
|
|
|
unsigned short width, height;
|
2006-11-25 09:33:55 -07:00
|
|
|
} XRectangle;
|
|
|
|
|
.De
|
|
|
|
|
.LP
|
|
|
|
|
All x and y members are signed integers.
|
|
|
|
|
The width and height members are 16-bit unsigned integers.
|
|
|
|
|
You should be careful not to generate coordinates and sizes
|
|
|
|
|
out of the 16-bit ranges, because the protocol only has 16-bit fields
|
|
|
|
|
for these values.
|
|
|
|
|
.SH DIAGNOSTICS
|
|
|
|
|
.TP 1i
|
|
|
|
|
.ZN BadDrawable
|
|
|
|
|
A value for a Drawable argument does not name a defined Window or Pixmap.
|
|
|
|
|
.TP 1i
|
|
|
|
|
.ZN BadGC
|
|
|
|
|
A value for a GContext argument does not name a defined GContext.
|
|
|
|
|
.TP 1i
|
|
|
|
|
.ZN BadMatch
|
|
|
|
|
An
|
|
|
|
|
.ZN InputOnly
|
|
|
|
|
window is used as a Drawable.
|
|
|
|
|
.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.
|
|
|
|
|
.SH "SEE ALSO"
|
2010-05-18 13:37:28 -06:00
|
|
|
XDrawArc(__libmansuffix__),
|
|
|
|
|
XDrawLine(__libmansuffix__),
|
|
|
|
|
XDrawPoint(__libmansuffix__)
|
2006-11-25 09:33:55 -07:00
|
|
|
.br
|
|
|
|
|
\fI\*(xL\fP
|
