xcb_render_se...ip_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_render_se...ip_rectangles(3) ✨

okay bestie, so this is a page from the XCB Requests corner of the manual β€” yes the title is literally truncated with dots in it, that's not a typo, that's just how it's filed πŸ’… β€” and we're talking about xcb_render_set_picture_clip_rectangles. sit down, hydrate, let's go 🫢


🌸 NAME 🌸

xcb_render_set_picture_clip_rectangles β€” and ngl the description slot is just... empty. that's it. that's the whole name section. the original said nothing else so neither do i 😭


πŸŽ€ SYNOPSIS πŸŽ€

first things first, you gotta pull in the header:

#include <xcb/render.h>

✨ Request function ✨

xcb_void_cookie_t
       xcb_render_set_picture_clip_rectangles(xcb_connection_t *conn,
       xcb_render_picture_t picture, int16_t clip_x_origin,
       int16_t clip_y_origin, uint32_t rectangles_len, const
       xcb_rectangle_t *rectangles);

copy it exactly like that, no cap 🧚


πŸ¦‹ REQUEST ARGUMENTS πŸ¦‹

here's the whole cast, and listen β€” the original doc for literally every single one of these says "TODO: NOT YET DOCUMENTED." so i'm not gonna make stuff up about them, that would be a vibe crime πŸ™ˆ i'm just telling you what each one is:

  • conn β€” the XCB connection to X11. your lil hotline to the server, periodt πŸ’–
  • picture β€” TODO: NOT YET DOCUMENTED. yeah. the manpage really left us on read for this one πŸ’€
  • clip_x_origin β€” TODO: NOT YET DOCUMENTED. (a int16_t, in case you were wondering πŸ‘€)
  • clip_y_origin β€” TODO: NOT YET DOCUMENTED. also just sitting there undocumented, iconic behaviour honestly
  • rectangles_len β€” TODO: NOT YET DOCUMENTED. (it's a uint32_t, so like, it's a length. that's all we get πŸ“)
  • rectangles β€” TODO: NOT YET DOCUMENTED. (a const xcb_rectangle_t *, and that's the entire tea β˜•)

πŸ’œ DESCRIPTION πŸ’œ

...nothing. the section exists and it is empty. the silence is deafening bestie 😭 i cannot invent lore that isn't there, that's not the move 🫢


πŸ”₯ RETURN VALUE πŸ”₯

it hands you back an xcb_void_cookie_t. and listen closely, because this part actually matters: any errors have to be handled over in the event loop. that's the deal. no sneaky shortcuts ✨

but wait β€” if you'd rather handle errors directly, there's xcb_request_check for that, and for that route you wanna use xcb_render_set_picture_clip_rectangles_checked instead. the full details live in xcb-requests(3), so go read that when you're ready πŸ“š


πŸ’€ ERRORS πŸ’€

This request does never generate any errors.

yep. zero. none. she's unproblematic, she's drama-free, she does not start fights πŸ‘‘ (dramatic? maybe. accurate? fr fr.)


🌈 SEE ALSO 🌈

crickets. literally nothing listed here. the section is there and it's empty, so i'm keeping it empty β€” i'm not about to invent references and gaslight you πŸŽ€


πŸ’Œ AUTHOR πŸ’Œ

Generated from render.xml. if you spot something wrong or wanna make it better, hit up xcb@lists.freedesktop.org β€” they're the ones taking corrections and improvements 🫢


and that's the whole page, bestie!! this beauty came from X Version 11, libxcb 1.17.0, and yeah the title up top is truncated with those lil dots but you know exactly which page you're on πŸ’… mwah, go forth and clip responsibly βœ¨πŸŒΈπŸ¦‹