xcb_shape_rectangles(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_rectangles β€” the manual page, but make it make sense πŸ’–

okay bestie, so this is xcb_shape_rectangles(3), a page from the XCB Requests manual. Pull up a chair, grab a strawberry πŸ“, and let's get into it.


🌸 NAME 🌸

xcb_shape_rectangles β€”

(and yes, the description after that dash is literally empty in the original. iconic of it. we move.) πŸ’…


✨ SYNOPSIS ✨

First things first, you gotta include the header, no cap:

#include <xcb/shape.h>

πŸ¦‹ Request function πŸ¦‹

xcb_void_cookie_t xcb_shape_rectangles(xcb_connection_t *conn,
       xcb_shape_op_t operation, xcb_shape_kind_t destination_kind,
       uint8_t ordering, xcb_window_t destination_window,
       int16_t x_offset, int16_t y_offset, uint32_t rectangles_len,
       const xcb_rectangle_t *rectangles);

look at her. so many parameters. so much main character energy. πŸ‘‘


πŸŽ€ REQUEST ARGUMENTS πŸŽ€

okay so here's the whole cast list, one by one:

  • conn β€” your XCB connection to X11. your little lifeline to the server, fr fr.
  • operation β€” TODO: NOT YET DOCUMENTED.
  • destination_kind β€” TODO: NOT YET DOCUMENTED.
  • ordering β€” TODO: NOT YET DOCUMENTED.
  • destination_window β€” TODO: NOT YET DOCUMENTED.
  • x_offset β€” TODO: NOT YET DOCUMENTED.
  • y_offset β€” TODO: NOT YET DOCUMENTED.
  • rectangles_len β€” TODO: NOT YET DOCUMENTED.
  • rectangles β€” TODO: NOT YET DOCUMENTED.
not me reading eight straight TODOs 😭 bestie the docs are not documenting. the original really said "figure it out" and left. it's giving mystery. it's giving ✨enigmatic✨. i'm just the messenger, so if you need the real tea on these, the source is right there β€” i refuse to make stuff up because that would be lying and lying is not slay. 🫢

🌈 DESCRIPTION 🌈

...and that's it. that's the section. it's empty. the DESCRIPTION describes nothing. a true minimalist queen, honestly. πŸ˜­πŸ’€


πŸ’œ RETURN VALUE πŸ’œ

She returns an xcb_void_cookie_t. That's the vibe. Any errors (if any show up) have to be handled in the event loop, not right here β€” so set up your loop, bestie, don't skip it.

But if you want to handle errors directly with xcb_request_check instead, then you use xcb_shape_rectangles_checked. different function, different energy. see xcb-requests(3) for the full details on how that all works. πŸ“š


πŸ”₯ ERRORS πŸ”₯

good news for your blood pressure: this request does never generate any errors. not a single one. zero. clean sheet. we love a low-drama request. ✨


🌟 SEE ALSO 🌟

(blank. nothing. tumbleweed. πŸƒ the original lists nothing here, so there's nothing for me to send you to. i'm not gonna invent references, that's not the move.)


🧚 AUTHOR 🧚

Generated from shape.xml. If you spot something wrong or wanna make it better, contact xcb@lists.freedesktop.org for corrections and improvements. they're the ones who actually know things. πŸ’Œ


πŸ’€ warning-ish reminder: everything above that says "TODO: NOT YET DOCUMENTED" genuinely is not documented in the original. i'm keeping it 100 with you β€” i'm not filling in gaps with guesses, because a guess dressed up as a manpage is how people get hurt. πŸ™ˆ

and that's the whole page, bestie! 🌈 you read a manual and slayed. this one came to you from X Version 11, libxcb 1.17.0, the xcb_shape_rectangles(3) page β€” mwah, go forth and shape some rectangles. πŸ’–πŸŽ€πŸ¦‹πŸ’