man/XDrawRectangle.man

   1 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining
   4 .\" a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, sublicense, and/or sell copies of the Software, and to
   8 .\" permit persons to whom the Software is furnished to do so, subject to
   9 .\" the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice shall be included
  12 .\" in all copies or substantial portions of the Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20 .\" OTHER DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .\" Except as contained in this notice, the name of the X Consortium shall
  23 .\" not be used in advertising or otherwise to promote the sale, use or
  24 .\" other dealings in this Software without prior written authorization
  25 .\" from the X Consortium.
  26 .\"
  27 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
  28 .\" Digital Equipment Corporation
  29 .\"
  30 .\" Portions Copyright \(co 1990, 1991 by
  31 .\" Tektronix, Inc.
  32 .\"
  33 .\" Permission to use, copy, modify and distribute this documentation for
  34 .\" any purpose and without fee is hereby granted, provided that the above
  35 .\" copyright notice appears in all copies and that both that copyright notice
  36 .\" and this permission notice appear in all copies, and that the names of
  37 .\" Digital and Tektronix not be used in in advertising or publicity pertaining
  38 .\" to this documentation without specific, written prior permission.
  39 .\" Digital and Tektronix makes no representations about the suitability
  40 .\" of this documentation for any purpose.
  41 .\" It is provided ``as is'' without express or implied warranty.
  42 .\"
  43 .\"
  44 .ds xT X Toolkit Intrinsics \- C Language Interface
  45 .ds xW Athena X Widgets \- C Language X Toolkit Interface
  46 .ds xL Xlib \- C Language X Interface
  47 .ds xC Inter-Client Communication Conventions Manual
  48 .na
  49 .de Ds
  50 .nf
  51 .\\$1D \\$2 \\$1
  52 .ft 1
  53 .\".ps \\n(PS
  54 .\".if \\n(VS>=40 .vs \\n(VSu
  55 .\".if \\n(VS<=39 .vs \\n(VSp
  56 ..
  57 .de De
  58 .ce 0
  59 .if \\n(BD .DF
  60 .nr BD 0
  61 .in \\n(OIu
  62 .if \\n(TM .ls 2
  63 .sp \\n(DDu
  64 .fi
  65 ..
  66 .de FD
  67 .LP
  68 .KS
  69 .TA .5i 3i
  70 .ta .5i 3i
  71 .nf
  72 ..
  73 .de FN
  74 .fi
  75 .KE
  76 .LP
  77 ..
  78 .de IN          \" send an index entry to the stderr
  79 ..
  80 .de C{
  81 .KS
  82 .nf
  83 .D
  84 .\"
  85 .\"     choose appropriate monospace font
  86 .\"     the imagen conditional, 480,
  87 .\"     may be changed to L if LB is too
  88 .\"     heavy for your eyes...
  89 .\"
  90 .ie "\\*(.T"480" .ft L
  91 .el .ie "\\*(.T"300" .ft L
  92 .el .ie "\\*(.T"202" .ft PO
  93 .el .ie "\\*(.T"aps" .ft CW
  94 .el .ft R
  95 .ps \\n(PS
  96 .ie \\n(VS>40 .vs \\n(VSu
  97 .el .vs \\n(VSp
  98 ..
  99 .de C}
 100 .DE
 101 .R
 102 ..
 103 .de Pn
 104 .ie t \\$1\fB\^\\$2\^\fR\\$3
 105 .el \\$1\fI\^\\$2\^\fP\\$3
 106 ..
 107 .de ZN
 108 .ie t \fB\^\\$1\^\fR\\$2
 109 .el \fI\^\\$1\^\fP\\$2
 110 ..
 111 .de hN
 112 .ie t <\fB\\$1\fR>\\$2
 113 .el <\fI\\$1\fP>\\$2
 114 ..
 115 .de NT
 116 .ne 7
 117 .ds NO Note
 118 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 119 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 120 .ie n .sp
 121 .el .sp 10p
 122 .TB
 123 .ce
 124 \\*(NO
 125 .ie n .sp
 126 .el .sp 5p
 127 .if '\\$1'C' .ce 99
 128 .if '\\$2'C' .ce 99
 129 .in +5n
 130 .ll -5n
 131 .R
 132 ..
 133 .               \" Note End -- doug kraft 3/85
 134 .de NE
 135 .ce 0
 136 .in -5n
 137 .ll +5n
 138 .ie n .sp
 139 .el .sp 10p
 140 ..
 141 .ny0
 142 .TH XDrawRectangle __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XDrawRectangle, XDrawRectangles, XRectangle \- draw rectangles and rectangles structure
 145 .SH SYNTAX
 146 .HP
 147 int XDrawRectangle\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
 148 \fIgc\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned
 149 int \fIheight\fP\^);
 150 .HP
 151 int XDrawRectangles\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
 152 \fIgc\fP\^, XRectangle \fIrectangles\fP\^[\^]\^, int \fInrectangles\fP\^);
 153 .SH ARGUMENTS
 154 .IP \fId\fP 1i
 155 Specifies the drawable.
 156 .IP \fIdisplay\fP 1i
 157 Specifies the connection to the X server.
 158 .IP \fIgc\fP 1i
 159 Specifies the GC.
 160 .IP \fInrectangles\fP 1i
 161 Specifies the number of rectangles in the array.
 162 .IP \fIrectangles\fP 1i
 163 Specifies an array of rectangles.
 164 .ds Wh , which specify the dimensions of the rectangle
 165 .IP \fIwidth\fP 1i
 166 .br
 167 .ns
 168 .IP \fIheight\fP 1i
 169 Specify the width and height\*(Wh.
 170 .ds Xy , which specify the upper-left corner of the rectangle
 171 .IP \fIx\fP 1i
 172 .br
 173 .ns
 174 .IP \fIy\fP 1i
 175 Specify the x and y coordinates\*(Xy.
 176 .SH DESCRIPTION
 177 The
 178 .ZN XDrawRectangle
 179 and
 180 .ZN XDrawRectangles
 181 functions draw the outlines of the specified rectangle or rectangles as
 182 if a five-point
 183 .ZN PolyLine
 184 protocol request were specified for each rectangle:
 185 .IP
 186 [x,y] [x+width,y] [x+width,y+height] [x,y+height] [x,y]
 187 .LP
 188 For the specified rectangle or rectangles,
 189 these functions do not draw a pixel more than once.
 190 .ZN XDrawRectangles
 191 draws the rectangles in the order listed in the array.
 192 If rectangles intersect,
 193 the intersecting pixels are drawn multiple times.
 194 .LP
 195 Both functions use these GC components:
 196 function, plane-mask, line-width,
 197 line-style, cap-style, join-style, fill-style,
 198 subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask.
 199 They also use these GC mode-dependent components:
 200 foreground, background, tile, stipple, tile-stipple-x-origin,
 201 tile-stipple-y-origin, dash-offset, and dash-list.
 202 .LP
 203 .ZN XDrawRectangle
 204 and
 205 .ZN XDrawRectangles
 206 can generate
 207 .ZN BadDrawable ,
 208 .ZN BadGC ,
 209 and
 210 .ZN BadMatch
 211 errors.
 212 .SH STRUCTURES
 213 The
 214 .ZN XRectangle
 215 structure contains:
 216 .LP
 217 .Ds 0
 218 .TA .5i
 219 .ta .5i
 220 typedef struct {
 221         short x, y;
 222         unsigned short width, height;
 223 } XRectangle;
 224 .De
 225 .LP
 226 All x and y members are signed integers.
 227 The width and height members are 16-bit unsigned integers.
 228 You should be careful not to generate coordinates and sizes
 229 out of the 16-bit ranges, because the protocol only has 16-bit fields
 230 for these values.
 231 .SH DIAGNOSTICS
 232 .TP 1i
 233 .ZN BadDrawable
 234 A value for a Drawable argument does not name a defined Window or Pixmap.
 235 .TP 1i
 236 .ZN BadGC
 237 A value for a GContext argument does not name a defined GContext.
 238 .TP 1i
 239 .ZN BadMatch
 240 An
 241 .ZN InputOnly
 242 window is used as a Drawable.
 243 .TP 1i
 244 .ZN BadMatch
 245 Some argument or pair of arguments has the correct type and range but fails
 246 to match in some other way required by the request.
 247 .SH "SEE ALSO"
 248 XDrawArc(__libmansuffix__),
 249 XDrawLine(__libmansuffix__),
 250 XDrawPoint(__libmansuffix__)
 251 .br
 252 \fI\*(xL\fP