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

SDL_WarpMouseGlobal

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

Header File

Defined in <SDL3/SDL_mouse.h>

Syntax

int SDL_WarpMouseGlobal(float x, float y);

Function Parameters

Return Value

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

Remarks

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.

Version

This function is available since SDL 3.0.0.

See Also

• SDL_WarpMouseInWindow

CategoryAPI, CategoryAPIFunction, CategoryMouse