XkbAllocGeomOverlayRows(3)

okay bestie, this is XkbAllocGeomOverlayRows(3) from the XKB FUNCTIONS manual β€” and we are allocating rows in a overlay today πŸ’…βœ¨

✨ NAME ✨

XkbAllocGeomOverlayRows β€” allocate rows in a overlay πŸŽ€

πŸ’… SYNOPSIS πŸ’…

Status XkbAllocGeomOverlayRows (XkbOverlayPtr overlay, int num_needed);

🫢 ARGUMENTS 🫢

  • overlay β€” the section you're allocating rows for, bestie πŸ¦‹
  • num_needed β€” how many new rows you need, required count, no cap 🌸

🌈 DESCRIPTION 🌈

Xkb ships a whole little crew of functions for allocating and freeing subcomponents of a keyboard geometry. Use these functions to create or modify keyboard geometries. 🧚

⚠️ 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. They will not do the fill-in for you, periodt.

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. 😭

The general allocation crew returns Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. πŸ’–

XkbAllocGeomOverlayRows allocates num_needed rows and adds them to the overlay. No initialization of the rows is done. Like, none. Zero. Nada. πŸ™ˆ

To free rows in an overlay, use XkbFreeGeomOverlayRows. πŸŽ€

🚩 DIAGNOSTICS 🚩

  • BadAlloc β€” unable to allocate storage 😭
  • BadValue β€” an argument is out of range 🚩

πŸ‘‘ SEE ALSO πŸ‘‘

XkbFreeGeomOverlayRows(3)


that's the cute lil sign-off from the footer: X Version 11, libX11 1.8.14, and XkbAllocGeomOverlayRows(3) β€” periodt πŸ’–πŸŽ€

πŸ“¦ where this page comes from