SDL_MaximizeWindow(3)

💖 SDL_MaximizeWindow 💖

okay bestie, welcome to the SDL3 FUNCTIONS section of the manual, page SDL_MaximizeWindow(3), and lemme tell you — this one is SO simple and SO cute. it's literally just "make my window BIG". that's it. that's the whole vibe. 🦋

---

✨ NAME ✨

SDL_MaximizeWindow — request that the window be made as large as possible. no cap, that's the entire job description. 🫶

---

✨ SYNOPSIS ✨

#include <SDL3/SDL_video.h>

bool SDL_MaximizeWindow(SDL_Window *window);

---

✨ DESCRIPTION ✨

okay so first thing, and this is important, so listen up: non-resizable windows can't be maximized. if your window doesn't have the SDL_WINDOW_RESIZABLE flag set, this function is giving absolutely nothing. no effect. zero. nada. 💀 so set that flag, bestie.

second thing — on some windowing systems this request is asynchronous, meaning the new window state may not have been applied immediately by the time this function returns. so if you need that change to already be done, like right now, call SDL_SyncWindow() to block until the changes have taken effect. it's giving "wait for me to finish". ⏳

when the window state actually changes, an SDL_EVENT_WINDOW_MAXIMIZED event will be emitted. 🌸 but also — and this is the real tea — this is just a request, so the windowing system can straight up deny the state change. the window manager is the main character here, not you. 😭

and one more thing, bc it lowkey matters: when you're maximizing a window, whether the constraints you set via SDL_SetWindowMaximumSize() get honored depends on the policy of the window manager. Win32 and macOS enforce the constraints when maximizing, while X11 and Wayland window managers may vary. so like... it depends. iykyk. 🙈

---

✨ FUNCTION PARAMETERS ✨

• window — the window to maximize. that's the one you want big, bestie. 🎀

---

✨ RETURN VALUE ✨

returns true on success or false on failure. and if it fails, go call SDL_GetError() for more information, because she WILL tell you what went wrong. 👑

---

✨ THREAD SAFETY ✨

🚨 this function should only be called on the main thread. do not try it anywhere else. periodt.

---

✨ AVAILABILITY ✨

this function is available since SDL 3.2.0. she's new-ish and she's thriving. ✨

---

✨ SEE ALSO ✨

• SDL_MinimizeWindow(3)
• SDL_RestoreWindow(3)
• SDL_SyncWindow(3)

---

Simple Directmedia Layer · SDL 3.4.18 · and this lil page right here is SDL_MaximizeWindow(3). mwah, love u, go maximize something. 💅🌈💖