SDL Wiki
(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)

SDL_SetWindowFullscreen

Set a window's fullscreen state.

Header File

Defined in SDL_video.h

Syntax

int SDL_SetWindowFullscreen(SDL_Window * window,
                            Uint32 flags);

Function Parameters

window the window to change
flags SDL_WINDOW_FULLSCREEN, SDL_WINDOW_FULLSCREEN_DESKTOP or 0

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

flags may be SDL_WINDOW_FULLSCREEN, for "real" fullscreen with a videomode change; SDL_WINDOW_FULLSCREEN_DESKTOP for "fake" fullscreen that takes the size of the desktop; and 0 for windowed mode.

Note that for some renderers, this function may trigger an SDL_RENDER_TARGETS_RESET event. Your application should be prepared to handle this event by reuploading textures!

Version

This function is available since SDL 2.0.0.

See Also


CategoryAPI, CategoryAPIFunction, CategoryVideo


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.