man/XIntersectRegion.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 XIntersectRegion __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XIntersectRegion, XUnionRegion, XUnionRectWithRegion, XSubtractRegion, XXorRegion, XOffsetRegion, XShrinkRegion \- region arithmetic
 145 .SH SYNTAX
 146 .HP
 147 int XIntersectRegion\^(\^Region \fIsra\fP\^, Region \fIsrb\fP\^, Region
 148 \fIdr_return\fP\^);
 149 .HP
 150 int XUnionRegion\^(\^Region \fIsra\fP\^, Region \fIsrb\fP\^, Region
 151 \fIdr_return\fP\^);
 152 .HP
 153 int XUnionRectWithRegion\^(\^XRectangle *\fIrectangle\fP\^, Region
 154 \fIsrc_region\fP\^, Region \fIdest_region_return\fP\^);
 155 .HP
 156 int XSubtractRegion\^(\^Region \fIsra\fP\^, Region \fIsrb\fP\^, Region
 157 \fIdr_return\fP\^);
 158 .HP
 159 int XXorRegion\^(\^Region \fIsra\fP\^, Region \fIsrb\fP\^, Region
 160 \fIdr_return\fP\^);
 161 .HP
 162 int XOffsetRegion\^(\^Region \fIr\fP\^, int \fIdx\fP\^, int \fIdy\fP\^);
 163 .HP
 164 int XShrinkRegion\^(\^Region \fIr\fP\^, int \fIdx\fP\^, int \fIdy\fP\^);
 165 .SH ARGUMENTS
 166 .IP \fIdest_region_return\fP 1i
 167 Returns the destination region.
 168 .IP \fIdr_return\fP 1i
 169 Returns the result of the computation.
 170 ds Dy move or shrink
 171 .IP \fIdx\fP 1i
 172 .br
 173 .ns
 174 .IP \fIdy\fP 1i
 175 Specify the x and y coordinates,
 176 which define the amount you want to \*(Dy the specified region.
 177 .IP \fIr\fP 1i
 178 Specifies the region.
 179 .IP \fIrectangle\fP 1i
 180 Specifies the rectangle.
 181 .IP \fIsra\fP 1i
 182 .br
 183 .ns
 184 .IP \fIsrb\fP 1i
 185 Specify the two regions with which you want to perform the computation.
 186 .IP \fIsrc_region\fP 1i
 187 Specifies the source region to be used.
 188 .SH DESCRIPTION
 189 The
 190 .ZN XIntersectRegion
 191 function computes the intersection of two regions.
 192 .LP
 193 The
 194 .ZN XUnionRegion
 195 function computes the union of two regions.
 196 .LP
 197 The
 198 .ZN XUnionRectWithRegion
 199 function updates the destination region from a union of the specified rectangle
 200 and the specified source region.
 201 .LP
 202 The
 203 .ZN XSubtractRegion
 204 function subtracts srb from sra and stores the results in dr_return.
 205 .LP
 206 The
 207 .ZN XXorRegion
 208 function calculates the difference between the union and intersection
 209 of two regions.
 210 .LP
 211 The
 212 .ZN XOffsetRegion
 213 function moves the specified region by a specified amount.
 214 .LP
 215 The
 216 .ZN XShrinkRegion
 217 function reduces the specified region by a specified amount.
 218 Positive values shrink the size of the region,
 219 and negative values expand the region.
 220 .SH "SEE ALSO"
 221 XCreateRegion(__libmansuffix__),
 222 XDrawRectangle(__libmansuffix__),
 223 XEmptyRegion(__libmansuffix__)
 224 .br
 225 \fI\*(xL\fP