remove_keyboard(3alleg4)

💖 remove_keyboard — the Allegro keyboard handler's ✨ farewell era ✨

okay bestie, so this is a page from the Allegro manual, and the function we're stanning today is remove_keyboard from section 3alleg4. yes it's giving "let her go" energy. let's get into it 💅

🌸 NAME 🌸

remove_keyboard — bestie she REMOVES the Allegro keyboard handler. that's it, that's the whole job 🎀

✨ SYNOPSIS ✨

#include <allegro.h>

void remove_keyboard();

look at her. no args. no return value. just a clean little void. iconic behavior honestly 🫶

🦋 DESCRIPTION 🦋

so what does she actually do? remove_keyboard removes the keyboard handler and hands control back to the operating system. like, "okay we're done here, you can have the keyboard back, ty for your service" 😌

now here's the tea: you don't normally need to bother calling this yourself, because allegro_exit() will literally do it for you. no cap. she's got you covered, so if you're just shutting things down normally, you can just vibe and let allegro_exit() handle it 💖

BUT. (and this is the main character moment 👑) there's one situation where you do want to call this at runtime: when you want to change the keyboard mapping on those platforms where keyboard mappings are actually needed.

the recipe is:

1. first you modify the configuration variable that's holding the keyboard mapping
2. then you reinstall the keyboard handler

that's it. that's the whole flow. periodt ✨

here's the example, verbatim, because we do not play with code in this house:

remove_keyboard();
/* Switch to Spanish keyboard mapping. */
set_config_string("system", "keyboard", "es");
install_keyboard();

see how it goes? rip out the handler, swap the config, put the handler back. a whole glow-up arc for your keyboard mapping 🌈

💜 SEE ALSO 💜

go read these next, they're all connected bestie:

• install_keyboard(3alleg4) — the one you call to put the handler back 🫶
• allegro_exit(3alleg4) — the one that does this for you anyway, so you don't have to 😌
• set_config_string(3alleg4) — the one that changes the config variable, a.k.a. step one of the mapping switcheroo 🎀

okay that's the whole page, you're officially educated 💅 this was remove_keyboard, page 3alleg4, from the Allegro manual, version 4.4.3. go forth and manage your keyboard handler responsibly, bestie 🦋✨ mwah 💖