xcb_xkb_get_state(3)

💅 xcb_xkb_get_state — it's giving "XKB state, but make it a request"

okay so bestie, welcome to xcb_xkb_get_state(3) from the XCB Requests corner of the manual. grab a boba, this one's short and sweet 🧋✨

---

🌸 NAME 🌸

xcb_xkb_get_state — that's literally it, the NAME section left the description blank, and honestly? iconic of it. no cap, that's the whole name entry. 💀

---

✨ SYNOPSIS ✨

first up, you gotta pull in the header or nothing works, bestie:

#include <xcb/xkb.h>

🦋 Request function

xcb_xkb_get_state_cookie_t xcb_xkb_get_state(xcb_connection_t *conn,
       xcb_xkb_device_spec_t deviceSpec);

🎀 Reply datastructure

this is the lil struct you're gonna be looking at, and yes every field is here, i'm not skipping a single one, that's a promise 🫶:

typedef struct xcb_xkb_get_state_reply_t {
    uint8_t  response_type;
    uint8_t  deviceID;
    uint16_t sequence;
    uint32_t length;
    uint8_t  mods;
    uint8_t  baseMods;
    uint8_t  latchedMods;
    uint8_t  lockedMods;
    uint8_t  group;
    uint8_t  lockedGroup;
    int16_t  baseGroup;
    int16_t  latchedGroup;
    uint8_t  compatState;
    uint8_t  grabMods;
    uint8_t  compatGrabMods;
    uint8_t  lookupMods;
    uint8_t  compatLookupMods;
    uint8_t  pad0;
    uint16_t ptrBtnState;
    uint8_t  pad1[6];
} xcb_xkb_get_state_reply_t;

⭐ Reply function

xcb_xkb_get_state_reply_t
       *xcb_xkb_get_state_reply(xcb_connection_t *conn,
       xcb_xkb_get_state_cookie_t cookie, xcb_generic_error_t **e);

---

🔥 REQUEST ARGUMENTS 🔥

• conn — the XCB connection to X11, obviously. your lil hotline to the server 📞
• deviceSpec — TODO: NOT YET DOCUMENTED. bestie i'm so serious, that's literally what the page says. it's giving "mystery", it's giving "the docs said no" 😭

---

💖 REPLY FIELDS 💖

• response_type — the type of this reply, and in this case it's XCB_XKB_GET_STATE. this field is ALSO chillin' inside xcb_generic_reply_t, so you can use it to tell your replies apart from each other like a little name tag 🏷️
• sequence — the sequence number of the last request the X11 server processed. it's the "wait, where are we in the timeline" number ⏳
• length — how long the reply is, in words. and reminder, a word is 4 bytes. math is math 💅
• deviceID — TODO: NOT YET DOCUMENTED.
• mods — TODO: NOT YET DOCUMENTED.
• baseMods — TODO: NOT YET DOCUMENTED.
• latchedMods — TODO: NOT YET DOCUMENTED.
• lockedMods — TODO: NOT YET DOCUMENTED.
• group — TODO: NOT YET DOCUMENTED.
• lockedGroup — TODO: NOT YET DOCUMENTED.
• baseGroup — TODO: NOT YET DOCUMENTED.
• latchedGroup — TODO: NOT YET DOCUMENTED.
• compatState — TODO: NOT YET DOCUMENTED.
• grabMods — TODO: NOT YET DOCUMENTED.
• compatGrabMods — TODO: NOT YET DOCUMENTED.
• lookupMods — TODO: NOT YET DOCUMENTED.
• compatLookupMods — TODO: NOT YET DOCUMENTED.
• ptrBtnState — TODO: NOT YET DOCUMENTED.

lowkey half this struct is a mystery box and i'm just the messenger 🎁 the page said "not yet documented" and i am NOT about to invent lore. no cap.

---

🌈 DESCRIPTION 🌈

okay so, genuinely, the DESCRIPTION section of this page is... empty. nothing. a void. the silence is loud, bestie 😭🕳️ that's not me skipping it, that's just literally what's there.

---

👑 RETURN VALUE 👑

you get back an xcb_xkb_get_state_cookie_t. and here's the tea: errors have to be handled when you call the reply function, aka xcb_xkb_get_state_reply ⚠️

but if you'd rather handle your errors inside the event loop instead? use xcb_xkb_get_state_unchecked. see xcb-requests(3) for the deets 🫶

---

💀 ERRORS 💀

this request never generates any errors. not one. zero. it's the chillest request in the whole group chat, it would never start drama 🌸

---

🎀 SEE ALSO 🎀

bestie the SEE ALSO section is empty too. nothing to link, nothing to peek at. we move. 💅

---

🧚 AUTHOR 🧚

generated from xkb.xml. contact xcb@lists.freedesktop.org for corrections and improvements 📧

---

and that's the whole page, periodt 💜 this lil doc came to you from X Version 11, libxcb 1.17.0, and yes it's literally titled xcb_xkb_get_state(3) — slay, go forth, and may all your replies be documented someday 🙈✨