mirrors/SDL
0
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2024-12-14 06:53:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

Browse Source
This commit is contained in:
SDL Wiki Bot 2024-05-27 20:04:46 +00:00
parent 3364aff757
commit 7c75801571
1 changed files with 27 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
include/SDL3/SDL_main.h
View File

@ -277,23 +277,21 @@ typedef void (SDLCALL *SDL_AppQuit_func)(void *appstate);
* to use a global variable. If this isn't set, the pointer will be NULL in * to use a global variable. If this isn't set, the pointer will be NULL in
* future entry points. * future entry points.
* *
* If this function returns SDL_APP_CONTINUE, the app will proceed * If this function returns SDL_APP_CONTINUE, the app will proceed to normal
* to normal operation, and will begin receiving repeated calls to * operation, and will begin receiving repeated calls to SDL_AppIterate and
* SDL_AppIterate and SDL_AppEvent for the life of the program. If this * SDL_AppEvent for the life of the program. If this function returns
* function returns SDL_APP_FAILURE, SDL will call SDL_AppQuit * SDL_APP_FAILURE, SDL will call SDL_AppQuit and terminate the process with
* and terminate the process with an exit code that reports an error to the * an exit code that reports an error to the platform. If it returns
* platform. If it returns SDL_APP_SUCCESS, SDL calls * SDL_APP_SUCCESS, SDL calls SDL_AppQuit and terminates with an exit code
* SDL_AppQuit and terminates with an exit code that reports success to the * that reports success to the platform.
* platform.
* *
* \param appstate a place where the app can optionally store a pointer for * \param appstate a place where the app can optionally store a pointer for
* future use. * future use.
* \param argc The standard ANSI C main's argc; number of elements in `argv` * \param argc The standard ANSI C main's argc; number of elements in `argv`
* \param argv The standard ANSI C main's argv; array of command line * \param argv The standard ANSI C main's argv; array of command line
* arguments. * arguments.
* \returns SDL_APP_FAILURE to terminate with an error, * \returns SDL_APP_FAILURE to terminate with an error, SDL_APP_SUCCESS to
* SDL_APP_SUCCESS to terminate with success, * terminate with success, SDL_APP_CONTINUE to continue.
* SDL_APP_CONTINUE to continue.
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
@ -332,18 +330,17 @@ extern SDLMAIN_DECLSPEC int SDLCALL SDL_AppInit(void **appstate, int argc, char
* The `appstate` parameter is an optional pointer provided by the app during * The `appstate` parameter is an optional pointer provided by the app during
* SDL_AppInit(). If the app never provided a pointer, this will be NULL. * SDL_AppInit(). If the app never provided a pointer, this will be NULL.
* *
* If this function returns SDL_APP_CONTINUE, the app will continue * If this function returns SDL_APP_CONTINUE, the app will continue normal
* normal operation, receiving repeated calls to SDL_AppIterate and * operation, receiving repeated calls to SDL_AppIterate and SDL_AppEvent for
* SDL_AppEvent for the life of the program. If this function returns * the life of the program. If this function returns SDL_APP_FAILURE, SDL will
* SDL_APP_FAILURE, SDL will call SDL_AppQuit and terminate the * call SDL_AppQuit and terminate the process with an exit code that reports
* process with an exit code that reports an error to the platform. If it * an error to the platform. If it returns SDL_APP_SUCCESS, SDL calls
* returns SDL_APP_SUCCESS, SDL calls SDL_AppQuit and * SDL_AppQuit and terminates with an exit code that reports success to the
* terminates with an exit code that reports success to the platform. * platform.
* *
* \param appstate an optional pointer, provided by the app in SDL_AppInit. * \param appstate an optional pointer, provided by the app in SDL_AppInit.
* \returns SDL_APP_FAILURE to terminate with an error, * \returns SDL_APP_FAILURE to terminate with an error, SDL_APP_SUCCESS to
* SDL_APP_SUCCESS to terminate with success, * terminate with success, SDL_APP_CONTINUE to continue.
* SDL_APP_CONTINUE to continue.
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
@ -379,19 +376,18 @@ extern SDLMAIN_DECLSPEC int SDLCALL SDL_AppIterate(void *appstate);
* The `appstate` parameter is an optional pointer provided by the app during * The `appstate` parameter is an optional pointer provided by the app during
* SDL_AppInit(). If the app never provided a pointer, this will be NULL. * SDL_AppInit(). If the app never provided a pointer, this will be NULL.
* *
* If this function returns SDL_APP_CONTINUE, the app will continue * If this function returns SDL_APP_CONTINUE, the app will continue normal
* normal operation, receiving repeated calls to SDL_AppIterate and * operation, receiving repeated calls to SDL_AppIterate and SDL_AppEvent for
* SDL_AppEvent for the life of the program. If this function returns * the life of the program. If this function returns SDL_APP_FAILURE, SDL will
* SDL_APP_FAILURE, SDL will call SDL_AppQuit and terminate the * call SDL_AppQuit and terminate the process with an exit code that reports
* process with an exit code that reports an error to the platform. If it * an error to the platform. If it returns SDL_APP_SUCCESS, SDL calls
* returns SDL_APP_SUCCESS, SDL calls SDL_AppQuit and * SDL_AppQuit and terminates with an exit code that reports success to the
* terminates with an exit code that reports success to the platform. * platform.
* *
* \param appstate an optional pointer, provided by the app in SDL_AppInit. * \param appstate an optional pointer, provided by the app in SDL_AppInit.
* \param event the new event for the app to examine. * \param event the new event for the app to examine.
* \returns SDL_APP_FAILURE to terminate with an error, * \returns SDL_APP_FAILURE to terminate with an error, SDL_APP_SUCCESS to
* SDL_APP_SUCCESS to terminate with success, * terminate with success, SDL_APP_CONTINUE to continue.
* SDL_APP_CONTINUE to continue.
* *
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *