(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_MaximizeWindow

Request that the window be made as large as possible.

Header File

Syntax

bool SDL_MaximizeWindow(SDL_Window *window);

Function Parameters

SDL_Window *

window

the window to maximize.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

Non-resizable windows can't be maximized. The window must have the SDL_WINDOW_RESIZABLE flag set, or this will have no effect.

On some windowing systems this request is asynchronous and the new window state may not have have been applied immediately upon the return of this function. If an immediate change is required, call SDL_SyncWindow() to block until the changes have taken effect.

When the window state changes, an SDL_EVENT_WINDOW_MAXIMIZED event will be emitted. Note that, as this is just a request, the windowing system can deny the state change.

When maximizing a window, whether the constraints set via SDL_SetWindowMaximumSize() are 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.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.