include: More improved docs for the wikibridge!

This commit is contained in:
Ryan C. Gordon 2024-04-11 00:36:48 -04:00
parent 5a58b3d97a
commit 407e54e188
No known key found for this signature in database
GPG key ID: FA148B892AB48044
4 changed files with 65 additions and 6 deletions

View file

@ -131,6 +131,18 @@ extern DECLSPEC void SDLCALL SDL_DelayNS(Uint64 ns);
* the next timer interval, in milliseconds. If the returned value is the same as the one
* passed in, the periodic alarm continues, otherwise a new alarm is
* scheduled. If the callback returns 0, the periodic alarm is cancelled.
*
* \param interval the current callback time interval.
* \param param an arbitrary pointer provided by the app through SDL_AddTimer, for its own use.
* \returns the new callback time interval, or 0 to disable further runs of the callback.
*
* \threadsafety SDL may call this callback at any time from a background
* thread; the application is responsible for locking resources
* the callback touches that need to be protected.
*
* \since This datatype is available since SDL 3.0.0.
*
* \sa SDL_AddTimer
*/
typedef Uint32 (SDLCALL *SDL_TimerCallback)(Uint32 interval, void *param);