libXext-1.0.2/man/XShape.man

   1 .\" $Xorg: XShape.man,v 1.3 2000/08/17 19:41:54 cpqbld Exp $
   2 .\"
   3 .\" Copyright (c) 1989, 1994  X Consortium
   4 .\"
   5 .\" Permission is hereby granted, free of charge, to any person obtaining a
   6 .\" copy of this software and associated documentation files (the "Software"),
   7 .\" to deal in the Software without restriction, including without limitation
   8 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9 .\" and/or sell copies of the Software, and to permit persons to whom the
  10 .\" Software furnished to do so, subject to the following conditions:
  11 .\"
  12 .\" The above copyright notice and this permission notice shall be included in
  13 .\" all copies or substantial portions of the Software.
  14 .\"
  15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18 .\" THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  19 .\" WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
  20 .\" OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21 .\" SOFTWARE.
  22 .\"
  23 .\" Except as contained in this notice, the name of the X Consortium shall not
  24 .\" be used in advertising or otherwise to promote the sale, use or other
  25 .\" dealing in this Software without prior written authorization from the
  26 .\" X Consortium.
  27 .\"
  28 .\" $XFree86: xc/doc/man/Xext/XShape.man,v 1.3 2001/02/07 22:35:21 tsi Exp $
  29 .\" $XdotOrg$
  30 .\"
  31 .de ZN
  32 .ie t \fB\^\\$1\^\fR\\$2
  33 .el \fI\^\\$1\^\fP\\$2
  34 ..
  35 .TH XSHAPE __libmansuffix__ __xorgversion__ "X FUNCTIONS"
  36 .SH NAME
  37 XShapeQueryExtension, XShapeQueryVersion, XShapeCombineRegion, XShapeCombineRectangles, XShapeCombineMask, XShapeCombineShape, XShapeOffsetShape, XShapeQueryExtents, XShapeSelectInput, XShapeInputSelected, XShapeGetRectangles \- X nonrectangular shape functions
  38 .SH SYNTAX
  39 .nf
  40 .LP
  41 \&#include <X11/extensions/shape.h>
  42 .LP
  43 Bool XShapeQueryExtension (
  44         Display *dpy,
  45         int *event_basep,
  46         int *error_basep);
  47 .LP
  48 Status XShapeQueryVersion (
  49         Display *dpy,
  50         int *major_versionp,
  51         int *minor_versionp);
  52 .LP
  53 void XShapeCombineRegion (
  54         Display *dpy,
  55         Window dest,
  56         int destKind,
  57         int xOff,
  58         int yOff,
  59         struct _XRegion *r,
  60         int op);
  61 .LP
  62 void XShapeCombineRectangles (
  63         Display *dpy,
  64         XID dest,
  65         int destKind,
  66         int xOff,
  67         int yOff,
  68         XRectangle *rects,
  69         int n_rects,
  70         int op,
  71         int ordering);
  72 .LP
  73 void XShapeCombineMask (
  74         Display *dpy,
  75         XID dest,
  76         int destKind,
  77         int xOff,
  78         int yOff,
  79         Pixmap src,
  80         int op);
  81 .LP
  82 void XShapeCombineShape (
  83         Display *dpy,
  84         XID dest,
  85         int destKind,
  86         int xOff,
  87         int yOff,
  88         Pixmap src,
  89         int srcKind,
  90         int op);
  91 .LP
  92 void XShapeOffsetShape (
  93         Display *dpy,
  94         XID dest,
  95         int destKind,
  96         int xOff,
  97         int yOff);
  98 .LP
  99 Status XShapeQueryExtents (
 100         Display *dpy,
 101         Window window,
 102         int *bShaped,
 103         int *xbs,
 104         int *ybs,
 105         unsigned int *wbs,
 106         unsigned int *hbs,
 107         int *cShaped,
 108         int *xcs,
 109         int *ycs,
 110         unsigned int *wcs,
 111         unsigned int *hcs);
 112 .LP
 113 void XShapeSelectInput (
 114         Display *dpy,
 115         Window window,
 116         unsigned longmask);
 117 .LP
 118 unsigned long XShapeInputSelected (
 119         Display *dpy,
 120         Window window);
 121 .LP
 122 XRectangle *XShapeGetRectangles (
 123         Display *dpy,
 124         Window window,
 125         int kind,
 126         int *count,
 127         int *ordering);
 128 .fi
 129 .SH STRUCTURES
 130 .nf
 131 .LP
 132 .ta 3i
 133 typedef struct {
 134     int type;   /\(** of event */
 135     unsigned long serial;       /\(** # of last request processed by server */
 136     Bool send_event;    /\(** true if this came frome a SendEvent request */
 137     Display *display;   /\(** Display the event was read from */
 138     Window window;      /\(** window of event */
 139     int kind;   /\(** ShapeBounding or ShapeClip */
 140     int x, y;   /\(** extents of new region */
 141     unsigned width, height;
 142     Time time;  /\(** server timestamp when region changed */
 143     Bool shaped;        /\(** true if the region exists */
 144 } XShapeEvent;
 145 .fi
 146 .SH DESCRIPTION
 147 The \fIX11 Nonrectangular Window Shape Extension\fP adds nonrectangular
 148 windows to the X Window System.
 149 .SH PREDEFINED VALUES
 150 Operations:
 151 .in +.5i
 152 .nf
 153 .ZN ShapeSet
 154 .ZN ShapeUnion
 155 .ZN ShapeIntersect
 156 .ZN ShapeSubtract
 157 .ZN ShapeInvert
 158 .in -.5i
 159 .fi
 160 .sp
 161 Shape Kinds:
 162 .in +.5i
 163 .nf
 164 .ZN ShapeBounding
 165 .ZN ShapeClip
 166 .in -.5i
 167 .fi
 168 .sp
 169 Event defines:
 170 .in +.5i
 171 .nf
 172 .ZN ShapeNotifyMask
 173 .ZN ShapeNotify
 174 .in -.5i
 175 .fi
 176 .SH BUGS
 177 This manual pages needs a lot more work.
 178 .SH SEE ALSO
 179 \fIX11 Nonrectangular Window Shape Extension\fP