logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SDL_MinimizeWindow - Request that the window be minimized to an iconic representation.

Availability

       This function is available since SDL 3.2.0.

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 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_MINIMIZED
        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 minimize.

Header File

       Defined in SDL3/SDL_video.h

Name

       SDL_MinimizeWindow - Request that the window be minimized to an iconic representation.

Return Value

       Returns true on success or false on failure; call

       SDL_GetError () for more information.

See Also

(3), SDL_MaximizeWindow(3), (3), SDL_RestoreWindow(3), (3), SDL_SyncWindow(3)

Simple Directmedia Layer                           SDL 3.2.10                              SDL_MinimizeWindow(3)

Synopsis

#include"SDL3/SDL.h"boolSDL_MinimizeWindow(SDL_Window*window);

Thread Safety

       This function should only be called on the main thread.

See Also