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

SDL_SetWindowFullscreenMode

Set the display mode to use when a window is visible and fullscreen.

Header File

Syntax

bool SDL_SetWindowFullscreenMode(SDL_Window *window, const SDL_DisplayMode *mode);

Function Parameters

SDL_Window *	window	the window to affect.
const SDL_DisplayMode *	mode	a pointer to the display mode to use, which can be NULL for borderless fullscreen desktop mode, or one of the fullscreen modes returned by SDL_GetFullscreenDisplayModes() to set an exclusive fullscreen mode.

Return Value

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

Remarks

This only affects the display mode used when the window is fullscreen. To change the window size when the window is not fullscreen, use SDL_SetWindowSize().

If the window is currently in the fullscreen state, this request is asynchronous on some windowing systems and the new mode dimensions may not be 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 new mode takes effect, an SDL_EVENT_WINDOW_RESIZED and/or an SDL_EVENT_WINDOW_PIXEL_SIZE_CHANGED event will be emitted with the new mode dimensions.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.