xcb_shape_mask(3)

📦
version 1.17.0 · 4 versions
, in alpine 3.22, alpine 3.23, alpine 3.24, arch rolling, centos-stream 10, debian trixie, fedora 43, fedora 44, nixpkgs unstable, opensuse-leap 16.0, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ xcb_shape_mask ✨

okay bestie, gather round, we're doing XCB today 💅 this one lives in the XCB Requests section of the manual, it's called xcb_shape_mask(3), and it is the request for stamping a shape mask onto a window. yes it's giving mysterious because half the docs are literally "TODO: NOT YET DOCUMENTED" but we work with what we have, fr fr 🫶

🌸 NAME 🌸

xcb_shape_mask — the shape-mask request (the original page gives no description here, not me making that up, that's just how it is 😭)

🦋 SYNOPSIS 🦋

#include <xcb/shape.h>

✨ Request function ✨

xcb_void_cookie_t xcb_shape_mask(xcb_connection_t *conn,
       xcb_shape_op_t operation, xcb_shape_kind_t destination_kind,
       xcb_window_t destination_window, int16_t x_offset,
       int16_t y_offset, xcb_pixmap_t source_bitmap);

🎀 REQUEST ARGUMENTS 🎀

  • conn — the XCB connection to X11. your lil hotline to the server, mwah 💖
  • operation — TODO: NOT YET DOCUMENTED. yeah. the docs simply did not. 🙈
  • destination_kind — TODO: NOT YET DOCUMENTED. also ghosted us 💀
  • destination_window — TODO: NOT YET DOCUMENTED. the mystery continues ✨
  • x_offset — TODO: NOT YET DOCUMENTED. (it's an offset tho, iykyk 👀)
  • y_offset — TODO: NOT YET DOCUMENTED. (the other half of that offset situation)
  • source_bitmap — TODO: NOT YET DOCUMENTED. the plot thickens 🌈
not a single one of these got a real description, bestie. i'm not gonna invent lore for them, that's not the vibe. the original literally says TODO: NOT YET DOCUMENTED. and we respect the source 🫡

💜 DESCRIPTION 💜

…yeah there isn't one. the DESCRIPTION section of the original page is empty. no notes. iconic in a slightly chaotic way honestly 😭

🍓 RETURN VALUE 🍓

It returns an xcb_void_cookie_t ✨ Errors (if any) have to be handled in the event loop — so you don't get them handed to you immediately, you gotta go catch them in the loop like the main character you are 👑

If you'd rather handle errors directly with xcb_request_check instead, use xcb_shape_mask_checked. See xcb-requests(3) for the details, bestie, it's all in there 🫶

🌈 ERRORS 🌈

This request does never generate any errors. — zero. none. no drama, no error codes, we love a low-maintenance request 💅

⭐ SEE ALSO ⭐

…nothing listed. the SEE ALSO section is empty, so no cross-refs for you today. slay, i guess? 🎀

👑 AUTHOR 👑

Generated from shape.xml. Contact xcb@lists.freedesktop.org for corrections and improvements 💌 (yes, they really do want your emails, go be helpful)

and that's the whole page, bestie!! shoutout to X Version 11 and libxcb 1.17.0 for bringing us this absolute unit of a request — mwah, take care of yourself, hydrate, and go read xcb-requests(3) like i told you 😘💖✨

📦 where this page comes from