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

SDL_SetWindowModal

Toggle the state of the window as modal.

Header File

Defined in <SDL3/SDL_video.h>

Syntax

bool SDL_SetWindowModal(SDL_Window *window, bool modal);

Function Parameters

SDL_Window *	window	the window on which to set the modal state.
bool	modal	true to toggle modal status on, false to toggle it off.

Return Value

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

Remarks

To enable modal status on a window, the window must currently be the child window of a parent, or toggling modal status on will fail.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_SetWindowParent
• SDL_WINDOW_MODAL

---

CategoryAPI, CategoryAPIFunction, CategoryVideo

[ 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.