From e454d7d4be99b526f151c83bde25ed169c994575 Mon Sep 17 00:00:00 2001
From: Sam Lantinga <[EMAIL REDACTED]>
Date: Wed, 5 Mar 2025 07:23:54 -0800
Subject: [PATCH] Document the thread safety of SDL surface functions
(cherry picked from commit 8f40dad4600e6e104e2a8730816fe0b40eca405d)
---
include/SDL3/SDL_surface.h | 138 ++++++++++++++++++++++++++++++-------
1 file changed, 114 insertions(+), 24 deletions(-)
diff --git a/include/SDL3/SDL_surface.h b/include/SDL3/SDL_surface.h
index 415da1b73a312..514cf4f228bfd 100644
--- a/include/SDL3/SDL_surface.h
+++ b/include/SDL3/SDL_surface.h
@@ -156,6 +156,8 @@ typedef struct SDL_Surface SDL_Surface;
* \returns the new SDL_Surface structure that is created or NULL on failure;
* call SDL_GetError() for more information.
*
+ * \threadsafety It is safe to call this function from any thread.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_CreateSurfaceFrom
@@ -184,6 +186,8 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_CreateSurface(int width, int heigh
* \returns the new SDL_Surface structure that is created or NULL on failure;
* call SDL_GetError() for more information.
*
+ * \threadsafety It is safe to call this function from any thread.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_CreateSurface
@@ -198,6 +202,8 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_CreateSurfaceFrom(int width, int h
*
* \param surface the SDL_Surface to free.
*
+ * \threadsafety No other thread should be using the surface when it is freed.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_CreateSurface
@@ -233,6 +239,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroySurface(SDL_Surface *surface);
* \returns a valid property ID on success or 0 on failure; call
* SDL_GetError() for more information.
*
+ * \threadsafety It is safe to call this function from any thread.
+ *
* \since This function is available since SDL 3.2.0.
*/
extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetSurfaceProperties(SDL_Surface *surface);
@@ -255,6 +263,8 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetSurfaceProperties(SDL_Surfac
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetSurfaceColorspace
@@ -272,6 +282,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfaceColorspace(SDL_Surface *surface,
* \returns the colorspace used by the surface, or SDL_COLORSPACE_UNKNOWN if
* the surface is NULL.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_SetSurfaceColorspace
@@ -300,6 +312,8 @@ extern SDL_DECLSPEC SDL_Colorspace SDLCALL SDL_GetSurfaceColorspace(SDL_Surface
* the surface didn't have an index format); call SDL_GetError() for
* more information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_SetPaletteColors
@@ -316,6 +330,8 @@ extern SDL_DECLSPEC SDL_Palette * SDLCALL SDL_CreateSurfacePalette(SDL_Surface *
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_CreatePalette
@@ -330,6 +346,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfacePalette(SDL_Surface *surface, SDL
* \returns a pointer to the palette used by the surface, or NULL if there is
* no palette used.
*
+ * \threadsafety It is safe to call this function from any thread.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_SetSurfacePalette
@@ -353,6 +371,8 @@ extern SDL_DECLSPEC SDL_Palette * SDLCALL SDL_GetSurfacePalette(SDL_Surface *sur
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_RemoveSurfaceAlternateImages
@@ -367,6 +387,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_AddSurfaceAlternateImage(SDL_Surface *surfa
* \param surface the SDL_Surface structure to query.
* \returns true if alternate versions are available or false otherwise.
*
+ * \threadsafety It is safe to call this function from any thread.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_AddSurfaceAlternateImage
@@ -392,6 +414,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SurfaceHasAlternateImages(SDL_Surface *surf
* failure; call SDL_GetError() for more information. This should be
* freed with SDL_free() when it is no longer needed.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_AddSurfaceAlternateImage
@@ -408,6 +432,8 @@ extern SDL_DECLSPEC SDL_Surface ** SDLCALL SDL_GetSurfaceImages(SDL_Surface *sur
*
* \param surface the SDL_Surface structure to update.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_AddSurfaceAlternateImage
@@ -432,6 +458,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_RemoveSurfaceAlternateImages(SDL_Surface *s
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe. The locking referred to by this function is making the pixels available for direct access, not thread-safe locking.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_MUSTLOCK
@@ -444,6 +472,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_LockSurface(SDL_Surface *surface);
*
* \param surface the SDL_Surface structure to be unlocked.
*
+ * \threadsafety This function is not thread safe. The locking referred to by this function is making the pixels available for direct access, not thread-safe locking.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_LockSurface
@@ -462,6 +492,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface *surface);
* \returns a pointer to a new SDL_Surface structure or NULL on failure; call
* SDL_GetError() for more information.
*
+ * \threadsafety It is safe to call this function from any thread.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_DestroySurface
@@ -480,6 +512,8 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_LoadBMP_IO(SDL_IOStream *src, bool
* \returns a pointer to a new SDL_Surface structure or NULL on failure; call
* SDL_GetError() for more information.
*
+ * \threadsafety It is safe to call this function from any thread.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_DestroySurface
@@ -504,6 +538,8 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_LoadBMP(const char *file);
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_LoadBMP_IO
@@ -525,6 +561,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SaveBMP_IO(SDL_Surface *surface, SDL_IOStre
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_LoadBMP
@@ -543,6 +581,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SaveBMP(SDL_Surface *surface, const char *f
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_BlitSurface
@@ -559,6 +599,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfaceRLE(SDL_Surface *surface, bool en
* \param surface the SDL_Surface structure to query.
* \returns true if the surface is RLE enabled, false otherwise.
*
+ * \threadsafety It is safe to call this function from any thread.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_SetSurfaceRLE
@@ -581,6 +623,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SurfaceHasRLE(SDL_Surface *surface);
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetSurfaceColorKey
@@ -597,6 +641,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfaceColorKey(SDL_Surface *surface, bo
* \param surface the SDL_Surface structure to query.
* \returns true if the surface has a color key, false otherwise.
*
+ * \threadsafety It is safe to call this function from any thread.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_SetSurfaceColorKey
@@ -617,6 +663,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SurfaceHasColorKey(SDL_Surface *surface);
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety It is safe to call this function from any thread.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_SetSurfaceColorKey
@@ -640,6 +688,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetSurfaceColorKey(SDL_Surface *surface, Ui
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetSurfaceColorMod
@@ -658,6 +708,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfaceColorMod(SDL_Surface *surface, Ui
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetSurfaceAlphaMod
@@ -678,6 +730,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetSurfaceColorMod(SDL_Surface *surface, Ui
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetSurfaceAlphaMod
@@ -693,6 +747,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfaceAlphaMod(SDL_Surface *surface, Ui
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety It is safe to call this function from any thread.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetSurfaceColorMod
@@ -712,6 +768,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetSurfaceAlphaMod(SDL_Surface *surface, Ui
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetSurfaceBlendMode
@@ -726,6 +784,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfaceBlendMode(SDL_Surface *surface, S
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety It is safe to call this function from any thread.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_SetSurfaceBlendMode
@@ -747,6 +807,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetSurfaceBlendMode(SDL_Surface *surface, S
* \returns true if the rectangle intersects the surface, otherwise false and
* blits will be completely clipped.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_GetSurfaceClipRect
@@ -766,6 +828,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetSurfaceClipRect(SDL_Surface *surface, co
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_SetSurfaceClipRect
@@ -780,6 +844,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetSurfaceClipRect(SDL_Surface *surface, SD
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*/
extern SDL_DECLSPEC bool SDLCALL SDL_FlipSurface(SDL_Surface *surface, SDL_FlipMode flip);
@@ -796,6 +862,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_FlipSurface(SDL_Surface *surface, SDL_FlipM
* \returns a copy of the surface or NULL on failure; call SDL_GetError() for
* more information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_DestroySurface
@@ -815,6 +883,8 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_DuplicateSurface(SDL_Surface *surf
* \returns a copy of the surface or NULL on failure; call SDL_GetError() for
* more information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_DestroySurface
@@ -840,6 +910,8 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_ScaleSurface(SDL_Surface *surface,
* \returns the new SDL_Surface structure that is created or NULL on failure;
* call SDL_GetError() for more information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_ConvertSurfaceAndColorspace
@@ -866,6 +938,8 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_ConvertSurface(SDL_Surface *surfac
* \returns the new SDL_Surface structure that is created or NULL on failure;
* call SDL_GetError() for more information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_ConvertSurface
@@ -887,6 +961,10 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_ConvertSurfaceAndColorspace(SDL_Su
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety The same destination pixels should not be used from two
+ * threads at once. It is safe to use the same source pixels
+ * from multiple threads.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_ConvertPixelsAndColorspace
@@ -916,6 +994,10 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ConvertPixels(int width, int height, SDL_Pi
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety The same destination pixels should not be used from two
+ * threads at once. It is safe to use the same source pixels
+ * from multiple threads.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_ConvertPixels
@@ -940,6 +1022,10 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ConvertPixelsAndColorspace(int width, int h
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety The same destination pixels should not be used from two
+ * threads at once. It is safe to use the same source pixels
+ * from multiple threads.
+ *
* \since This function is available since SDL 3.2.0.
*/
extern SDL_DECLSPEC bool SDLCALL SDL_PremultiplyAlpha(int width, int height, SDL_PixelFormat src_format, const void *src, int src_pitch, SDL_PixelFormat dst_format, void *dst, int dst_pitch, bool linear);
@@ -955,6 +1041,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PremultiplyAlpha(int width, int height, SDL
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*/
extern SDL_DECLSPEC bool SDLCALL SDL_PremultiplySurfaceAlpha(SDL_Surface *surface, bool linear);
@@ -975,6 +1063,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PremultiplySurfaceAlpha(SDL_Surface *surfac
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*/
extern SDL_DECLSPEC bool SDLCALL SDL_ClearSurface(SDL_Surface *surface, float r, float g, float b, float a);
@@ -998,6 +1088,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ClearSurface(SDL_Surface *surface, float r,
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_FillSurfaceRects
@@ -1023,6 +1115,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_FillSurfaceRect(SDL_Surface *dst, const SDL
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_FillSurfaceRect
@@ -1096,9 +1190,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_FillSurfaceRects(SDL_Surface *dst, const SD
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
- * \threadsafety The same destination surface should not be used from two
- * threads at once. It is safe to use the same source surface
- * from multiple threads.
+ * \threadsafety Only one thread should be using the `src` and `dst` surfaces at any given time.
*
* \since This function is available since SDL 3.2.0.
*
@@ -1121,9 +1213,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BlitSurface(SDL_Surface *src, const SDL_Rec
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
- * \threadsafety The same destination surface should not be used from two
- * threads at once. It is safe to use the same source surface
- * from multiple threads.
+ * \threadsafety Only one thread should be using the `src` and `dst` surfaces at any given time.
*
* \since This function is available since SDL 3.2.0.
*
@@ -1146,9 +1236,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BlitSurfaceUnchecked(SDL_Surface *src, cons
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
- * \threadsafety The same destination surface should not be used from two
- * threads at once. It is safe to use the same source surface
- * from multiple threads.
+ * \threadsafety Only one thread should be using the `src` and `dst` surfaces at any given time.
*
* \since This function is available since SDL 3.2.0.
*
@@ -1172,9 +1260,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BlitSurfaceScaled(SDL_Surface *src, const S
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
- * \threadsafety The same destination surface should not be used from two
- * threads at once. It is safe to use the same source surface
- * from multiple threads.
+ * \threadsafety Only one thread should be using the `src` and `dst` surfaces at any given time.
*
* \since This function is available since SDL 3.2.0.
*
@@ -1195,9 +1281,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BlitSurfaceUncheckedScaled(SDL_Surface *src
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
- * \threadsafety The same destination surface should not be used from two
- * threads at once. It is safe to use the same source surface
- * from multiple threads.
+ * \threadsafety Only one thread should be using the `src` and `dst` surfaces at any given time.
*
* \since This function is available since SDL 3.4.0.
*
@@ -1221,9 +1305,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_StretchSurface(SDL_Surface *src, const SDL_
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
- * \threadsafety The same destination surface should not be used from two
- * threads at once. It is safe to use the same source surface
- * from multiple threads.
+ * \threadsafety Only one thread should be using the `src` and `dst` surfaces at any given time.
*
* \since This function is available since SDL 3.2.0.
*
@@ -1251,9 +1333,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BlitSurfaceTiled(SDL_Surface *src, const SD
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
- * \threadsafety The same destination surface should not be used from two
- * threads at once. It is safe to use the same source surface
- * from multiple threads.
+ * \threadsafety Only one thread should be using the `src` and `dst` surfaces at any given time.
*
* \since This function is available since SDL 3.2.0.
*
@@ -1288,9 +1368,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BlitSurfaceTiledWithScale(SDL_Surface *src,
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
- * \threadsafety The same destination surface should not be used from two
- * threads at once. It is safe to use the same source surface
- * from multiple threads.
+ * \threadsafety Only one thread should be using the `src` and `dst` surfaces at any given time.
*
* \since This function is available since SDL 3.2.0.
*
@@ -1322,6 +1400,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_BlitSurface9Grid(SDL_Surface *src, const SD
* \param b the blue component of the pixel in the range 0-255.
* \returns a pixel value.
*
+ * \threadsafety It is safe to call this function from any thread.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_MapSurfaceRGBA
@@ -1353,6 +1433,8 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_MapSurfaceRGB(SDL_Surface *surface, Uint8
* \param a the alpha component of the pixel in the range 0-255.
* \returns a pixel value.
*
+ * \threadsafety It is safe to call this function from any thread.
+ *
* \since This function is available since SDL 3.2.0.
*
* \sa SDL_MapSurfaceRGB
@@ -1382,6 +1464,8 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_MapSurfaceRGBA(SDL_Surface *surface, Uint
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*/
extern SDL_DECLSPEC bool SDLCALL SDL_ReadSurfacePixel(SDL_Surface *surface, int x, int y, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a);
@@ -1406,6 +1490,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadSurfacePixel(SDL_Surface *surface, int
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*/
extern SDL_DECLSPEC bool SDLCALL SDL_ReadSurfacePixelFloat(SDL_Surface *surface, int x, int y, float *r, float *g, float *b, float *a);
@@ -1429,6 +1515,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadSurfacePixelFloat(SDL_Surface *surface,
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*/
extern SDL_DECLSPEC bool SDLCALL SDL_WriteSurfacePixel(SDL_Surface *surface, int x, int y, Uint8 r, Uint8 g, Uint8 b, Uint8 a);
@@ -1449,6 +1537,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteSurfacePixel(SDL_Surface *surface, int
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
+ * \threadsafety This function is not thread safe.
+ *
* \since This function is available since SDL 3.2.0.
*/
extern SDL_DECLSPEC bool SDLCALL SDL_WriteSurfacePixelFloat(SDL_Surface *surface, int x, int y, float r, float g, float b, float a);