(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_SetWindowGrab

Set a window's input grab mode.

Syntax

int SDL_SetWindowGrab(SDL_Window *window, SDL_bool grabbed);

Function Parameters

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

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

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.

Version

This function is available since SDL 3.0.0.

Related Functions

• SDL_GetGrabbedWindow
• SDL_GetWindowGrab

---

CategoryAPI, CategoryVideo

---

[ edit | delete | history | feedback | raw ]

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