Sync SDL2 header -> wiki

libsdl-org · Apr 23, 2024 · 9ccc8b5 · 9ccc8b5
1 parent 102029c
commit 9ccc8b5
Show file tree

Hide file tree

Showing 780 changed files with 616 additions and 1,331 deletions.
diff --git a/SDL2/SDL_AddEventWatch.md b/SDL2/SDL_AddEventWatch.md
@@ -44,7 +44,7 @@ user through [SDL_PeepEvents](SDL_PeepEvents)().
 
 This function is available since SDL 2.0.0.
 
-## Related Functions
+## See Also
 
 * [SDL_DelEventWatch](SDL_DelEventWatch)
 * [SDL_SetEventFilter](SDL_SetEventFilter)
@@ -67,4 +67,3 @@ SDL_AddEventWatch(MyEventFunction, NULL);
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AddHintCallback.md b/SDL2/SDL_AddHintCallback.md
@@ -28,7 +28,7 @@ void SDL_AddHintCallback(const char *name,
 
 This function is available since SDL 2.0.0.
 
-## Related Functions
+## See Also
 
 * [SDL_DelHintCallback](SDL_DelHintCallback)
 

diff --git a/SDL2/SDL_AddTimer.md b/SDL2/SDL_AddTimer.md
@@ -55,7 +55,7 @@ callback needs to adjust for variances.
 
 This function is available since SDL 2.0.0.
 
-## Related Functions
+## See Also
 
 * [SDL_RemoveTimer](SDL_RemoveTimer)
 
@@ -99,4 +99,3 @@ SDL_RemoveTimer(timerID);
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AllocFormat.md b/SDL2/SDL_AllocFormat.md
@@ -35,7 +35,7 @@ errors such as `Blit combination not supported` may occur.
 
 This function is available since SDL 2.0.0.
 
-## Related Functions
+## See Also
 
 * [SDL_FreeFormat](SDL_FreeFormat)
 
@@ -62,4 +62,3 @@ printf("Amount of bytes: %i\n", pixel_format->BytesPerPixel);
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AllocPalette.md b/SDL2/SDL_AllocPalette.md
@@ -34,7 +34,7 @@ The palette entries are initialized to white.
 
 This function is available since SDL 2.0.0.
 
-## Related Functions
+## See Also
 
 * [SDL_FreePalette](SDL_FreePalette)
 
@@ -80,4 +80,3 @@ palette = NULL;
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AllocRW.md b/SDL2/SDL_AllocRW.md
@@ -41,11 +41,10 @@ allocated through this function, so they can all be freed correctly with
 
 This function is available since SDL 2.0.0.
 
-## Related Functions
+## See Also
 
 * [SDL_FreeRW](SDL_FreeRW)
 
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AndroidBackButton.md b/SDL2/SDL_AndroidBackButton.md
@@ -21,4 +21,3 @@ This function is available since SDL 2.0.9.
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AndroidGetActivity.md b/SDL2/SDL_AndroidGetActivity.md
@@ -35,11 +35,10 @@ https://docs.oracle.com/javase/1.5.0/docs/guide/jni/spec/functions.html
 
 This function is available since SDL 2.0.0.
 
-## Related Functions
+## See Also
 
 * [SDL_AndroidGetJNIEnv](SDL_AndroidGetJNIEnv)
 
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AndroidGetExternalStoragePath.md b/SDL2/SDL_AndroidGetExternalStoragePath.md
@@ -32,11 +32,10 @@ Your external storage path is typically:
 
 This function is available since SDL 2.0.0.
 
-## Related Functions
+## See Also
 
 * [SDL_AndroidGetExternalStorageState](SDL_AndroidGetExternalStorageState)
 
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AndroidGetExternalStorageState.md b/SDL2/SDL_AndroidGetExternalStorageState.md
@@ -31,11 +31,10 @@ If external storage is currently unavailable, this will return 0.
 
 This function is available since SDL 2.0.0.
 
-## Related Functions
+## See Also
 
 * [SDL_AndroidGetExternalStoragePath](SDL_AndroidGetExternalStoragePath)
 
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AndroidGetInternalStoragePath.md b/SDL2/SDL_AndroidGetInternalStoragePath.md
@@ -31,11 +31,10 @@ Your internal storage path is typically:
 
 This function is available since SDL 2.0.0.
 
-## Related Functions
+## See Also
 
 * [SDL_AndroidGetExternalStorageState](SDL_AndroidGetExternalStorageState)
 
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AndroidGetJNIEnv.md b/SDL2/SDL_AndroidGetJNIEnv.md
@@ -32,11 +32,10 @@ rationale being that the SDL headers can avoid including jni.h.
 
 This function is available since SDL 2.0.0.
 
-## Related Functions
+## See Also
 
 * [SDL_AndroidGetActivity](SDL_AndroidGetActivity)
 
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AndroidRequestPermission.md b/SDL2/SDL_AndroidRequestPermission.md
@@ -36,4 +36,3 @@ This function is available since SDL 2.0.14.
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AndroidSendMessage.md b/SDL2/SDL_AndroidSendMessage.md
@@ -32,4 +32,3 @@ This function is available since SDL 2.0.22.
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AndroidShowToast.md b/SDL2/SDL_AndroidShowToast.md
@@ -48,4 +48,3 @@ This function is available since SDL 2.0.16.
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AtomicAdd.md b/SDL2/SDL_AtomicAdd.md
@@ -36,12 +36,11 @@ it!***
 
 This function is available since SDL 2.0.2.
 
-## Related Functions
+## See Also
 
 * [SDL_AtomicDecRef](SDL_AtomicDecRef)
 * [SDL_AtomicIncRef](SDL_AtomicIncRef)
 
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AtomicCAS.md b/SDL2/SDL_AtomicCAS.md
@@ -36,7 +36,7 @@ it!***
 
 This function is available since SDL 2.0.0.
 
-## Related Functions
+## See Also
 
 * [SDL_AtomicCASPtr](SDL_AtomicCASPtr)
 * [SDL_AtomicGet](SDL_AtomicGet)
@@ -45,4 +45,3 @@ This function is available since SDL 2.0.0.
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AtomicCASPtr.md b/SDL2/SDL_AtomicCASPtr.md
@@ -36,7 +36,7 @@ it!***
 
 This function is available since SDL 2.0.0.
 
-## Related Functions
+## See Also
 
 * [SDL_AtomicCAS](SDL_AtomicCAS)
 * [SDL_AtomicGetPtr](SDL_AtomicGetPtr)
@@ -45,4 +45,3 @@ This function is available since SDL 2.0.0.
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AtomicGet.md b/SDL2/SDL_AtomicGet.md
@@ -33,11 +33,10 @@ it!***
 
 This function is available since SDL 2.0.2.
 
-## Related Functions
+## See Also
 
 * [SDL_AtomicSet](SDL_AtomicSet)
 
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AtomicGetPtr.md b/SDL2/SDL_AtomicGetPtr.md
@@ -33,12 +33,11 @@ it!***
 
 This function is available since SDL 2.0.2.
 
-## Related Functions
+## See Also
 
 * [SDL_AtomicCASPtr](SDL_AtomicCASPtr)
 * [SDL_AtomicSetPtr](SDL_AtomicSetPtr)
 
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AtomicLock.md b/SDL2/SDL_AtomicLock.md
@@ -29,12 +29,11 @@ doing. Please be careful using any sort of spinlock!***
 
 This function is available since SDL 2.0.0.
 
-## Related Functions
+## See Also
 
 * [SDL_AtomicTryLock](SDL_AtomicTryLock)
 * [SDL_AtomicUnlock](SDL_AtomicUnlock)
 
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AtomicSet.md b/SDL2/SDL_AtomicSet.md
@@ -36,11 +36,10 @@ it!***
 
 This function is available since SDL 2.0.2.
 
-## Related Functions
+## See Also
 
 * [SDL_AtomicGet](SDL_AtomicGet)
 
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AtomicSetPtr.md b/SDL2/SDL_AtomicSetPtr.md
@@ -34,12 +34,11 @@ it!***
 
 This function is available since SDL 2.0.2.
 
-## Related Functions
+## See Also
 
 * [SDL_AtomicCASPtr](SDL_AtomicCASPtr)
 * [SDL_AtomicGetPtr](SDL_AtomicGetPtr)
 
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AtomicTryLock.md b/SDL2/SDL_AtomicTryLock.md
@@ -34,12 +34,11 @@ doing. Please be careful using any sort of spinlock!***
 
 This function is available since SDL 2.0.0.
 
-## Related Functions
+## See Also
 
 * [SDL_AtomicLock](SDL_AtomicLock)
 * [SDL_AtomicUnlock](SDL_AtomicUnlock)
 
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AtomicUnlock.md b/SDL2/SDL_AtomicUnlock.md
@@ -31,12 +31,11 @@ doing. Please be careful using any sort of spinlock!***
 
 This function is available since SDL 2.0.0.
 
-## Related Functions
+## See Also
 
 * [SDL_AtomicLock](SDL_AtomicLock)
 * [SDL_AtomicTryLock](SDL_AtomicTryLock)
 
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AudioInit.md b/SDL2/SDL_AudioInit.md
@@ -36,11 +36,10 @@ normally use [SDL_Init](SDL_Init)() or
 
 This function is available since SDL 2.0.0.
 
-## Related Functions
+## See Also
 
 * [SDL_AudioQuit](SDL_AudioQuit)
 
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AudioQuit.md b/SDL2/SDL_AudioQuit.md
@@ -25,11 +25,10 @@ normally use [SDL_Quit](SDL_Quit)() or
 
 This function is available since SDL 2.0.0.
 
-## Related Functions
+## See Also
 
 * [SDL_AudioInit](SDL_AudioInit)
 
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AudioStreamAvailable.md b/SDL2/SDL_AudioStreamAvailable.md
@@ -24,7 +24,7 @@ even be zero. Add more data or flush the stream if you need the data now.
 
 This function is available since SDL 2.0.7.
 
-## Related Functions
+## See Also
 
 * [SDL_NewAudioStream](SDL_NewAudioStream)
 * [SDL_AudioStreamPut](SDL_AudioStreamPut)
@@ -36,4 +36,3 @@ This function is available since SDL 2.0.7.
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AudioStreamClear.md b/SDL2/SDL_AudioStreamClear.md
@@ -1,7 +1,7 @@
 ###### (This is the legacy documentation for stable SDL2, the current stable version; [SDL3](https://wiki.libsdl.org/SDL3/) is the current development version.)
 # SDL_AudioStreamClear
 
-Clear any pending data in the stream without converting it 
+Clear any pending data in the stream without converting it
 
 ## Header File
 
@@ -18,7 +18,7 @@ void SDL_AudioStreamClear(SDL_AudioStream *stream);
 
 This function is available since SDL 2.0.7.
 
-## Related Functions
+## See Also
 
 * [SDL_NewAudioStream](SDL_NewAudioStream)
 * [SDL_AudioStreamPut](SDL_AudioStreamPut)
@@ -30,4 +30,3 @@ This function is available since SDL 2.0.7.
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-
diff --git a/SDL2/SDL_AudioStreamFlush.md b/SDL2/SDL_AudioStreamFlush.md
@@ -24,7 +24,7 @@ input, so the complete output becomes available.
 
 This function is available since SDL 2.0.7.
 
-## Related Functions
+## See Also
 
 * [SDL_NewAudioStream](SDL_NewAudioStream)
 * [SDL_AudioStreamPut](SDL_AudioStreamPut)
@@ -36,4 +36,3 @@ This function is available since SDL 2.0.7.
 ----
 [CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)
 
-