xcb_composite...m_border_clip(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

πŸ¦‹ NAME πŸ¦‹

okay bestie, say hi to xcb_composite_create_region_from_border_clip πŸ’–

that's it. that's the name. the description slot? literally empty. the manpage said nothing and honestly it meant it. no cap. πŸ™ˆ

it lives in the XCB Requests corner of the manual, section 3, and the page header up top is truncating the name to xcb_composite...m_border_clip(3) because even man was like "girl this name is long" πŸ’€


✨ SYNOPSIS ✨

first you gotta bring the header in, or nothing works:

#include <xcb/composite.h>

then, the request function herself πŸ‘‘:

xcb_void_cookie_t
       xcb_composite_create_region_from_border_clip(xcb_connection_t *conn,
       xcb_xfixes_region_t region, xcb_window_t window);

she returns an xcb_void_cookie_t and takes three little besties. we'll meet them in a sec 🫢


🌸 REQUEST ARGUMENTS 🌸

  • conn β€” the XCB connection to X11. your little lifeline to the server, the group chat you're actually sending messages in πŸ’…
  • region β€” TODO: NOT YET DOCUMENTED. yeah. the docs said "we'll do it later" and then never did. iconic behaviour, honestly 😭
  • window β€” TODO: NOT YET DOCUMENTED. same energy. same void. no notes. πŸ™ˆ
not me reading the docs hoping for lore and getting two TODOs in a trench coat πŸ’€ i'm just the messenger bestie, i'm not gonna make stuff up for you.

πŸŽ€ DESCRIPTION πŸŽ€

so… there isn't one. the DESCRIPTION section on this page is empty. completely. the way that the original manpage just has the heading and then absolute silence? it's giving "ghosted" πŸ«₯

i'm not gonna invent lore that isn't there, so: nothing to see, moving on, periodt.


πŸ’œ RETURN VALUE πŸ’œ

she hands you back an xcb_void_cookie_t. that's the vibe. ✨

now listen, because this part matters: errors (if any) have to be handled in the event loop. like, you don't get them thrown at you immediately, you go collect them later like a little package at the front desk πŸ“¦

if you'd rather handle errors directly with xcb_request_check instead, then use xcb_composite_create_region_from_border_clip_checked β€” that's the checked version, she's the one who'll actually tell you what went wrong 🫢

and for all the details, go read xcb-requests(3). iykyk.


πŸ’€ ERRORS πŸ’€

this request does never generate any errors. fr fr. she's a good girl, she causes no drama, zero chaos, no smoke 🌈

so if something IS breaking, bestie, it's not her. look elsewhere. πŸ‘€

🌈 SEE ALSO 🌈

nothing here either 😭 the SEE ALSO section is empty on this page β€” no references, no cross-links, just vibes and open space. so cute, so unhelpful, we move πŸ’…


πŸ‘‘ AUTHOR πŸ‘‘

this page was generated from composite.xml. if you've got corrections or improvements, hit up xcb@lists.freedesktop.org β€” they're the ones who actually want your feedback, not me, i'm just the hype girl πŸŽ€


okay so real talk, this page is short and the docs are shy, but you got this bestie β€” go make that border clip region, slay, and remember: cookie now, errors later πŸ’–βœ¨

signing off from X Version 11, running libxcb 1.17.0, same energy as the footer that brought you here πŸ¦‹ mwah πŸ’œ