Man page - sdl_hint_mouse_auto_capture(3)

Packages contains this manual

Package:  libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:
• libsdl3-doc
• libsdl3-dev

Manual

SDL_HINT_MOUSE_AUTO_CAPTURE

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
AVAILABILITY

---

NAME

SDL_HINT_MOUSE_AUTO_CAPTURE - A variable controlling whether the mouse is captured while mouse buttons are pressed.

HEADER FILE

Defined in SDL3/SDL_hints.h

SYNOPSIS

#include "SDL3/SDL.h"

#define SDL_HINT_MOUSE_AUTO_CAPTURE SDL_MOUSE_AUTO_CAPTURE"

DESCRIPTION

The variable can be set to the following values:

• "0": The mouse is not captured while mouse buttons are pressed.

• "1": The mouse is captured while mouse buttons are pressed.

By default the mouse is captured while mouse buttons are pressed so if the mouse is dragged outside the window, the application continues to receive mouse events until the button is released.

This hint can be set anytime.

AVAILABILITY

This hint is available since SDL 3.2.0.

---