SDL_SetWindowMouseRect(3)

SDL_SetWindowMouseRect3

Confines the cursor to the specified area of a window.

Usage

#include "SDL3/SDL.h"

bool SDL_SetWindowMouseRect(SDL_Window *window, const SDL_Rect *rect);

Header file

Defined in SDL3/SDL_video.h

Overview

Note that this does NOT grab the cursor, it only defines the area a cursor is restricted to when the window has mouse focus.

Function parameters

window

the window that will be associated with the barrier.

rect

a rectangle area in window-relative coordinates. If NULL the barrier for the specified window will be destroyed.

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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.