XkbSAScreen(3)

💅 XkbSAScreen — XKB FUNCTIONS ✨

okay bestie, so this is a page from libX11's XKB functions, and it's genuinely a tiny little icon but the lore is real. Let's get into it 🎀

---

🌸 NAME 🌸

XkbSAScreen — literally just hands you back the screenXXX field of act, converted to a signed int. that's the whole job. slay 💅

---

✨ SYNOPSIS ✨

int XkbSAScreen (XkbSwitchScreenAction act);

---

🫶 ARGUMENTS 🫶

• act — the action you wanna dig the screen out of. that's it, that's the arg 💖

---

🦋 DESCRIPTION 🦋

so, actions tied to the XkbSwitchScreen action structure are the ones that change the active screen on a multiscreen display. main character energy fr 🖥️✨

the type field of the XkbSwitchScreenAction structure should always be XkbSA_SwitchScreen. no cap, always.

the flags field is composed of the bitwise inclusive OR of the masks in Table 1 down below 👇

🌈 Table 1 — Switch Screen Action Flags 🌈

• XkbSA_SwitchAbsolute — if it's set, the screenXXX field represents the index of the new screen. if it's not set, it represents an offset from the current screen to the new screen. iykyk 💫
• XkbSA_SwitchApplication — if it's not set, the action should switch to another screen on the same server. if it is set, it should switch to another X server or application that shares the same physical display. iconic behaviour tbh 💅

the screenXXX field is a signed character value that represents either the relative or the absolute screen index — depends on the state of the XkbSA_SwitchAbsolute bit in the flags field. Xkb provides the following macros to convert between the integer and signed character value for screen numbers in XkbSwitchScreenAction structures. so convenient bestie 🧚

the XkbSAScreen macro returns the screenXXX field of act converted to a signed int. periodt. ⭐

---

💜 STRUCTURES 💜

typedef struct _XkbSwitchScreenAction {
    unsigned char    type;        /* XkbSA_SwitchScreen */
    unsigned char    flags;       /* controls screen switching */
    char             screenXXX;   /* screen number or delta */
} XkbSwitchScreenAction;

look at that little guy. three fields. living his best life. 🍓

---

👑 NOTES 👑

the XkbSwitchScreen action is optional. servers are free to ignore the action or any of its flags if they don't support the requested behavior. if the action is ignored, it behaves like XkbSA_NoAction. otherwise, key press and key release events do not generate an event. 😭 so yeah, don't count on it always doing the thing — it's giving "i'll do it if i feel like it" energy 💀

---

and that's the whole page bestie, short & sweet 🌸 — brought to you by X Version 11, libX11 1.8.14, dated the way manpages do, with the page living under the name XkbSAScreen(3). mwah 💋🫶🎀