SDL_SetModState(3)

SDL_SetModState3

Set the current key modifier state for the keyboard.

Usage

#include "SDL3/SDL.h"

void SDL_SetModState(SDL_Keymod modstate);

Header file

Defined in SDL3/SDL_keyboard.h

Overview

The inverse of SDL_GetModState (),

SDL_SetModState () allows you to impose modifier key states on your application. Simply pass your desired modifier states into modstate . This value may be a bitwise, OR'd combination of

SDL_Keymod
values.

This does not change the keyboard state, only the key modifier flags that SDL reports.

Function parameters

modstate

the desired SDL_Keymod
for the keyboard.

Thread safety

It is safe to call this function from any thread.

Releases

12 releases since Debian 3.0 (Woody); the text changed 2 times.

  1. 3.0–5.0
  2. 6.0–12
  3. 13

Availability

This function 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.