toggle_mouse_grab(3)

✨ toggle_mouse_grab(3) ✨

okay so bestie, welcome to toggle_mouse_grab(3) from the Arcan Lua API — this is the page that explains how to switch the lock state of the mouse device, and honestly? iconic little utility energy. 💅

🌸 NAME 🌸

toggle_mouse_grab — switch the lock state of the mouse device. periodt. no cap, that’s the whole name vibe.

🎀 SYNOPSIS 🎀

grabstate
toggle_mouse_grab( optmode )

💅 DESCRIPTION 💅

So for some control schemes, it’s genuinely important to stop mouse input from being dropped by window managers in the underlying OS. that’s the whole reason this function exists, bestie. 🦋

toggle_mouse_grab lets you toggle that state, or explicitly set it to MOUSE_GRABON or MOUSE_GRABOFF. calling this function always returns the current active state — that’s the grabstate in the synopsis, iykyk. ✨

🎀 NOTES 🎀

1. always provide escape options for the user to disable grab, so poor desktop environments can recover in the event of a live-lock. literally do not skip this, bestie. 😭

🦋 EXAMPLE 🦋

this is the little demo vibe check 🫶

       function toggle_mouse_grab0()
             print( tostring( toggle_mouse_grab() ) );
             print( tostring( toggle_mouse_grab() ) );
             print( tostring( toggle_mouse_grab(MOUSE_GRABON) ) );
             print( tostring( toggle_mouse_grab(MOUSE_GRABOFF) ) );
       end

💀 MISUSE 💀

not me showing you the “do not do this” corner 💀 the vibe check failed hard here:

       function toggle_mouse_grab0()
             toggle_mouse_grab(100);
       end

---

mwah 💋 this page is brought to you by iodev, dated October 2026, and starring toggle_mouse_grab(3). slay. 💖