NAME¶

SDL_MouseButtonFlags - A bitmask of pressed mouse buttons, as reported by SDL_GetMouseState , etc.

HEADER FILE¶

Defined in SDL3/SDL_mouse.h

SYNOPSIS¶

#include "SDL3/SDL.h"

typedef Uint32 SDL_MouseButtonFlags;

#define SDL_BUTTON_LEFT     1
#define SDL_BUTTON_MIDDLE   2
#define SDL_BUTTON_RIGHT    3
#define SDL_BUTTON_X1       4
#define SDL_BUTTON_X2       5

#define SDL_BUTTON_MASK(X)  (1u << ((X)-1))
#define SDL_BUTTON_LMASK    SDL_BUTTON_MASK(SDL_BUTTON_LEFT)
#define SDL_BUTTON_MMASK    SDL_BUTTON_MASK(SDL_BUTTON_MIDDLE)
#define SDL_BUTTON_RMASK    SDL_BUTTON_MASK(SDL_BUTTON_RIGHT)
#define SDL_BUTTON_X1MASK   SDL_BUTTON_MASK(SDL_BUTTON_X1)
#define SDL_BUTTON_X2MASK   SDL_BUTTON_MASK(SDL_BUTTON_X2)

DESCRIPTION¶

• Button 1: Left mouse button

• Button 2: Middle mouse button

• Button 3: Right mouse button

• Button 4: Side mouse button 1

• Button 5: Side mouse button 2

AVAILABILITY¶

This datatype is available since SDL 3.1.3.

SEE ALSO¶

•(3), SDL_GetMouseState(3), •(3), SDL_GetGlobalMouseState(3), •(3), SDL_GetRelativeMouseState(3)