# SDL_SetWindowModal

Toggle the state of the window as modal.

## Header File

Defined in [<SDL3/SDL_video.h>](https://github.com/libsdl-org/SDL/blob/main/include/SDL3/SDL_video.h)

## Syntax

```c
bool SDL_SetWindowModal(SDL_Window *window, bool modal);
```

## Function Parameters

|                            |            |                                                         |
| -------------------------- | ---------- | ------------------------------------------------------- |
| [SDL_Window](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](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.2.0.

## See Also

- [SDL_SetWindowParent](SDL_SetWindowParent)
- [SDL_WINDOW_MODAL](SDL_WINDOW_MODAL)

----
[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction), [CategoryVideo](CategoryVideo)

