man/XFillRectangle.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 XFillRectangle __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XFillRectangle, XFillRectangles, XFillPolygon, XFillArc, XFillArcs \- fill rectangles, polygons, or arcs
 145 .SH SYNTAX
 146 .HP
 147 int XFillRectangle\^(\^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 XFillRectangles\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
 152 \fIgc\fP\^, XRectangle *\fIrectangles\fP\^, int \fInrectangles\fP\^);
 153 .HP
 154 int XFillPolygon\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC
 155 \fIgc\fP\^, XPoint *\fIpoints\fP\^, int \fInpoints\fP\^, int \fIshape\fP\^,
 156 int \fImode\fP\^);
 157 .HP
 158 int XFillArc\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^,
 159 int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int
 160 \fIheight\fP\^, int \fIangle1\fP\^, int \fIangle2\fP\^);
 161 .HP
 162 int XFillArcs\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^, GC \fIgc\fP\^,
 163 XArc *\fIarcs\fP\^, int \fInarcs\fP\^);
 164 .SH ARGUMENTS
 165 .IP \fIangle1\fP 1i
 166 Specifies the start of the arc relative to the three-o'clock position
 167 from the center, in units of degrees * 64.
 168 .IP \fIangle2\fP 1i
 169 Specifies the path and extent of the arc relative to the start of the
 170 arc, in units of degrees * 64.
 171 .IP \fIarcs\fP 1i
 172 Specifies an array of arcs.
 173 .IP \fId\fP 1i
 174 Specifies the drawable.
 175 .IP \fIdisplay\fP 1i
 176 Specifies the connection to the X server.
 177 .IP \fIgc\fP 1i
 178 Specifies the GC.
 179 .IP \fImode\fP 1i
 180 Specifies the coordinate mode.
 181 You can pass
 182 .ZN CoordModeOrigin
 183 or
 184 .ZN CoordModePrevious .
 185 .IP \fInarcs\fP 1i
 186 Specifies the number of arcs in the array.
 187 .IP \fInpoints\fP 1i
 188 Specifies the number of points in the array.
 189 .IP \fInrectangles\fP 1i
 190 Specifies the number of rectangles in the array.
 191 .IP \fIpoints\fP 1i
 192 Specifies an array of points.
 193 .IP \fIrectangles\fP 1i
 194 Specifies an array of rectangles.
 195 .IP \fIshape\fP 1i
 196 Specifies a shape that helps the server to improve performance.
 197 You can pass
 198 .ZN Complex ,
 199 .ZN Convex ,
 200 or
 201 .ZN Nonconvex .
 202 .ds Wh , which are the dimensions of the rectangle to be filled \
 203 or the major and minor axes of the arc
 204 .IP \fIwidth\fP 1i
 205 .br
 206 .ns
 207 .IP \fIheight\fP 1i
 208 Specify the width and height\*(Wh.
 209 .ds Xy , which are relative to the origin of the drawable \
 210 and specify the upper-left corner of the rectangle
 211 .IP \fIx\fP 1i
 212 .br
 213 .ns
 214 .IP \fIy\fP 1i
 215 Specify the x and y coordinates\*(Xy.
 216 .SH DESCRIPTION
 217 The
 218 .ZN XFillRectangle
 219 and
 220 .ZN XFillRectangles
 221 functions fill the specified rectangle or rectangles
 222 as if a four-point
 223 .ZN FillPolygon
 224 protocol request were specified for each rectangle:
 225 .LP
 226 .Ds
 227 [x,y] [x+width,y] [x+width,y+height] [x,y+height]
 228 .De
 229 .LP
 230 Each function uses the x and y coordinates,
 231 width and height dimensions, and GC you specify.
 232 .LP
 233 .ZN XFillRectangles
 234 fills the rectangles in the order listed in the array.
 235 For any given rectangle,
 236 .ZN XFillRectangle
 237 and
 238 .ZN XFillRectangles
 239 do not draw a pixel more than once.
 240 If rectangles intersect, the intersecting pixels are
 241 drawn multiple times.
 242 .LP
 243 Both functions use these GC components:
 244 function, plane-mask, fill-style, subwindow-mode,
 245 clip-x-origin, clip-y-origin, and clip-mask.
 246 They also use these GC mode-dependent components:
 247 foreground, background, tile, stipple, tile-stipple-x-origin,
 248 and tile-stipple-y-origin.
 249 .LP
 250 .ZN XFillRectangle
 251 and
 252 .ZN XFillRectangles
 253 can generate
 254 .ZN BadDrawable ,
 255 .ZN BadGC ,
 256 and
 257 .ZN BadMatch
 258 errors.
 259 .LP
 260 .ZN XFillPolygon
 261 fills the region closed by the specified path.
 262 The path is closed
 263 automatically if the last point in the list does not coincide with the
 264 first point.
 265 .ZN XFillPolygon
 266 does not draw a pixel of the region more than once.
 267 .ZN CoordModeOrigin
 268 treats all coordinates as relative to the origin,
 269 and
 270 .ZN CoordModePrevious
 271 treats all coordinates after the first as relative to the previous point.
 272 .LP
 273 Depending on the specified shape, the following occurs:
 274 .IP \(bu 5
 275 If shape is
 276 .ZN Complex ,
 277 the path may self-intersect.
 278 Note that contiguous coincident points in the path are not treated
 279 as self-intersection.
 280 .IP \(bu 5
 281 If shape is
 282 .ZN Convex ,
 283 for every pair of points inside the polygon,
 284 the line segment connecting them does not intersect the path.
 285 If known by the client,
 286 specifying
 287 .ZN Convex
 288 can improve performance.
 289 If you specify
 290 .ZN Convex
 291 for a path that is not convex,
 292 the graphics results are undefined.
 293 .IP \(bu 5
 294 If shape is
 295 .ZN Nonconvex ,
 296 the path does not self-intersect, but the shape is not
 297 wholly convex.
 298 If known by the client,
 299 specifying
 300 .ZN Nonconvex
 301 instead of
 302 .ZN Complex
 303 may improve performance.
 304 If you specify
 305 .ZN Nonconvex
 306 for a self-intersecting path, the graphics results are undefined.
 307 .LP
 308 The fill-rule of the GC controls the filling behavior of
 309 self-intersecting polygons.
 310 .LP
 311 This function uses these GC components:
 312 function, plane-mask, fill-style, fill-rule, subwindow-mode, clip-x-origin,
 313 clip-y-origin, and clip-mask.
 314 It also uses these GC mode-dependent components:
 315 foreground, background, tile, stipple, tile-stipple-x-origin,
 316 and tile-stipple-y-origin.
 317 .LP
 318 .ZN XFillPolygon
 319 can generate
 320 .ZN BadDrawable ,
 321 .ZN BadGC ,
 322 .ZN BadMatch ,
 323 and
 324 .ZN BadValue
 325 errors.
 326 .LP
 327 For each arc,
 328 .ZN XFillArc
 329 or
 330 .ZN XFillArcs
 331 fills the region closed by the infinitely thin path
 332 described by the specified arc and, depending on the
 333 arc-mode specified in the GC, one or two line segments.
 334 For
 335 .ZN ArcChord ,
 336 the single line segment joining the endpoints of the arc is used.
 337 For
 338 .ZN ArcPieSlice ,
 339 the two line segments joining the endpoints of the arc with the center
 340 point are used.
 341 .ZN XFillArcs
 342 fills the arcs in the order listed in the array.
 343 For any given arc,
 344 .ZN XFillArc
 345 and
 346 .ZN XFillArcs
 347 do not draw a pixel more than once.
 348 If regions intersect,
 349 the intersecting pixels are drawn multiple times.
 350 .LP
 351 Both functions use these GC components:
 352 function, plane-mask, fill-style, arc-mode, subwindow-mode, clip-x-origin,
 353 clip-y-origin, and clip-mask.
 354 They also use these GC mode-dependent components:
 355 foreground, background, tile, stipple, tile-stipple-x-origin,
 356 and tile-stipple-y-origin.
 357 .LP
 358 .ZN XFillArc
 359 and
 360 .ZN XFillArcs
 361 can generate
 362 .ZN BadDrawable ,
 363 .ZN BadGC ,
 364 and
 365 .ZN BadMatch
 366 errors.
 367 .SH DIAGNOSTICS
 368 .TP 1i
 369 .ZN BadDrawable
 370 A value for a Drawable argument does not name a defined Window or Pixmap.
 371 .TP 1i
 372 .ZN BadGC
 373 A value for a GContext argument does not name a defined GContext.
 374 .TP 1i
 375 .ZN BadMatch
 376 An
 377 .ZN InputOnly
 378 window is used as a Drawable.
 379 .TP 1i
 380 .ZN BadMatch
 381 Some argument or pair of arguments has the correct type and range but fails
 382 to match in some other way required by the request.
 383 .TP 1i
 384 .ZN BadValue
 385 Some numeric value falls outside the range of values accepted by the request.
 386 Unless a specific range is specified for an argument, the full range defined
 387 by the argument's type is accepted.  Any argument defined as a set of
 388 alternatives can generate this error.
 389 .SH "SEE ALSO"
 390 XDrawArc(__libmansuffix__),
 391 XDrawPoint(__libmansuffix__),
 392 XDrawRectangle(__libmansuffix__)
 393 .br
 394 \fI\*(xL\fP