xcb_xfixes_subtract_region(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_xfixes_subtract_region — the manual, but make it make sense 💖

okay bestie, welcome to xcb_xfixes_subtract_region(3), a page from the XCB Requests collection. she's a lil quiet in the NAME section (we'll get there), but stick with me, she's iconic in her own way. 🌸

✨ NAME ✨

xcb_xfixes_subtract_region —

no cap, the original NAME line is literally just the function name followed by a dash and absolutely nothing else. the description of what she does is, and I quote the vibe here, not documented. we move. 💅

🌈 SYNOPSIS 🌈

first up, you gotta pull in the header, no skipping:

#include <xcb/xfixes.h>

🎀 Request function 🎀

here's the actual call, character for character, don't you dare paraphrase her:

xcb_void_cookie_t xcb_xfixes_subtract_region(xcb_connection_t *conn,
       xcb_xfixes_region_t source1, xcb_xfixes_region_t source2,
       xcb_xfixes_region_t destination);

she takes a connection and three regions. that's it. that's the whole girl. ✨

🦋 REQUEST ARGUMENTS 🦋

  • conn — your XCB connection to X11. the plug, the link, the whole reason any of this works. 🔌
  • source1 — TODO: NOT YET DOCUMENTED. yeah babe, the docs said "figure it out". I'm not gonna lie to you and pretend I know.
  • source2 — TODO: NOT YET DOCUMENTED. same energy. bestie, she's a mystery.
  • destination — TODO: NOT YET DOCUMENTED. the third one. also undocumented. the manpage is giving "left on read" fr fr. 😭
lowkey the whole arguments section is three "TODO: NOT YET DOCUMENTED."s in a trench coat. I'm telling you this because I love you and I refuse to invent details that aren't there. 🙈

💜 DESCRIPTION 💜

the DESCRIPTION section is... empty. nothing. void. a blank space where the lore should be.

so what we know is what the SYNOPSIS told us and nothing more. no extra claims, no vibes-based guessing, periodt. ✋

👑 RETURN VALUE 👑

she hands you back an xcb_void_cookie_t. and because she's void, any errors (if there are any, which... see below 👀) have to be handled over in the event loop. that's just how void requests do.

if you'd rather handle errors directly instead of waiting around in the event loop, use xcb_request_check — for that route you want the checked twin:

  • xcb_xfixes_subtract_region_checked

and if you want the full rundown on how request/cookie stuff works, go read xcb-requests(3). she's the reference, she explains it better than I can in a group chat. 💖

💀 ERRORS 💀

this request does never generate any errors.

yeah. zero. none. not a single one. she's unproblematic like that. 🌈✨

🔥 SEE ALSO 🔥

that's the one and only cross-reference in the original, and I'm keeping her exactly as she is. no extras, no invented recommendations. 🫶

🌸 AUTHOR 🌸

generated from xfixes.xml. if you spot something wrong and wanna send corrections or improvements, hit up xcb@lists.freedesktop.org. they're the ones who actually know things. 💌

okay and finally, the cute sign-off, because the footer deserves her moment: this page comes to you from X Version 11 and libxcb 1.17.0, filed under xcb_xfixes_subtract_region(3). 💅✨

stay slay, handle your cookies responsibly, and remember: three TODOs is still a valid documentation strategy apparently. bye bestie! 🎀💖

📦 where this page comes from