Просмотр исходного кода

docs: Improved SDL_CommonEvent documentation.

Ryan C. Gordon 14 часов назад
Родитель
Сommit
179e66f1fe
1 измененных файлов с 7 добавлено и 1 удалено
  1. 7 1
      include/SDL3/SDL_events.h

+ 7 - 1
include/SDL3/SDL_events.h

@@ -296,7 +296,13 @@ typedef enum SDL_EventType
 } SDL_EventType;
 
 /**
- * Fields shared by every event
+ * Fields shared by every event (event.common.*)
+ *
+ * All the individual structs that comprise the SDL_Event union start with
+ * these same fields, so you can access them from any struct directly.
+ *
+ * Event types that don't have further data in a specific struct will still
+ * have valid CommonEvent data, accessible via the event.common field.
  *
  * \since This struct is available since SDL 3.2.0.
  */