xcb_damage_add(3)

πŸ“¦
version 1.17.0 Β· 5 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_damage_add β€” the XCB Requests girlies' guide πŸ’–

okay so bestie, welcome to xcb_damage_add(3) from the XCB Requests collection. this is the lil request that says "hey, add a region to a Damage object you already made earlier" ✨ no cap.


✨ NAME ✨

xcb_damage_add β€” add a region to a previously created Damage object. that's it, that's the whole vibe πŸŽ€


🌸 SYNOPSIS 🌸

first things first, you gotta let the compiler know what's up:

#include <xcb/damage.h>

πŸ¦‹ Request function πŸ¦‹

here's the iconic signature, copy it exactly bestie, character for character:

xcb_void_cookie_t xcb_damage_add(xcb_connection_t *conn,
       xcb_drawable_t drawable, xcb_xfixes_region_t region);

πŸ’… REQUEST ARGUMENTS πŸ’…

  • conn β€” the XCB connection to X11. your lil hotline to the X server, she's the main character here fr.
  • drawable β€” TODO: NOT YET DOCUMENTED. yeah bestie the docs literally say that, i'm not gatekeeping, that's just what it says 😭
  • region β€” TODO: NOT YET DOCUMENTED. same energy, the source material left this one blank, so blank it stays πŸ™ˆ

πŸ’œ DESCRIPTION πŸ’œ

so what does this actually do? it updates the regions of damage recorded in a a Damage object. (yes, "a a" β€” that's what the original says, i am not touching it, it's giving typo but it's their typo and it's iconic πŸ’€)

want the full lore? the damage protocol tea lives right here:

https://www.x.org/releases/current/doc/damageproto/damageproto.txt

go read it, iykyk πŸ“–βœ¨


πŸ”₯ RETURN VALUE πŸ”₯

it hands you back an xcb_void_cookie_t. and because this is a void cookie, any errors that pop off have to be handled in the event loop β€” you don't get them handed to you directly, bestie, you gotta go get them.

if you do want to handle errors directly with xcb_request_check instead? then you want the checked version, xcb_damage_add_checked. see xcb-requests(3) for the deets 🫢


πŸŽ€ ERRORS πŸŽ€

good news queen: this request does never generate any errors. zero. none. a clean slate, a flawless vibe check, she simply does not miss πŸ’…βœ¨


🌈 SEE ALSO 🌈


πŸ‘‘ AUTHOR πŸ‘‘

Generated from damage.xml. need corrections or improvements? hit up xcb@lists.freedesktop.org β€” they're the ones holding the pen πŸ–ŠοΈπŸ’–


and that's the whole page bestie!! this lil masterpiece came to you from X Version 11, libxcb 1.17.0, and the manpage xcb_damage_add(3) herself. slay, study, and go add those regions πŸ¦‹πŸ’œ periodt ✨