NAME¶

SDL_AppResult - Return values for optional main callbacks.

HEADER FILE¶

Defined in SDL3/SDL_init.h

SYNOPSIS¶

#include "SDL3/SDL.h"

typedef enum SDL_AppResult
{
    SDL_APP_CONTINUE,   /**< Value that requests that the app continue from the main callbacks. */
    SDL_APP_SUCCESS,    /**< Value that requests termination with success from the main callbacks. */
    SDL_APP_FAILURE     /**< Value that requests termination with error from the main callbacks. */
} SDL_AppResult;

DESCRIPTION¶

Returning SDL_APP_SUCCESS
or

SDL_APP_FAILURE
from SDL_AppInit ,

SDL_AppEvent , or SDL_AppIterate
will terminate the program and report success/failure to the operating system. What that means is platform-dependent. On Unix, for example, on success, the process error code will be zero, and on failure it will be 1. This interface doesn't allow you to return specific exit codes, just whether there was an error generally or not.

Returning SDL_APP_CONTINUE
from these functions will let the app continue to run.

See

⟨URL: ⟩

for complete details.

AVAILABILITY¶

This enum is available since SDL 3.1.3.