xcb_damage_subtract(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_subtract 💖

okay bestie, welcome to the xcb_damage_subtract page from the XCB Requests manual 💅 this one is short and sweet and honestly? a little mysterious. let's get into it ✨

🌸 NAME 🌸

xcb_damage_subtract — remove regions from a previously created Damage object.

like, you already made a Damage object, and now you're taking some regions back out of it. it's giving editing your damage receipts 🧾✨

🎀 SYNOPSIS 🎀

first things first, you gotta pull in the header:

#include <xcb/damage.h>

✨ Request function ✨

xcb_void_cookie_t xcb_damage_subtract(xcb_connection_t *conn,
       xcb_damage_damage_t damage, xcb_xfixes_region_t repair,
       xcb_xfixes_region_t parts);

that's the whole vibe. four things go in, a xcb_void_cookie_t comes out 🫶

🦋 REQUEST ARGUMENTS 🦋

  • conn — the XCB connection to X11. your lil phone line to the server, no cap 📞
  • damage — the ID you provided to xcb_create_damage. yes, that damage. the one you made earlier, bestie 💜
  • repair — TODO: NOT YET DOCUMENTED. yeah… nobody wrote this one down yet 😭
  • parts — TODO: NOT YET DOCUMENTED. also a mystery. iconic of them honestly 🙈
not me telling you two of the args are literally undocumented. that's just what the page says, i'm not gonna make stuff up 💀

🌈 DESCRIPTION 🌈

so what does this actually do? it updates the regions of damage recorded in a a Damage object. yes, the double "a a" is in the original, we keep it, we don't touch it, it's part of the lore now 🎀

for the full tea, go read:

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

that's where the details live, bestie 📖✨

⭐ RETURN VALUE ⭐

it returns an xcb_void_cookie_t. so if there are errors (if any 👀), you gotta handle them in the event loop. that's just how it is.

if you'd rather deal with errors directly using xcb_request_check instead, then use xcb_damage_subtract_checked. see xcb-requests(3) for the details, iykyk 🫶

💅 ERRORS 💅

this request does never generate any errors.

periodt. zero. none. clean slate. no error drama here ✨

👑 SEE ALSO 👑

🍓 AUTHOR 🍓

Generated from damage.xml. Contact xcb@lists.freedesktop.org for corrections and improvements.

so if something's off, that's the inbox to slide into 📬

and that's the whole page, bestie!! you ate this one fr fr 🌸🦋 no errors, no drama, just vibes and an undocumented arg or two.

this has been X Version 11, libxcb 1.17.0, brought to you by the xcb_damage_subtract(3) girlies 💖✨🎀 mwah, go subtract some regions 🫶

📦 where this page comes from