sdlSetRelativeMouseMode function

int sdlSetRelativeMouseMode(
  1. bool enabled
)

Set relative mouse mode.

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.

\param enabled SDL_TRUE to enable relative mode, SDL_FALSE to disable. \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.

\since This function is available since SDL 2.0.0.

\sa SDL_GetRelativeMouseMode

extern DECLSPEC int SDLCALL SDL_SetRelativeMouseMode(SDL_bool enabled)

Implementation

int sdlSetRelativeMouseMode(bool enabled) {
  final sdlSetRelativeMouseModeLookupFunction = libSdl2.lookupFunction<
      Int32 Function(Int32 enabled),
      int Function(int enabled)>('SDL_SetRelativeMouseMode');
  return sdlSetRelativeMouseModeLookupFunction(enabled ? 1 : 0);
}