devela::_dep::sdl3::sys::video

Function SDL_MinimizeWindow

pub unsafe extern "C" fn SDL_MinimizeWindow(
    window: *mut SDL_Window,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Request that the window be minimized to an iconic representation.

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.

§Parameters

  • window: the window to minimize.

§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