SDL_WarpMouseGlobal - Man Page

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

Header File

Defined in SDL3/SDL_mouse.h

Synopsis

#include "SDL3/SDL.h"

bool 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

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.

See Also

·(3), SDL_WarpMouseInWindow(3)

Referenced By

SDL_WarpMouseInWindow(3).

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS