Browse Source

include: Added documentation for SDL_PRESSED and SDL_RELEASED.

Fixes #10069.
Ryan C. Gordon 1 year ago
parent
commit
9fd54b724f
1 changed files with 18 additions and 1 deletions
  1. 18 1
      include/SDL3/SDL_events.h

+ 18 - 1
include/SDL3/SDL_events.h

@@ -46,10 +46,27 @@
 extern "C" {
 extern "C" {
 #endif
 #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
 #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
 #define SDL_PRESSED     1
 
 
+
 /**
 /**
  * The types of events that can be delivered.
  * The types of events that can be delivered.
  *
  *