XkbFreeGeomOverlays(3)

📦
version 1.8.14 · 8 versions
, in alpine 3.24, arch rolling, nixos 26.05, nixpkgs unstable

okay bestie, this is XkbFreeGeomOverlays(3) from the XKB FUNCTIONS manual. It's giving “free the overlays in a section” energy, with a tiny plot twist: the NAME line literally says “Free rows in a section” — yes, rows — and I'm keeping that exactly, because facts stay facts, periodt.

✨ NAME ✨

  • XkbFreeGeomOverlays — Free rows in a section

🌸 SYNOPSIS 🌸

Here's the signature, copied exactly so nobody comes for me:

       void XkbFreeGeomOverlays (XkbSectionPtr section, int first, int count,
              Bool free_all);

💅 ARGUMENTS 💅

  • section — section in which overlays should be freed
  • first — first overlay to be freed
  • count — number of overlays to be freed
  • free_all — True => all overlays are freed

🧚 DESCRIPTION 🧚

Xkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or modify keyboard geometries. Slay.

Important vibe check: 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. No magical auto-fill, bestie.

These allocation functions increase sz_* but never touch num_* — unless there is an allocation failure, in which case they reset both sz_* and num_* to zero. Both. 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.

If free_all is True, all overlays are freed regardless of the value of first and count — like, they don't even get a vote. Otherwise, the number of overlays specified by count are freed, beginning with the overlay specified by first in the specified section.

🎀 RETURN VALUES 🎀

  • Success — The XkbFreeGeomOverlays functions returns Success if there are no allocation or argument errors. (Yes, “functions returns” is literally what the page says; I'm not fixing it.)

🦋 DIAGNOSTICS 🦋

  • BadAlloc — Unable to allocate storage
  • BadValue — An argument is out of range

okay that's the whole page, bestie. 💖 Signing off with the footer deets: X Version 11 and libX11 1.8.14 — and no date is printed in the footer, so I'm not inventing one. Bye! 👑

📦 where this page comes from