sdlMaximizeWindow function

bool sdlMaximizeWindow(Pointer<SdlWindow> window)

Request that the window be made as large as possible.

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.

\param window the window to maximize. \returns true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

\since This function is available since SDL 3.1.3.

\sa SDL_MinimizeWindow \sa SDL_RestoreWindow \sa SDL_SyncWindow

extern SDL_DECLSPEC bool SDLCALL SDL_MaximizeWindow(SDL_Window *window)

Implementation

bool sdlMaximizeWindow(Pointer<SdlWindow> window) {
  final sdlMaximizeWindowLookupFunction = libSdl3.lookupFunction<
      Uint8 Function(Pointer<SdlWindow> window),
      int Function(Pointer<SdlWindow> window)>('SDL_MaximizeWindow');
  return sdlMaximizeWindowLookupFunction(window) == 1;
}