Clarify that the SDL_GetStringRule means that SDL will automatically free the memory later.

2024-07-17 23:20:23 -07:00
parent 0d24b6e9f3
commit d73c7311d5
23 changed files with 66 additions and 69 deletions
--- a/include/SDL3/SDL_pixels.h
+++ b/include/SDL3/SDL_pixels.h
@@ -723,7 +723,7 @@ typedef struct SDL_PixelFormatDetails
 /**
 * Get the human readable name of a pixel format.
 *
- * The returned string follows the SDL_GetStringRule.
+ * The returned string follows the SDL_GetStringRule, and will be automatically freed later.
 *
 * \param format the pixel format to query.
 * \returns the human readable name of the specified pixel format or