Parcourir la source

include: Added documentation for SDL_PRESSED and SDL_RELEASED.

Fixes #10069.
Ryan C. Gordon il y a 9 mois
Parent
commit
9fd54b724f
1 fichiers modifiés avec 18 ajouts et 1 suppressions
  1. 18 1
      include/SDL3/SDL_events.h

+ 18 - 1
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.
  *