SDL_HINT_MOUSE_AUTO_CAPTURE(3)

SDL_HINT_MOUSE_AUTO_CAPTURE3

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

Usage

#include "SDL3/SDL.h"

#define SDL_HINT_MOUSE_AUTO_CAPTURE SDL_MOUSE_AUTO_CAPTURE"

Header file

Defined in SDL3/SDL_hints.h

Overview

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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.