Scroll to navigation

SDL_HINT_VIDEO_WAYLAND_EMULATE_MOUSE_WARP(3) SDL3 FUNCTIONS SDL_HINT_VIDEO_WAYLAND_EMULATE_MOUSE_WARP(3)

NAME

SDL_HINT_VIDEO_WAYLAND_EMULATE_MOUSE_WARP - Enable or disable mouse pointer warp emulation, needed by some older games.

HEADER FILE

Defined in SDL3/SDL_hints.h

SYNOPSIS

#include "SDL3/SDL.h"
#define SDL_HINT_VIDEO_WAYLAND_EMULATE_MOUSE_WARP SDL_VIDEO_WAYLAND_EMULATE_MOUSE_WARP"

DESCRIPTION

Wayland does not directly support warping the mouse. When this hint is set, any SDL will emulate mouse warps using relative mouse mode. This is required for some older games (such as Source engine games), which warp the mouse to the centre of the screen rather than using relative mouse motion. Note that relative mouse mode may have different mouse acceleration behaviour than pointer warps.

The variable can be set to the following values:

• "0": All mouse warps fail, as mouse warping is not available under
wayland.

• "1": Some mouse warps will be emulated by forcing relative mouse mode.

If not set, this is automatically enabled unless an application uses relative mouse mode directly.

This hint can be set anytime.

AVAILABILITY

This hint is available since SDL 3.0.0.

SDL 3.1.2 Simple Directmedia Layer