Sync SDL3 wiki -> header

This commit is contained in:
SDL Wiki Bot
2024-05-27 16:59:55 +00:00
parent 0fe9900429
commit a086144dad

View File

@@ -280,11 +280,11 @@ typedef void (SDLCALL *SDL_AppQuit_func)(void *appstate);
* If this function returns SDL_MAIN_CALLBACK_CONTINUE, the app will proceed * If this function returns SDL_MAIN_CALLBACK_CONTINUE, the app will proceed
* to normal operation, and will begin receiving repeated calls to * to normal operation, and will begin receiving repeated calls to
* SDL_AppIterate and SDL_AppEvent for the life of the program. If this * SDL_AppIterate and SDL_AppEvent for the life of the program. If this
* function returns SDL_MAIN_CALLBACK_EXIT_FAILURE, SDL will call * function returns SDL_MAIN_CALLBACK_EXIT_FAILURE, SDL will call SDL_AppQuit
* SDL_AppQuit and terminate the process with an exit code that reports an * and terminate the process with an exit code that reports an error to the
* error to the platform. If it returns SDL_MAIN_CALLBACK_EXIT_SUCCESS, SDL * platform. If it returns SDL_MAIN_CALLBACK_EXIT_SUCCESS, SDL calls
* calls SDL_AppQuit and terminates with an exit code that reports success to * SDL_AppQuit and terminates with an exit code that reports success to the
* 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.
@@ -335,18 +335,16 @@ extern SDLMAIN_DECLSPEC int SDLCALL SDL_AppInit(void **appstate, int argc, char
* If this function returns SDL_MAIN_CALLBACK_CONTINUE, the app will continue * If this function returns SDL_MAIN_CALLBACK_CONTINUE, the app will continue
* normal operation, receiving repeated calls to SDL_AppIterate and * normal operation, receiving repeated calls to SDL_AppIterate and
* SDL_AppEvent for the life of the program. If this function returns * SDL_AppEvent for the life of the program. If this function returns
* SDL_MAIN_CALLBACK_EXIT_FAILURE, SDL will call SDL_AppQuit and * SDL_MAIN_CALLBACK_EXIT_FAILURE, SDL will call SDL_AppQuit and terminate the
* terminate the process with an exit code that reports an error to the * process with an exit code that reports an error to the platform. If it
* platform. If it returns SDL_MAIN_CALLBACK_EXIT_SUCCESS, SDL calls * returns SDL_MAIN_CALLBACK_EXIT_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_MAIN_CALLBACK_EXIT_FAILURE to terminate with an error, * \returns SDL_MAIN_CALLBACK_EXIT_FAILURE to terminate with an error,
* SDL_MAIN_CALLBACK_EXIT_SUCCESS to terminate with success, * SDL_MAIN_CALLBACK_EXIT_SUCCESS to terminate with success,
* SDL_MAIN_CALLBACK_CONTINUE to continue. * SDL_MAIN_CALLBACK_CONTINUE to continue.
* *
*
* \threadsafety This function is not thread safe. * \threadsafety This function is not thread safe.
* *
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.