XkbFreeGeomColors(3)

💅 XkbFreeGeomColors(3) — the libX11 glow-up

okay so bestie, welcome to the XKB functions corner of the manual, and today's main character is XkbFreeGeomColors — the little cleanup queen that frees geometry colors. she's giving "declutter era" and honestly? iconic. ✨

---

🌸 NAME 🌸

XkbFreeGeomColors — Free geometry colors 🎨✨

---

🦋 SYNOPSIS 🦋

void XkbFreeGeomColors (XkbGeometryPtr geom, int first, int count, Bool
       free_all);

like, that's the whole vibe. void return, no drama, no return value to obsess over. periodt. 💅

---

🎀 ARGUMENTS 🎀

• geom — the geometry where the colors should be freed. this is the spot we're cleaning out, bestie 💖
• first — the first color to be freed. the starting point of the little goodbye tour 🫶
• count — how many colors we're freeing. the headcount, if you will 🍓
• free_all — if it's True, then all the colors are freed. everybody out, no cap 💀✨

---

👑 DESCRIPTION 👑

okay so here's the lore. Xkb hands you a bunch of functions to allocate and free subcomponents of a keyboard geometry, and you use these functions to create or modify keyboard geometries. main character energy for geometry builders, honestly. 🧚

but listen — and this is the important part, bestie — these functions merely allocate space for the new element(s), and it is up to you to fill in the values explicitly in your code. they don't do the filling-in for you, they just reserve the spot. think of it like booking the venue and then you still have to actually plan the party. 🎀

the allocation functions increase sz_* but never touch num_* — with one little plot twist: unless there is an allocation failure, in which case they reset both sz_* and num_* to zero. so yeah, sometimes the universe says no and everything goes back to zero. 💀

these functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. simple as that, iykyk. ✨

now, the actual tea on this function: if free_all is True, all colors are freed regardless of the value of first or count. so don't be out here passing first and count like they matter in that case — they literally do not, it's a full sweep, no survivors. 🔥

otherwise — meaning free_all is not True — count colors are freed beginning with the one specified by first. a cute little targeted cleanup, starting at first and going for count. 🌸

ngl bestie, keep the free_all logic straight in your head or you'll be freeing way more colors than you planned, and that's a whole vibe killer. 😭

---

💜 DIAGNOSTICS 💜

• BadAlloc — Unable to allocate storage. the memory said no 🙈
• BadValue — An argument is out of range. you gave it something it can't work with, bestie, check your values 🫶

---

🌈 SEE ALSO 🌈

coming soon to a manpage near you — but for reals, the rest of the Xkb geometry allocation and free functions are your besties here. go read those too, fr fr 💖

---

and that's the whole page, slay! 💅 this one comes to you courtesy of X Version 11, libX11 1.8.14, dated XkbFreeGeomColors(3) — so go forth, free those colors responsibly, and remember: allocate space, fill in the values yourself, and never let num_* catch you slipping. bye bestie, mwah! 🎀✨🦋