man-pages/man3/XShape.3.html
2021-03-31 01:06:50 +01:00

193 lines
4.2 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of XSHAPE</TITLE>
</HEAD><BODY>
<H1>XSHAPE</H1>
Section: X FUNCTIONS (3)<BR>Updated: libXext 1.3.4<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
XShapeQueryExtension, XShapeQueryVersion, XShapeCombineRegion, XShapeCombineRectangles, XShapeCombineMask, XShapeCombineShape, XShapeOffsetShape, XShapeQueryExtents, XShapeSelectInput, XShapeInputSelected, XShapeGetRectangles - X nonrectangular shape functions
<A NAME="lbAC">&nbsp;</A>
<H2>SYNTAX</H2>
<PRE>
#include &lt;<A HREF="file:///usr/include/X11/extensions/shape.h">X11/extensions/shape.h</A>&gt;
Bool XShapeQueryExtension (
Display *dpy,
int *event_basep,
int *error_basep);
Status XShapeQueryVersion (
Display *dpy,
int *major_versionp,
int *minor_versionp);
void XShapeCombineRegion (
Display *dpy,
Window dest,
int destKind,
int xOff,
int yOff,
struct _XRegion *r,
int op);
void XShapeCombineRectangles (
Display *dpy,
XID dest,
int destKind,
int xOff,
int yOff,
XRectangle *rects,
int n_rects,
int op,
int ordering);
void XShapeCombineMask (
Display *dpy,
XID dest,
int destKind,
int xOff,
int yOff,
Pixmap src,
int op);
void XShapeCombineShape (
Display *dpy,
XID dest,
int destKind,
int xOff,
int yOff,
Pixmap src,
int srcKind,
int op);
void XShapeOffsetShape (
Display *dpy,
XID dest,
int destKind,
int xOff,
int yOff);
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);
void XShapeSelectInput (
Display *dpy,
Window window,
unsigned longmask);
unsigned long XShapeInputSelected (
Display *dpy,
Window window);
XRectangle *XShapeGetRectangles (
Display *dpy,
Window window,
int kind,
int *count,
int *ordering);
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>STRUCTURES</H2>
<PRE>
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;
</PRE>
<A NAME="lbAE">&nbsp;</A>
<H2>DESCRIPTION</H2>
The <I>X11 Nonrectangular Window Shape Extension</I> adds nonrectangular
windows to the X Window System.
<A NAME="lbAF">&nbsp;</A>
<H2>PREDEFINED VALUES</H2>
Operations:
<DL COMPACT><DT id="1"><DD>
<PRE>
<I>ShapeSet</I>
<I>ShapeUnion</I>
<I>ShapeIntersect</I>
<I>ShapeSubtract</I>
<I>ShapeInvert</I></PRE>
</DL>
<P>
Shape Kinds:
<DL COMPACT><DT id="2"><DD>
<PRE>
<I>ShapeBounding</I>
<I>ShapeClip</I></PRE>
</DL>
<P>
Event defines:
<DL COMPACT><DT id="3"><DD>
<PRE>
<I>ShapeNotifyMask</I>
<I>ShapeNotify</I></PRE>
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>BUGS</H2>
This manual page needs a lot more work.
<A NAME="lbAH">&nbsp;</A>
<H2>SEE ALSO</H2>
<I>X11 Nonrectangular Window Shape Extension</I>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="4"><A HREF="#lbAB">NAME</A><DD>
<DT id="5"><A HREF="#lbAC">SYNTAX</A><DD>
<DT id="6"><A HREF="#lbAD">STRUCTURES</A><DD>
<DT id="7"><A HREF="#lbAE">DESCRIPTION</A><DD>
<DT id="8"><A HREF="#lbAF">PREDEFINED VALUES</A><DD>
<DT id="9"><A HREF="#lbAG">BUGS</A><DD>
<DT id="10"><A HREF="#lbAH">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:06:01 GMT, March 31, 2021
</BODY>
</HTML>