Protoco...::SHAPE(3)

💖 NAME 💖

okay bestie, welcome to Protoco...::SHAPE(3) — filed under User Contributed Perl Documentation — and the module is X11::Protocol::Ext::SHAPE: a Perl module for the X11 Protocol Nonrectangular Window Shape Extension. It's giving shaped windows, not just boring rectangles, and we love that for us. 🦋

✨ SYNOPSIS ✨

boot it up like this, bestie:

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. Translation: windows get main character energy, fr fr. ✨

🎀 SYMBOLIC CONSTANTS 🎀

• This extension adds the constant types 'ShapeKind' and 'ShapeOp' — their values are as defined in the standard. No cap. 🎀

🔥 EVENTS 🔥

• This extension adds the event type 'ShapeNotify', with values as specified in the standard.
• You select this event using the ShapeSelectInput() request.

💅 REQUESTS 💅

This extension adds several requests, called as shown below. Here's the exact lineup — do not lose a single $ or comma, okay? 💅

         $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>. Legend behavior. 👑

🌈 SEE ALSO 🌈

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

---

okay that's the whole page, bestie. source/version: perl v5.42.0; date: 2024-03-04; manual: Protoco...::SHAPE(3). go shape some windows and slay 💖✨🦋