mirror of
https://github.com/libsdl-org/SDL.git
synced 2025-05-28 15:39:10 +00:00
Updated documentation for functions that return temporary memory
This commit is contained in:
parent
68322ac851
commit
71a60d4c0e
24 changed files with 85 additions and 146 deletions
|
@ -407,7 +407,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SendAndroidBackButton(void);
|
|||
*
|
||||
* https://developer.android.com/reference/android/content/Context#getFilesDir()
|
||||
*
|
||||
* The returned string follows the SDL_GetStringRule, and will be automatically freed later.
|
||||
* This returns temporary memory which will be automatically freed later, and can be claimed with SDL_ClaimTemporaryMemory().
|
||||
*
|
||||
* \returns the path used for internal storage or NULL on failure; call
|
||||
* SDL_GetError() for more information.
|
||||
|
@ -448,7 +448,7 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_GetAndroidExternalStorageState(void);
|
|||
*
|
||||
* https://developer.android.com/reference/android/content/Context#getExternalFilesDir()
|
||||
*
|
||||
* The returned string follows the SDL_GetStringRule, and will be automatically freed later.
|
||||
* This returns temporary memory which will be automatically freed later, and can be claimed with SDL_ClaimTemporaryMemory().
|
||||
*
|
||||
* \returns the path used for external storage for this application on success
|
||||
* or NULL on failure; call SDL_GetError() for more information.
|
||||
|
@ -471,7 +471,7 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetAndroidExternalStoragePath(void)
|
|||
*
|
||||
* https://developer.android.com/reference/android/content/Context#getCacheDir()
|
||||
*
|
||||
* The returned string follows the SDL_GetStringRule, and will be automatically freed later.
|
||||
* This returns temporary memory which will be automatically freed later, and can be claimed with SDL_ClaimTemporaryMemory().
|
||||
*
|
||||
* \returns the path used for caches for this application on success or NULL
|
||||
* on failure; call SDL_GetError() for more information.
|
||||
|
@ -625,7 +625,7 @@ typedef enum SDL_WinRT_DeviceFamily
|
|||
*
|
||||
* https://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
|
||||
*
|
||||
* The returned string follows the SDL_GetStringRule, and will be automatically freed later.
|
||||
* This returns temporary memory which will be automatically freed later, and can be claimed with SDL_ClaimTemporaryMemory().
|
||||
*
|
||||
* \param pathType the type of path to retrieve, one of SDL_WinRT_Path.
|
||||
* \returns a UTF-8 string (8-bit, multi-byte) containing the path, or NULL if
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue