From a20997a83e8075a5595ab105470d1df1989f8786 Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Sun, 9 Jul 2023 23:35:10 +0000
Subject: [PATCH] Sync SDL3_image wiki -> header
---
include/SDL3/SDL_image.h | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/include/SDL3/SDL_image.h b/include/SDL3/SDL_image.h
index 343c4ac1..fe17dfe1 100644
--- a/include/SDL3/SDL_image.h
+++ b/include/SDL3/SDL_image.h
@@ -211,7 +211,7 @@ extern DECLSPEC void SDLCALL IMG_Quit(void);
* by calling: SDL_SetSurfaceColorKey(image, SDL_RLEACCEL,
* image->format->colorkey);
*
- * If `freesrc` is SDL_TRUE, the RWops will be closed before returning,
+ * If `freesrc` is non-zero, the RWops will be closed before returning,
* whether this function succeeds or not. SDL_image reads everything it needs
* from the RWops during this call in any case.
*
@@ -238,7 +238,7 @@ extern DECLSPEC void SDLCALL IMG_Quit(void);
* call to SDL_DestroySurface().
*
* \param src an SDL_RWops that data will be read from.
- * \param freesrc SDL_TRUE to close/free the SDL_RWops before returning, SDL_FALSE
+ * \param freesrc non-zero to close/free the SDL_RWops before returning, zero
* to leave it open.
* \param type a filename extension that represent this data ("BMP", "GIF",
* "PNG", etc).
@@ -316,7 +316,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_Load(const char *file);
* by calling: SDL_SetSurfaceColorKey(image, SDL_RLEACCEL,
* image->format->colorkey);
*
- * If `freesrc` is SDL_TRUE, the RWops will be closed before returning,
+ * If `freesrc` is non-zero, the RWops will be closed before returning,
* whether this function succeeds or not. SDL_image reads everything it needs
* from the RWops during this call in any case.
*
@@ -337,7 +337,7 @@ extern DECLSPEC SDL_Surface * SDLCALL IMG_Load(const char *file);
* call to SDL_DestroySurface().
*
* \param src an SDL_RWops that data will be read from.
- * \param freesrc SDL_TRUE to close/free the SDL_RWops before returning, SDL_FALSE
+ * \param freesrc non-zero to close/free the SDL_RWops before returning, zero
* to leave it open.
* \returns a new SDL surface, or NULL on error.
*
@@ -400,7 +400,7 @@ extern DECLSPEC SDL_Texture * SDLCALL IMG_LoadTexture(SDL_Renderer *renderer, co
* data (but in many cases, this will just end up being 32-bit RGB or 32-bit
* RGBA).
*
- * If `freesrc` is SDL_TRUE, the RWops will be closed before returning,
+ * If `freesrc` is non-zero, the RWops will be closed before returning,
* whether this function succeeds or not. SDL_image reads everything it needs
* from the RWops during this call in any case.
*
@@ -421,7 +421,7 @@ extern DECLSPEC SDL_Texture * SDLCALL IMG_LoadTexture(SDL_Renderer *renderer, co
*
* \param renderer the SDL_Renderer to use to create the GPU texture.
* \param src an SDL_RWops that data will be read from.
- * \param freesrc SDL_TRUE to close/free the SDL_RWops before returning, SDL_FALSE
+ * \param freesrc non-zero to close/free the SDL_RWops before returning, zero
* to leave it open.
* \returns a new texture, or NULL on error.
*
@@ -447,7 +447,7 @@ extern DECLSPEC SDL_Texture * SDLCALL IMG_LoadTexture_RW(SDL_Renderer *renderer,
* data (but in many cases, this will just end up being 32-bit RGB or 32-bit
* RGBA).
*
- * If `freesrc` is SDL_TRUE, the RWops will be closed before returning,
+ * If `freesrc` is non-zero, the RWops will be closed before returning,
* whether this function succeeds or not. SDL_image reads everything it needs
* from the RWops during this call in any case.
*
@@ -474,7 +474,7 @@ extern DECLSPEC SDL_Texture * SDLCALL IMG_LoadTexture_RW(SDL_Renderer *renderer,
*
* \param renderer the SDL_Renderer to use to create the GPU texture.
* \param src an SDL_RWops that data will be read from.
- * \param freesrc SDL_TRUE to close/free the SDL_RWops before returning, SDL_FALSE
+ * \param freesrc non-zero to close/free the SDL_RWops before returning, zero
* to leave it open.
* \param type a filename extension that represent this data ("BMP", "GIF",
* "PNG", etc).
@@ -2069,7 +2069,7 @@ extern DECLSPEC IMG_Animation * SDLCALL IMG_LoadAnimation(const char *file);
/**
* Load an animation from an SDL_RWops.
*
- * If `freesrc` is SDL_TRUE, the RWops will be closed before returning,
+ * If `freesrc` is non-zero, the RWops will be closed before returning,
* whether this function succeeds or not. SDL_image reads everything it needs
* from the RWops during this call in any case.
*
@@ -2077,7 +2077,7 @@ extern DECLSPEC IMG_Animation * SDLCALL IMG_LoadAnimation(const char *file);
* call to IMG_FreeAnimation().
*
* \param src an SDL_RWops that data will be read from.
- * \param freesrc SDL_TRUE to close/free the SDL_RWops before returning, SDL_FALSE
+ * \param freesrc non-zero to close/free the SDL_RWops before returning, zero
* to leave it open.
* \returns a new IMG_Animation, or NULL on error.
*
@@ -2096,7 +2096,7 @@ extern DECLSPEC IMG_Animation * SDLCALL IMG_LoadAnimation_RW(SDL_RWops *src, SDL
* that it cannot autodetect. If `type` is NULL, SDL_image will rely solely on
* its ability to guess the format.
*
- * If `freesrc` is SDL_TRUE, the RWops will be closed before returning,
+ * If `freesrc` is non-zero, the RWops will be closed before returning,
* whether this function succeeds or not. SDL_image reads everything it needs
* from the RWops during this call in any case.
*
@@ -2104,7 +2104,7 @@ extern DECLSPEC IMG_Animation * SDLCALL IMG_LoadAnimation_RW(SDL_RWops *src, SDL
* call to IMG_FreeAnimation().
*
* \param src an SDL_RWops that data will be read from.
- * \param freesrc SDL_TRUE to close/free the SDL_RWops before returning, SDL_FALSE
+ * \param freesrc non-zero to close/free the SDL_RWops before returning, zero
* to leave it open.
* \param type a filename extension that represent this data ("GIF", etc).
* \returns a new IMG_Animation, or NULL on error.