x11::protocol::ext::shape(3pm) [debian man page]

Protocol::Ext::SHAPE(3pm)				User Contributed Perl Documentation				 Protocol::Ext::SHAPE(3pm)

NAME

       X11::Protocol::Ext::SHAPE - Perl module for the X11 Protocol Nonrectangular Window Shape Extension

SYNOPSIS

	 use X11::Protocol;
	 $x = X11::Protocol->new($ENV{'DISPLAY'});
	 $x->init_extension('SHAPE') or die;

DESCRIPTION

       This module is used by the X11::Protocol module to participate in the shaped window extension to the X protocol, allowing windows to be of
       any shape, not just rectangles.

SYMBOLIC CONSTANTS

       This extension adds the constant types 'ShapeKind' and 'ShapeOp', with values as defined in the standard.

EVENTS

       This extension adds the event type 'ShapeNotify', with values as specified in the standard. This event is selected using the
       ShapeSelectInput() request.

REQUESTS

       This extension adds several requests, called as shown below:

	 $x->ShapeQueryVersion
	 =>
	 ($major, $minor)

	 $x->ShapeRectangles($dest, $destKind, $op, $xOff, $yOff,
			     $ordering, @rectangles)

	 $x->ShapeMask($dest, $destKind, $op, $xOff, $yOff, $source)

	 $x->ShapeCombine($dest, $destKind, $op, $xOff, $yOff, $source,
			  $sourceKind)

	 $x->ShapeOffset($dest, $destKind, $xOff, $yOff)

	 $x->ShapeQueryExtents($dest)
	 =>
	 ($boundingShaped, $clipShaped,
	  ($xBoundingShape, $yBoundingShape,
	   $widthBoundingShape, $heightBoundingShape)
	  ($xClipShape, $yClipShape, $widthClipShape, $heightClipShape))

	 $x->ShapeSelectInput($window, $enable)

	 $x->ShapeInputSelected($window)
	 =>
	 $enable

	 $x->ShapeGetRectangles($window, $kind)
	 =>
	 ($ordering, [$x, $y, $width, $height], ...)

AUTHOR

       Stephen McCamant <SMCCAM@cpan.org>.

SEE ALSO

       perl(1), X11::Protocol, Nonrectangular Window Shape Extension (X Consortium Standard).

perl v5.14.2							    2003-02-16						 Protocol::Ext::SHAPE(3pm)

XSHAPE(3X11)							    X FUNCTIONS 						      XSHAPE(3X11)

NAME

       XShapeQueryExtension,  XShapeQueryVersion,  XShapeCombineRegion, XShapeCombineRectangles, XShapeCombineMask, XShapeCombineShape, XShapeOff-
       setShape, XShapeQueryExtents, XShapeSelectInput, XShapeInputSelected, XShapeGetRectangles - X nonrectangular shape functions

SYNTAX

       #include <X11/extensions/shape.h>

       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);

STRUCTURES

       typedef struct {
	   int type;
	   unsigned long serial;
	   Bool send_event;
	   Display *display;
	   Window window;
	   int kind;
	   int x, y;
	   unsigned width, height;
	   Time time;
	   Bool shaped;
       } XShapeEvent;

DESCRIPTION

       The X11 Nonrectangular Window Shape Extension adds nonrectangular windows to the X Window System.

PREDEFINED VALUES

       Operations:
	    ShapeSet
	    ShapeUnion
	    ShapeIntersect
	    ShapeSubtract
	    ShapeInvert

       Shape Kinds:
	    ShapeBounding
	    ShapeClip

       Event defines:
	    ShapeNotifyMask
	    ShapeNotify

BUGS

       This manual pages needs a lot more work.

SEE ALSO

       X11 Nonrectangular Window Shape Extension

X Version 11							    Release 6.6 						      XSHAPE(3X11)