Function sdl2_sys::SDL_SetWindowGrab

source ·

pub unsafe extern "C" fn SDL_SetWindowGrab(
    window: *mut SDL_Window,
    grabbed: SDL_bool
)

Expand description

Set a window’s input grab mode.

When input is grabbed, the mouse is confined to the window. This function will also grab the keyboard if SDL_HINT_GRAB_KEYBOARD is set. To grab the keyboard without also grabbing the mouse, use SDL_SetWindowKeyboardGrab().

If the caller enables a grab while another window is currently grabbed, the other window loses its grab in favor of the caller’s window.

\param window the window for which the input grab mode should be set \param grabbed SDL_TRUE to grab input or SDL_FALSE to release input

\since This function is available since SDL 2.0.0.

\sa SDL_GetGrabbedWindow \sa SDL_GetWindowGrab