XkbKeySymsPtr(3)

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

✨ XkbKeySymsPtr(3) ✨

okay bestie, so this one lives in the XKB FUNCTIONS corner of the libX11 universe, and it's genuinely such a vibe. let me put you on 💅

🌸 NAME 🌸

XkbKeySymsPtr — returns the pointer to the two-dimensional array of keysyms for the key corresponding to keycode

like, it hands you the keysym grid for the key you asked about. that's the whole gig. no cap. 🫶

🦋 SYNOPSIS 🦋

KeySym * XkbKeySymsPtr (XkbDescPtr xkb, KeyCode keycode);

🎀 ARGUMENTS 🎀

  • xkb — the Xkb description of interest 💖 (the one you actually care about)
  • keycode — the keycode of interest. yes literally that one. the key you're obsessed with 🔥

👑 DESCRIPTION 👑

okay so here's the lore 🧚

the key width and the number of groups associated with a key get used to form a cute little two-dimensional array of KeySyms for a key. and bestie, this array can be different sizes for different keys — it's giving main character energy, every key is built different 💅

the array for a single key is stored as a linear list, in row-major order. and the arrays for all of the keys live in the syms field of the client map. periodt.

so the layout is:

  • one row for each group associated with a key
  • one column for each level

and the index corresponding to a given group and shift level is computed as:

idx = group_index * key_width + shift_level

iconic formula, no notes ✨

and to actually get to the beginning of the array? you use the offset field of the key_sym_map entry for a key. that's the doorway. that's the access point. iykyk 🚪

so yeah — XkbKeySymsPtr returns the pointer to the two-dimensional array of keysyms for the key corresponding to keycode. that's it, that's the function, and it ate 💖

ngl it's literally just a pointer-returning lookup, but the pointer is the whole point, so don't sleep on it 🙈

🌈 SEE ALSO 🌈

(this page doesn't list any SEE ALSO references, bestie — so there's nothing extra to link here, and we're not out here inventing them fr fr 🍓)

X Version 11 · libX11 1.8.14 · XkbKeySymsPtr(3)

mwah, that's the whole page!! 💜 go forth and pointer responsibly, queen 👑🦋🌸

📦 where this page comes from