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.


XDrawRectangle __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
NAME
XDrawRectangle, XDrawRectangles, XRectangle - draw rectangles and rectangles structure
SYNTAX

int XDrawRectangle\^(\^Display *display\^, Drawable d\^, GC gc\^, int x\^, int y\^, unsigned int width\^, unsigned int height\^);

int XDrawRectangles\^(\^Display *display\^, Drawable d\^, GC gc\^, XRectangle rectangles\^[\^]\^, int nrectangles\^);

ARGUMENTS
d 1i
Specifies the drawable.
display 1i
Specifies the connection to the X server.
gc 1i
Specifies the GC.
nrectangles 1i
Specifies the number of rectangles in the array.
rectangles 1i
Specifies an array of rectangles.
width 1i

.ns

height 1i
Specify the width and height, which specify the dimensions of the rectangle.
x 1i

.ns

y 1i
Specify the x and y coordinates, which specify the upper-left corner of the rectangle.
DESCRIPTION
The XDrawRectangle and XDrawRectangles functions draw the outlines of the specified rectangle or rectangles as if a five-point PolyLine protocol request were specified for each rectangle:
[x,y] [x+width,y] [x+width,y+height] [x,y+height] [x,y]

For the specified rectangle or rectangles, these functions do not draw a pixel more than once. XDrawRectangles draws the rectangles in the order listed in the array. If rectangles intersect, the intersecting pixels are drawn multiple times.

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.

XDrawRectangle and XDrawRectangles can generate BadDrawable , BadGC , and BadMatch errors.

STRUCTURES
The XRectangle structure contains:

.EX typedef struct { short x, y; unsigned short width, height; } XRectangle;

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.

DIAGNOSTICS

1i BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap.

1i BadGC A value for a GContext argument does not name a defined GContext.

1i BadMatch An InputOnly window is used as a Drawable.

1i 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.

"SEE ALSO"
XDrawArc(__libmansuffix__), XDrawLine(__libmansuffix__), XDrawPoint(__libmansuffix__)

\*(xL