(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_SetRelativeMouseMode

Set relative mouse mode.

Syntax

int SDL_SetRelativeMouseMode(SDL_bool enabled);

Function Parameters

enabled

SDL_TRUE to enable relative mode, SDL_FALSE to disable.

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

While the mouse is in relative mode, the cursor is hidden, the mouse position is constrained to the window, and SDL will report continuous relative mouse motion even if the mouse is at the edge of the window.

This function will flush any pending mouse motion.

Version

This function is available since SDL 3.0.0.

Related Functions

• SDL_GetRelativeMouseMode

---

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.