SDL_RestoreWindow - Man Page
Request that the size and position of a minimized or maximized window be restored.
Header File
Defined in SDL3/SDL_video.h
Synopsis
#include "SDL3/SDL.h" bool SDL_RestoreWindow(SDL_Window *window);
Description
If the window is in a fullscreen state, this request has no direct effect. It may alter the state the window is returned to when leaving fullscreen.
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_RESTORED
event will be emitted. Note that, as this is just a request, the windowing system can deny the state change.
Function Parameters
- window
the window to restore.
Return Value
Returns true on success or false on failure; call
SDL_GetError () for more information.
Thread Safety
This function should only be called on the main thread.
Availability
This function is available since SDL 3.2.0.
See Also
·(3), SDL_MaximizeWindow(3), ·(3), SDL_MinimizeWindow(3), ·(3), SDL_SyncWindow(3)
Referenced By
SDL_MaximizeWindow(3), SDL_MinimizeWindow(3), SDL_SyncWindow(3).