geemili
/
SDL
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

main
SDL Wiki Bot 2024-04-04 13:41:27 +00:00
parent 764207d873
commit ac372e99fe
2 changed files with 17 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
include/SDL3/SDL_filesystem.h
View File

@ -275,8 +275,8 @@ typedef int (SDLCALL *SDL_EnumerateDirectoryCallback)(void *userdata, const char
* Enumerate a directory through a callback function. * Enumerate a directory through a callback function.
* *
* This function provides every directory entry through an app-provided * This function provides every directory entry through an app-provided
* callback, called once for each directory entry, until all results have * callback, called once for each directory entry, until all results have been
* been provided or the callback returns <= 0. * provided or the callback returns <= 0.
* *
* \param path the path of the directory to enumerate * \param path the path of the directory to enumerate
* \param callback a function that is called for each entry in the directory * \param callback a function that is called for each entry in the directory
@ -347,16 +347,18 @@ extern DECLSPEC int SDLCALL SDL_GetPathInfo(const char *path, SDL_PathInfo *info
* You must free the returned pointer with SDL_free() when done with it. * You must free the returned pointer with SDL_free() when done with it.
* *
* \param path the path of the directory to enumerate * \param path the path of the directory to enumerate
* \param pattern the pattern that files in the directory must match. Can be NULL. * \param pattern the pattern that files in the directory must match. Can be
* NULL.
* \param flags `SDL_GLOBDIR_*` bitflags that affect this search. * \param flags `SDL_GLOBDIR_*` bitflags that affect this search.
* \param count on return, will be set to the number of items in the returned array. Can be NULL. * \param count on return, will be set to the number of items in the returned
* array. Can be NULL.
* \returns an array of strings on success or NULL on failure; call * \returns an array of strings on success or NULL on failure; call
* SDL_GetError() for more information. The caller should pass the * SDL_GetError() for more information. The caller should pass the
* returned pointer to SDL_free when done with it. * returned pointer to SDL_free when done with it.
* *
* \since This function is available since SDL 3.0.0.
*
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.0.0.
*/ */
extern DECLSPEC char **SDLCALL SDL_GlobDirectory(const char *path, const char *pattern, Uint32 flags, int *count); extern DECLSPEC char **SDLCALL SDL_GlobDirectory(const char *path, const char *pattern, Uint32 flags, int *count);

15
include/SDL3/SDL_storage.h
View File

@ -271,8 +271,8 @@ extern DECLSPEC int SDLCALL SDL_CreateStorageDirectory(SDL_Storage *storage, con
* Enumerate a directory in a storage container through a callback function. * Enumerate a directory in a storage container through a callback function.
* *
* This function provides every directory entry through an app-provided * This function provides every directory entry through an app-provided
* callback, called once for each directory entry, until all results have * callback, called once for each directory entry, until all results have been
* been provided or the callback returns <= 0. * provided or the callback returns <= 0.
* *
* \param storage a storage container * \param storage a storage container
* \param path the path of the directory to enumerate * \param path the path of the directory to enumerate
@ -366,16 +366,19 @@ extern DECLSPEC Uint64 SDLCALL SDL_GetStorageSpaceRemaining(SDL_Storage *storage
* *
* \param storage a storage container * \param storage a storage container
* \param path the path of the directory to enumerate * \param path the path of the directory to enumerate
* \param pattern the pattern that files in the directory must match. Can be NULL. * \param pattern the pattern that files in the directory must match. Can be
* NULL.
* \param flags `SDL_GLOBDIR_*` bitflags that affect this search. * \param flags `SDL_GLOBDIR_*` bitflags that affect this search.
* \param count on return, will be set to the number of items in the returned array. Can be NULL. * \param count on return, will be set to the number of items in the returned
* array. Can be NULL.
* \returns an array of strings on success or NULL on failure; call * \returns an array of strings on success or NULL on failure; call
* SDL_GetError() for more information. The caller should pass the * SDL_GetError() for more information. The caller should pass the
* returned pointer to SDL_free when done with it. * returned pointer to SDL_free when done with it.
* *
* \since This function is available since SDL 3.0.0. * \threadsafety It is safe to call this function from any thread, assuming
* the `storage` object is thread-safe.
* *
* \threadsafety It is safe to call this function from any thread, assuming the `storage` object is thread-safe. * \since This function is available since SDL 3.0.0.
*/ */
extern DECLSPEC char **SDLCALL SDL_GlobStorageDirectory(SDL_Storage *storage, const char *path, const char *pattern, Uint32 flags, int *count); extern DECLSPEC char **SDLCALL SDL_GlobStorageDirectory(SDL_Storage *storage, const char *path, const char *pattern, Uint32 flags, int *count);