shadps4-emu/ext-SDL
1
0
Fork 0
mirror of https://github.com/shadps4-emu/ext-SDL.git synced 2024-11-23 10:09:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

include: Small clarification on directory enumeration documentation.

Browse Source
This commit is contained in:
Ryan C. Gordon 2024-09-26 16:39:35 -04:00
parent 38f971bac5
commit 4e09e58f62
No known key found for this signature in database
GPG Key ID: FA148B892AB48044
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/SDL3/SDL_filesystem.h
View File

@ -272,6 +272,10 @@ typedef int (SDLCALL *SDL_EnumerateDirectoryCallback)(void *userdata, const char
* callback, called once for each directory entry, until all results have been
* provided or the callback returns <= 0.
*
* This will return false if there was a system problem in general, or if a
* callback returns -1. A successful return means a callback returned 1 to
* halt enumeration, or all directory entries were enumerated.
*
* \param path the path of the directory to enumerate.
* \param callback a function that is called for each entry in the directory.
* \param userdata a pointer that is passed to `callback`.

4
include/SDL3/SDL_storage.h
View File

@ -320,6 +320,10 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CreateStorageDirectory(SDL_Storage *storage
* callback, called once for each directory entry, until all results have been
* provided or the callback returns <= 0.
*
* This will return false if there was a system problem in general, or if a
* callback returns -1. A successful return means a callback returned 1 to
* halt enumeration, or all directory entries were enumerated.
*
* \param storage a storage container.
* \param path the path of the directory to enumerate.
* \param callback a function that is called for each entry in the directory.