xcb_set_clip_rectangles(3)

💖 xcb_set_clip_rectangles — bestie edition 💖

okay so we're in the xcb_set_clip_rectangles(3) page, part of XCB Requests, and yes bestie this one is a whole mood. it sets the clip rectangles on a graphics context. that's the vibe. let's go 🦋

---

✨ NAME ✨

xcb_set_clip_rectangles — the request that tells your GC which rectangles are allowed to get painted on 💅

(ngl the original NAME section is literally just the function name and then nothing, so. that's the tea. no cap.)

---

✨ SYNOPSIS ✨

first, you gotta pull in the header, obviously:

#include <xcb/xproto.h>

🎀 Request function 🎀

here's the whole signature, character for character, don't @ me:

xcb_void_cookie_t xcb_set_clip_rectangles(xcb_connection_t *conn,
       uint8_t ordering, xcb_gcontext_t gc, int16_t clip_x_origin,
       int16_t clip_y_origin, uint32_t rectangles_len, const
       xcb_rectangle_t *rectangles);

look at that. iconic. she's giving function. 🔥

---

✨ REQUEST ARGUMENTS ✨

kay so here's every single one of them, and I'm not skipping a single lil guy:

• conn — the XCB connection to X11. that's your whole link to the server, your main character connection 💖
• ordering — it's one of the following values, and bestie I need you to know the docs are straight up not written yet for every single one of these, so I'm passing along the exact energy:
  • XCB_CLIP_ORDERING_UNSORTED — TODO: NOT YET DOCUMENTED.
  • XCB_CLIP_ORDERING_Y_SORTED — TODO: NOT YET DOCUMENTED.
  • XCB_CLIP_ORDERING_YX_SORTED — TODO: NOT YET DOCUMENTED.
  • XCB_CLIP_ORDERING_YX_BANDED — TODO: NOT YET DOCUMENTED.
  • TODO: NOT YET DOCUMENTED.

yeah there's a lil extra TODO floating there at the end. it's in the original, so it's here too. we don't erase history 💀

• gc — TODO: NOT YET DOCUMENTED.
• clip_x_origin — TODO: NOT YET DOCUMENTED.
• clip_y_origin — TODO: NOT YET DOCUMENTED.
• rectangles_len — TODO: NOT YET DOCUMENTED.
• rectangles — TODO: NOT YET DOCUMENTED.

fr fr the entire argument list is undocumented upstream. that's not me being lazy, that's literally what the page says. I'm just the messenger 🫶

---

✨ DESCRIPTION ✨

so. um. the DESCRIPTION section is empty. like, nothing. void. a blank space. the original page has the heading and then straight up nothing under it. and I'm not gonna invent lore, so: it's empty, bestie. we move. 🧚

---

✨ RETURN VALUE ✨

she returns an xcb_void_cookie_t. and because it's a void cookie, any errors (if there even are any) have to be handled over in the event loop, not right here at call time.

and if you'd rather handle errors directly with xcb_request_check instead? use xcb_set_clip_rectangles_checked for that. go check xcb-requests(3) for the details, iykyk ✨

---

✨ ERRORS ✨

good news bestie: this request does never generate any errors. we love a low-drama king 👑

---

✨ SEE ALSO ✨

...the original SEE ALSO section is empty too. no references, no cross-links, nothing. a whole blank. 💀

---

✨ AUTHOR ✨

Generated from xproto.xml. if you've got corrections and improvements, hit up xcb@lists.freedesktop.org — they're the ones you wanna talk to 🌸

---

okay that's the whole page!! go set those clip rectangles, you gorgeous thing 🌈💜

this has been xcb_set_clip_rectangles(3) from X Version 11, libxcb 1.17.0 💖 — mwah, stan the XCB devs, periodt. 🎀🦋✨