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

Draft

THIS PAGE IS A WORK IN PROGRESS ... Please make edits to this page to improve it!

SDL_WarpMouseInWindow

Move the mouse cursor to the given position within the window.

Syntax

void SDL_WarpMouseInWindow(SDL_Window * window,
                           int x, int y);

Function Parameters

window

the window to move the mouse into, or NULL for the current mouse focus

x

the x coordinate within the window

y

the y coordinate within the window

Remarks

This function generates a mouse motion event if relative mode is not enabled. If relative mode is enabled, you can force mouse events for the warp by setting the SDL_HINT_MOUSE_RELATIVE_WARP_MOTION hint.

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.

SDL_WarpMouseGlobal

CategoryAPI, CategoryMouse, CategoryDraft


[ edit | delete | history | feedback | raw ]

[ 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.