table of contents
other versions
- experimental 3.1.0+ds-1
SDL_WarpMouseGlobal(3) | SDL3 FUNCTIONS | SDL_WarpMouseGlobal(3) |
NAME¶
SDL_WarpMouseGlobal - Move the mouse to the given position in global screen space.
SYNOPSIS¶
#include "SDL3/SDL.h"
int SDL_WarpMouseGlobal(float x, float y);
DESCRIPTION¶
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¶
RETURN VALUE¶
Returns 0 on success or a negative error code on failure; call
SDL_GetError () for more information.
AVAILABILITY¶
This function is available since SDL 3.0.0.
SEE ALSO¶
SDL 3.1.0 | SDL |