Sync SDL3 header -> wiki

libsdl-org · Dec 31, 2024 · 34a8ff3 · 34a8ff3
1 parent e1a324d
commit 34a8ff3
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 2 deletions.
diff --git a/SDL3/SDL_ASYNCIO_CANCELED.md b/SDL3/SDL_ASYNCIO_CANCELED.md
@@ -0,0 +1,8 @@
+###### (This is the documentation for SDL3, which is the current stable version. [SDL2](https://wiki.libsdl.org/SDL2/) was the previous version!)
+# SDL_ASYNCIO_CANCELED
+
+Please refer to [SDL_AsyncIOResult](SDL_AsyncIOResult) for details.
+
+----
+[CategoryAPI](CategoryAPI), [CategoryAPIEnumerators](CategoryAPIEnumerators)
+
diff --git a/SDL3/SDL_AsyncIOResult.md b/SDL3/SDL_AsyncIOResult.md
@@ -14,7 +14,7 @@ typedef enum SDL_AsyncIOResult
 {
     SDL_ASYNCIO_COMPLETE,  /**< request was completed without error */
     SDL_ASYNCIO_FAILURE,   /**< request failed for some reason; check SDL_GetError()! */
-    SDL_ASYNCIO_CANCELLED  /**< request was cancelled before completing. */
+    SDL_ASYNCIO_CANCELED   /**< request was canceled before completing. */
 } SDL_AsyncIOResult;
 ```
 

diff --git a/SDL3/SDL_EVENT_FINGER_CANCELED.md b/SDL3/SDL_EVENT_FINGER_CANCELED.md
@@ -0,0 +1,8 @@
+###### (This is the documentation for SDL3, which is the current stable version. [SDL2](https://wiki.libsdl.org/SDL2/) was the previous version!)
+# SDL_EVENT_FINGER_CANCELED
+
+Please refer to [SDL_EventType](SDL_EventType) for details.
+
+----
+[CategoryAPI](CategoryAPI), [CategoryAPIEnumerators](CategoryAPIEnumerators)
+
diff --git a/SDL3/SDL_EventType.md b/SDL3/SDL_EventType.md
@@ -141,6 +141,7 @@ typedef enum SDL_EventType
     SDL_EVENT_FINGER_DOWN      = 0x700,
     SDL_EVENT_FINGER_UP,
     SDL_EVENT_FINGER_MOTION,
+    SDL_EVENT_FINGER_CANCELED,
 
     /* 0x800, 0x801, and 0x802 were the Gesture events from SDL2. Do not reuse these values! sdl2-compat needs them! */
 

diff --git a/SDL3/SDL_TouchFingerEvent.md b/SDL3/SDL_TouchFingerEvent.md
@@ -12,7 +12,7 @@ Defined in [<SDL3/SDL_events.h>](https://github.com/libsdl-org/SDL/blob/main/inc
 ```c
 typedef struct SDL_TouchFingerEvent
 {
-    SDL_EventType type; /**< SDL_EVENT_FINGER_MOTION or SDL_EVENT_FINGER_DOWN or SDL_EVENT_FINGER_UP */
+    SDL_EventType type; /**< SDL_EVENT_FINGER_DOWN, SDL_EVENT_FINGER_UP, SDL_EVENT_FINGER_MOTION, or SDL_EVENT_FINGER_CANCELED */
     Uint32 reserved;
     Uint64 timestamp;   /**< In nanoseconds, populated using SDL_GetTicksNS() */
     SDL_TouchID touchID; /**< The touch device id */