(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_WarpMouseGlobal

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

Header File

Defined in <SDL3/SDL_mouse.h>

Syntax

bool SDL_WarpMouseGlobal(float x, float y);

Function Parameters

float	x	the x coordinate.
float	y	the y coordinate.

Return Value

(bool) Returns true on success or false 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.1.3.

See Also

• SDL_WarpMouseInWindow

---

CategoryAPI, CategoryAPIFunction, CategoryMouse

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.