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

SDL_main.h: Document SDL_MAIN_USE_CALLBACKS.

Browse Source
This commit is contained in:
Ryan C. Gordon 2024-05-03 09:40:35 -04:00
parent 3bd04e5a34
commit d570fd7c2c
No known key found for this signature in database
GPG Key ID: FA148B892AB48044
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
include/SDL3/SDL_main.h
View File

@ -151,6 +151,31 @@
* ```
*/
#ifdef SDL_WIKI_DOCUMENTATION_SECTION
/**
* Inform SDL to use the main callbacks instead of main.
*
* SDL does not define this macro, but will check if it is defined to
* any value in SDL_main.h. If defined, SDL will expect the app
* to provide several functions: SDL_AppInit, SDL_AppEvent,
* SDL_AppIterate, and SDL_AppQuit. The app should not provide
* a `main` function in this case, and doing so will likely cause
* the build to fail.
*
* Please see [README/main-functions](README/main-functions), (or
* docs/README-main-functions.md in the source tree) for a more
* detailed explanation.
*
* \since This macro is used by the headers since SDL 3.0.0.
*
* \sa SDL_AppInit
* \sa SDL_AppEvent
* \sa SDL_AppIterate
* \sa SDL_AppQuit
*/
#define SDL_MAIN_USE_CALLBACKS 1
#endif
#if defined(SDL_MAIN_NEEDED) || defined(SDL_MAIN_AVAILABLE) || defined(SDL_MAIN_USE_CALLBACKS)
#define main SDL_main
#endif