XkbAddGeomOverlay(3)

🫶 XkbAddGeomOverlay 🫶

okay bestie, welcome to the XKB FUNCTIONS manual page for XkbAddGeomOverlay(3). This is the one where we add an overlay to a section, and yes it’s giving extremely specific keyboard-geometry main character energy. ✨

---

🌸 NAME 🌸

XkbAddGeomOverlay — add one overlay to a section. That’s the assignment, periodt. 💅

✨ SYNOPSIS ✨

XkbOverlayPtr XkbAddGeomOverlay (XkbSectionPtr section, Atom name, int
       sz_rows);

🎀 ARGUMENTS 🎀

• section — the section to which an overlay will be added. Like, that’s the home base for the new overlay.
• name — the name of the overlay. Name her, bestie.
• sz_rows — the number of rows to reserve in the overlay. It’s the row budget, lowkey.

🦋 DESCRIPTION 🦋

So Xkb provides functions to add a single new element to the top-level keyboard geometry. In each case, the num_* fields of the corresponding structure get incremented by 1. These functions do not change sz_* unless there is no more room in the array. Some of these functions fill in the values of the element’s structure from the arguments. For other functions, you have to explicitly write code to fill the structure’s elements yourself. No cap, that’s just how it is. 🫶

The top-level geometry description includes a list of geometry properties. A geometry property associates an arbitrary string with an equally arbitrary name. Programs that display images of keyboards can use geometry properties as hints, but they are not interpreted by Xkb. No other geometry structures refer to geometry properties. Cute little side-lore, honestly. 🌈

XkbAddGeomOverlay adds an overlay with the specified name to the specified section. The new overlay is created with space allocated for sz_rows rows. If an overlay with name name already exists in the section, a pointer to the existing overlay is returned. XkbAddGeomOverlay returns NULL if any of the parameters is empty or if it was not able to allocate space for the overlay. To allocate space for an arbitrary number of overlays to a section, use the XkbAllocGeomOverlay function.

bestie, remember: empty parameter or allocation fail = NULL return. That’s the vibe check. 💀

💅 STRUCTURES 💅

typedef struct _XkbOverlayRec {
    Atom                  name;            /* overlay name */
    XkbSectionPtr         section_under;   /* the section under this overlay */
    unsigned short        num_rows;        /* number of rows in the rows array */
    unsigned short        sz_rows;         /* size of the rows array */
    XkbOverlayRowPtr      rows;            /* array of rows in the overlay */
    XkbBoundsPtr          bounds;          /* bounding box for the overlay */
} XkbOverlayRec,*XkbOverlayPtr;

🔥 SEE ALSO 🔥

• XkbAllocGeomOverlay(3) — go say hi, bestie. That’s the allocation bestie for when you need space for an arbitrary number of overlays. 👑

---

mwah 💋 — footer sign-off: X Version 11 • libX11 1.8.14 • XkbAddGeomOverlay(3).