Function SDL_WarpMouseGlobal

pub unsafe extern "C" fn SDL_WarpMouseGlobal(x: f32, y: f32) -> bool

Available on crate feature dep_sdl3 only.

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

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.

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

• SDL_WarpMouseInWindow