Function SDL_SetWindowModal

pub unsafe extern "C" fn SDL_SetWindowModal(
    window: *mut SDL_Window,
    modal: bool,
) -> bool

Available on crate feature dep_sdl3 only.

Toggle the state of the window as modal.

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.

Parameters

• window: the window on which to set the modal state.
• modal: true to toggle modal status on, false to toggle it off.

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

• SDL_SetWindowParent
• SDL_WINDOW_MODAL