man/XShape.man

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