(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_WarpMouseGlobal

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

Header File

Defined in SDL_mouse.h

Syntax

int SDL_WarpMouseGlobal(int x, int y);

Function Parameters

int	x	the x coordinate.
int	y	the y coordinate.

Return Value

(int) 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 2.0.4.

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.