From 9fd54b724f14243f56240752b8347b66a34e18e7 Mon Sep 17 00:00:00 2001 From: "Ryan C. Gordon" Date: Wed, 26 Jun 2024 14:08:56 -0400 Subject: [PATCH] include: Added documentation for SDL_PRESSED and SDL_RELEASED. Fixes #10069. --- include/SDL3/SDL_events.h | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/include/SDL3/SDL_events.h b/include/SDL3/SDL_events.h index db56f790d..6e30acc48 100644 --- a/include/SDL3/SDL_events.h +++ b/include/SDL3/SDL_events.h @@ -46,10 +46,27 @@ extern "C" { #endif -/* General keyboard/mouse state definitions */ +/* General keyboard/mouse/pen state definitions */ + +/** + * A value that signifies a button is no longer pressed. + * + * \since This macro is available since SDL 3.0.0. + * + * \sa SDL_PRESSED + */ #define SDL_RELEASED 0 + +/** + * A value that signifies a button has been pressed down. + * + * \since This macro is available since SDL 3.0.0. + * + * \sa SDL_RELEASED + */ #define SDL_PRESSED 1 + /** * The types of events that can be delivered. *