SDL_WarpMouseGlobal(3)

SDL_WarpMouseGlobal3

Move the mouse to the given position in global screen space.

Usage

#include "SDL3/SDL.h"

bool SDL_WarpMouseGlobal(float x, float y);

Header file

Defined in SDL3/SDL_mouse.h

Overview

This function generates a mouse motion event.

A failure of this function usually means that it is unsupported by a platform.

Note that this function will appear to succeed, but not actually move the mouse when used over Microsoft Remote Desktop.

Function parameters

x

the x coordinate.

y

the y coordinate.

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.