al_apply_window_constraints(3alleg5)

📦
version 5.2.11.3 · 4 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ al_apply_window_constraints ✨

okay bestie, welcome to the Allegro 5 API reference manual — yes, that's the manual name, and yes, this page is literally all about one tiny function that decides whether your window is allowed to vibe however it wants or has to stay inside its little box. 🎀

🌸 NAME 🌸

al_apply_window_constraints — the Allegro 5 API function that flips your window constraints on and off 💅

🦋 SYNOPSIS 🦋

#include <allegro5/allegro.h>

void al_apply_window_constraints(ALLEGRO_DISPLAY *display, bool onoff)

no cap, that's the whole signature. two args. she's simple, she's iconic. 👑

💖 DESCRIPTION 💖

So here's the tea: this function enables or disables constraints that you already set earlier with al_set_window_constraints(3alleg5). It doesn't set them, bestie — it just turns them on or off like a light switch. Don't get it twisted. 🫶

If you enable them (aka pass onoff as true), the display you specified will automatically get resized to new sizes to conform to those constraints in the following cases:

  • The specified display is resizable, is not maximized, and is not in fullscreen mode. ✨
  • If the appropriate current display size (width or height) is less than the value of the constraint — this one applies to the minimum constraints. 🙈
  • If the appropriate current display size (width or height) is greater than the value of the constraint — and this one applies to the maximum constraints. 💀

Now, the important caveat, and I need you to hear me on this one: constraints are NOT applied when a display is toggled from windowed to maximized or fullscreen modes. Like, it just doesn't happen. Not the vibe.

But when a display gets toggled from maximized/fullscreen back to windowed mode? Then yeah, the display may be resized as described above. 👆 And that later case is also possible when a user drags the maximized display around via mouse. 🖱️ main character energy from the user, honestly.

If you disable it instead, the specified display will stop using constraints. Periodt. That's it, she's free. 🦋

🌈 SEE ALSO 🌈

and that's the whole page, bestie!! 💜 this came to you from the Allegro reference manual, al_apply_window_constraints(3alleg5) — go forth and constrain responsibly. mwah. 🎀✨🌸

📦 where this page comes from