aboutsummaryrefslogtreecommitdiff
path: root/libXext/man/XShape.man
diff options
context:
space:
mode:
Diffstat (limited to 'libXext/man/XShape.man')
-rw-r--r--libXext/man/XShape.man353
1 files changed, 174 insertions, 179 deletions
diff --git a/libXext/man/XShape.man b/libXext/man/XShape.man
index 0f16ce93c..e40369143 100644
--- a/libXext/man/XShape.man
+++ b/libXext/man/XShape.man
@@ -1,179 +1,174 @@
-.\" $Xorg: XShape.man,v 1.3 2000/08/17 19:41:54 cpqbld Exp $
-.\"
-.\" Copyright (c) 1989, 1994 X Consortium
-.\"
-.\" Permission is hereby granted, free of charge, to any person obtaining a
-.\" copy of this software and associated documentation files (the "Software"),
-.\" to deal in the Software without restriction, including without limitation
-.\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
-.\" and/or sell copies of the Software, and to permit persons to whom the
-.\" Software furnished to do so, subject to the following conditions:
-.\"
-.\" The above copyright notice and this permission notice shall be included in
-.\" all copies or substantial portions of the Software.
-.\"
-.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
-.\" THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-.\" WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
-.\" OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-.\" SOFTWARE.
-.\"
-.\" Except as contained in this notice, the name of the X Consortium shall not
-.\" be used in advertising or otherwise to promote the sale, use or other
-.\" dealing in this Software without prior written authorization from the
-.\" X Consortium.
-.\"
-.\" $XFree86: xc/doc/man/Xext/XShape.man,v 1.3 2001/02/07 22:35:21 tsi Exp $
-.\" $XdotOrg$
-.\"
-.de ZN
-.ie t \fB\^\\$1\^\fR\\$2
-.el \fI\^\\$1\^\fP\\$2
-..
-.TH XSHAPE __libmansuffix__ __xorgversion__ "X FUNCTIONS"
-.SH NAME
-XShapeQueryExtension, XShapeQueryVersion, XShapeCombineRegion, XShapeCombineRectangles, XShapeCombineMask, XShapeCombineShape, XShapeOffsetShape, XShapeQueryExtents, XShapeSelectInput, XShapeInputSelected, XShapeGetRectangles \- X nonrectangular shape functions
-.SH SYNTAX
-.nf
-.LP
-\&#include <X11/extensions/shape.h>
-.LP
-Bool XShapeQueryExtension (
- Display *dpy,
- int *event_basep,
- int *error_basep);
-.LP
-Status XShapeQueryVersion (
- Display *dpy,
- int *major_versionp,
- int *minor_versionp);
-.LP
-void XShapeCombineRegion (
- Display *dpy,
- Window dest,
- int destKind,
- int xOff,
- int yOff,
- struct _XRegion *r,
- int op);
-.LP
-void XShapeCombineRectangles (
- Display *dpy,
- XID dest,
- int destKind,
- int xOff,
- int yOff,
- XRectangle *rects,
- int n_rects,
- int op,
- int ordering);
-.LP
-void XShapeCombineMask (
- Display *dpy,
- XID dest,
- int destKind,
- int xOff,
- int yOff,
- Pixmap src,
- int op);
-.LP
-void XShapeCombineShape (
- Display *dpy,
- XID dest,
- int destKind,
- int xOff,
- int yOff,
- Pixmap src,
- int srcKind,
- int op);
-.LP
-void XShapeOffsetShape (
- Display *dpy,
- XID dest,
- int destKind,
- int xOff,
- int yOff);
-.LP
-Status XShapeQueryExtents (
- Display *dpy,
- Window window,
- int *bShaped,
- int *xbs,
- int *ybs,
- unsigned int *wbs,
- unsigned int *hbs,
- int *cShaped,
- int *xcs,
- int *ycs,
- unsigned int *wcs,
- unsigned int *hcs);
-.LP
-void XShapeSelectInput (
- Display *dpy,
- Window window,
- unsigned longmask);
-.LP
-unsigned long XShapeInputSelected (
- Display *dpy,
- Window window);
-.LP
-XRectangle *XShapeGetRectangles (
- Display *dpy,
- Window window,
- int kind,
- int *count,
- int *ordering);
-.fi
-.SH STRUCTURES
-.nf
-.LP
-.ta 3i
-typedef struct {
- int type; /\&* of event */
- unsigned long serial; /\&* # of last request processed by server */
- Bool send_event; /\&* true if this came from a SendEvent request */
- Display *display; /\&* Display the event was read from */
- Window window; /\&* window of event */
- int kind; /\&* ShapeBounding or ShapeClip */
- int x, y; /\&* extents of new region */
- unsigned width, height;
- Time time; /\&* server timestamp when region changed */
- Bool shaped; /\&* true if the region exists */
-} XShapeEvent;
-.fi
-.SH DESCRIPTION
-The \fIX11 Nonrectangular Window Shape Extension\fP adds nonrectangular
-windows to the X Window System.
-.SH PREDEFINED VALUES
-Operations:
-.in +.5i
-.nf
-.ZN ShapeSet
-.ZN ShapeUnion
-.ZN ShapeIntersect
-.ZN ShapeSubtract
-.ZN ShapeInvert
-.in -.5i
-.fi
-.sp
-Shape Kinds:
-.in +.5i
-.nf
-.ZN ShapeBounding
-.ZN ShapeClip
-.in -.5i
-.fi
-.sp
-Event defines:
-.in +.5i
-.nf
-.ZN ShapeNotifyMask
-.ZN ShapeNotify
-.in -.5i
-.fi
-.SH BUGS
-This manual pages needs a lot more work.
-.SH SEE ALSO
-\fIX11 Nonrectangular Window Shape Extension\fP
+.\" Copyright (c) 1989, 1994 X Consortium
+.\"
+.\" Permission is hereby granted, free of charge, to any person obtaining a
+.\" copy of this software and associated documentation files (the "Software"),
+.\" to deal in the Software without restriction, including without limitation
+.\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
+.\" and/or sell copies of the Software, and to permit persons to whom the
+.\" Software furnished to do so, subject to the following conditions:
+.\"
+.\" The above copyright notice and this permission notice shall be included in
+.\" all copies or substantial portions of the Software.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+.\" THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+.\" WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
+.\" OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+.\" SOFTWARE.
+.\"
+.\" Except as contained in this notice, the name of the X Consortium shall not
+.\" be used in advertising or otherwise to promote the sale, use or other
+.\" dealing in this Software without prior written authorization from the
+.\" X Consortium.
+.\"
+.de ZN
+.ie t \fB\^\\$1\^\fR\\$2
+.el \fI\^\\$1\^\fP\\$2
+..
+.TH XSHAPE __libmansuffix__ __xorgversion__ "X FUNCTIONS"
+.SH NAME
+XShapeQueryExtension, XShapeQueryVersion, XShapeCombineRegion, XShapeCombineRectangles, XShapeCombineMask, XShapeCombineShape, XShapeOffsetShape, XShapeQueryExtents, XShapeSelectInput, XShapeInputSelected, XShapeGetRectangles \- X nonrectangular shape functions
+.SH SYNTAX
+.nf
+.LP
+\&#include <X11/extensions/shape.h>
+.LP
+Bool XShapeQueryExtension (
+ Display *dpy,
+ int *event_basep,
+ int *error_basep);
+.LP
+Status XShapeQueryVersion (
+ Display *dpy,
+ int *major_versionp,
+ int *minor_versionp);
+.LP
+void XShapeCombineRegion (
+ Display *dpy,
+ Window dest,
+ int destKind,
+ int xOff,
+ int yOff,
+ struct _XRegion *r,
+ int op);
+.LP
+void XShapeCombineRectangles (
+ Display *dpy,
+ XID dest,
+ int destKind,
+ int xOff,
+ int yOff,
+ XRectangle *rects,
+ int n_rects,
+ int op,
+ int ordering);
+.LP
+void XShapeCombineMask (
+ Display *dpy,
+ XID dest,
+ int destKind,
+ int xOff,
+ int yOff,
+ Pixmap src,
+ int op);
+.LP
+void XShapeCombineShape (
+ Display *dpy,
+ XID dest,
+ int destKind,
+ int xOff,
+ int yOff,
+ Pixmap src,
+ int srcKind,
+ int op);
+.LP
+void XShapeOffsetShape (
+ Display *dpy,
+ XID dest,
+ int destKind,
+ int xOff,
+ int yOff);
+.LP
+Status XShapeQueryExtents (
+ Display *dpy,
+ Window window,
+ int *bShaped,
+ int *xbs,
+ int *ybs,
+ unsigned int *wbs,
+ unsigned int *hbs,
+ int *cShaped,
+ int *xcs,
+ int *ycs,
+ unsigned int *wcs,
+ unsigned int *hcs);
+.LP
+void XShapeSelectInput (
+ Display *dpy,
+ Window window,
+ unsigned longmask);
+.LP
+unsigned long XShapeInputSelected (
+ Display *dpy,
+ Window window);
+.LP
+XRectangle *XShapeGetRectangles (
+ Display *dpy,
+ Window window,
+ int kind,
+ int *count,
+ int *ordering);
+.fi
+.SH STRUCTURES
+.nf
+.LP
+.ta 3i
+typedef struct {
+ int type; /\&* of event */
+ unsigned long serial; /\&* # of last request processed by server */
+ Bool send_event; /\&* true if this came from a SendEvent request */
+ Display *display; /\&* Display the event was read from */
+ Window window; /\&* window of event */
+ int kind; /\&* ShapeBounding or ShapeClip */
+ int x, y; /\&* extents of new region */
+ unsigned width, height;
+ Time time; /\&* server timestamp when region changed */
+ Bool shaped; /\&* true if the region exists */
+} XShapeEvent;
+.fi
+.SH DESCRIPTION
+The \fIX11 Nonrectangular Window Shape Extension\fP adds nonrectangular
+windows to the X Window System.
+.SH PREDEFINED VALUES
+Operations:
+.in +.5i
+.nf
+.ZN ShapeSet
+.ZN ShapeUnion
+.ZN ShapeIntersect
+.ZN ShapeSubtract
+.ZN ShapeInvert
+.in -.5i
+.fi
+.sp
+Shape Kinds:
+.in +.5i
+.nf
+.ZN ShapeBounding
+.ZN ShapeClip
+.in -.5i
+.fi
+.sp
+Event defines:
+.in +.5i
+.nf
+.ZN ShapeNotifyMask
+.ZN ShapeNotify
+.in -.5i
+.fi
+.SH BUGS
+This manual pages needs a lot more work.
+.SH SEE ALSO
+\fIX11 Nonrectangular Window Shape Extension\fP