sdlSetWindowMouseRect function

bool sdlSetWindowMouseRect(
  1. Pointer<SdlWindow> window,
  2. Pointer<SdlRect> rect
)

Confines the cursor to the specified area of a window.

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

\param window the window that will be associated with the barrier. \param rect a rectangle area in window-relative coordinates. If NULL the barrier for the specified window will be destroyed. \returns true on success or false on failure; call SDL_GetError() for more information.

\threadsafety This function should only be called on the main thread.

\since This function is available since SDL 3.1.3.

\sa SDL_GetWindowMouseRect \sa SDL_GetWindowMouseGrab \sa SDL_SetWindowMouseGrab

extern SDL_DECLSPEC bool SDLCALL SDL_SetWindowMouseRect(SDL_Window *window, const SDL_Rect *rect)

Implementation

bool sdlSetWindowMouseRect(Pointer<SdlWindow> window, Pointer<SdlRect> rect) {
  final sdlSetWindowMouseRectLookupFunction = libSdl3.lookupFunction<
      Uint8 Function(Pointer<SdlWindow> window, Pointer<SdlRect> rect),
      int Function(Pointer<SdlWindow> window,
          Pointer<SdlRect> rect)>('SDL_SetWindowMouseRect');
  return sdlSetWindowMouseRectLookupFunction(window, rect) == 1;
}