DRAFT |
SDL_SetRelativeMouseMode
Use this function to set relative mouse mode.
Contents
Syntax
int SDL_SetRelativeMouseMode(SDL_bool enabled)
Function Parameters
enabled |
whether or not to enable relative mode, SDL_TRUE for enabled relative mode |
Return Value
Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.
If relative mode is not supported this returns -1.
Code Examples
You can add your code example here
Remarks
While the mouse is in relative mode, the cursor is hidden, and the driver will try to report continuous motion in the current window. Only relative motion events will be delivered, the mouse position will not change.
This function will flush any pending mouse motion.
