man-pages/man3/X11::Protocol::Ext::SHAPE.3pm.html
2021-03-31 01:06:50 +01:00

135 lines
3.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of Protocol::Ext::SHAPE</TITLE>
</HEAD><BODY>
<H1>Protocol::Ext::SHAPE</H1>
Section: User Contributed Perl Documentation (3pm)<BR>Updated: 2003-02-16<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>
X11::Protocol::Ext::SHAPE - Perl module for the X11 Protocol Nonrectangular Window Shape Extension
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
use X11::Protocol;
$x = X11::Protocol-&gt;new($ENV{'DISPLAY'});
$x-&gt;init_extension('SHAPE') or die;
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
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.
<A NAME="lbAE">&nbsp;</A>
<H2>SYMBOLIC CONSTANTS</H2>
This extension adds the constant types 'ShapeKind' and 'ShapeOp', with values
as defined in the standard.
<A NAME="lbAF">&nbsp;</A>
<H2>EVENTS</H2>
This extension adds the event type 'ShapeNotify', with values as specified in
the standard. This event is selected using the <I>ShapeSelectInput()</I> request.
<A NAME="lbAG">&nbsp;</A>
<H2>REQUESTS</H2>
This extension adds several requests, called as shown below:
<P>
<PRE>
$x-&gt;ShapeQueryVersion
=&gt;
($major, $minor)
$x-&gt;ShapeRectangles($dest, $destKind, $op, $xOff, $yOff,
$ordering, @rectangles)
$x-&gt;ShapeMask($dest, $destKind, $op, $xOff, $yOff, $source)
$x-&gt;ShapeCombine($dest, $destKind, $op, $xOff, $yOff, $source,
$sourceKind)
$x-&gt;ShapeOffset($dest, $destKind, $xOff, $yOff)
$x-&gt;ShapeQueryExtents($dest)
=&gt;
($boundingShaped, $clipShaped,
($xBoundingShape, $yBoundingShape,
$widthBoundingShape, $heightBoundingShape)
($xClipShape, $yClipShape, $widthClipShape, $heightClipShape))
$x-&gt;ShapeSelectInput($window, $enable)
$x-&gt;ShapeInputSelected($window)
=&gt;
$enable
$x-&gt;ShapeGetRectangles($window, $kind)
=&gt;
($ordering, [$x, $y, $width, $height], ...)
</PRE>
<A NAME="lbAH">&nbsp;</A>
<H2>AUTHOR</H2>
Stephen McCamant &lt;<A HREF="mailto:SMCCAM@cpan.org">SMCCAM@cpan.org</A>&gt;.
<A NAME="lbAI">&nbsp;</A>
<H2>SEE ALSO</H2>
<I><A HREF="/cgi-bin/man/man2html?1+perl">perl</A></I>(1),
X11::Protocol,
<I>Nonrectangular Window Shape Extension (X Consortium Standard)</I>.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="4"><A HREF="#lbAE">SYMBOLIC CONSTANTS</A><DD>
<DT id="5"><A HREF="#lbAF">EVENTS</A><DD>
<DT id="6"><A HREF="#lbAG">REQUESTS</A><DD>
<DT id="7"><A HREF="#lbAH">AUTHOR</A><DD>
<DT id="8"><A HREF="#lbAI">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:00 GMT, March 31, 2021
</BODY>
</HTML>