gitea/SDL3_fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Sam Lantinga
2024-07-17 23:20:23 -07:00
parent 0d24b6e9f3
commit d73c7311d5
23 changed files with 66 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
include/SDL3/SDL_events.h
View File

@@ -350,7 +350,7 @@ typedef struct SDL_KeyboardEvent
* will be inserted into the editing text. The length is the number of UTF-8
* characters that will be replaced by new typing.
*
* The text string follows the SDL_GetStringRule.
* The text string follows the SDL_GetStringRule, and will be automatically freed later.
*
* \since This struct is available since SDL 3.0.0.
*/
@@ -368,7 +368,7 @@ typedef struct SDL_TextEditingEvent
/**
* Keyboard IME candidates event structure (event.edit_candidates.*)
*
* The candidates follow the SDL_GetStringRule.
* The candidates follow the SDL_GetStringRule, and will be automatically freed later.
*
* \since This struct is available since SDL 3.0.0.
*/
@@ -387,7 +387,7 @@ typedef struct SDL_TextEditingCandidatesEvent
/**
* Keyboard text input event structure (event.text.*)
*
* The text string follows the SDL_GetStringRule.
* The text string follows the SDL_GetStringRule, and will be automatically freed later.
*
* This event will never be delivered unless text input is enabled by calling
* SDL_StartTextInput(). Text input is disabled by default!
@@ -784,7 +784,7 @@ typedef struct SDL_PenButtonEvent
* An event used to drop text or request a file open by the system
* (event.drop.*)
*
* The source and data strings follow the SDL_GetStringRule.
* The source and data strings follow the SDL_GetStringRule, and will be automatically freed later.
*
* \since This struct is available since SDL 3.0.0.
*/