mirror of https://github.com/libsdl-org/SDL.git
9c664b0062
This lets apps optionally have a handful of callbacks for their entry points instead of a single main function. If used, the actual main/SDL_main/whatever entry point will be implemented in the single-header library SDL_main.h and the app will implement four separate functions:
First:
int SDL_AppInit(int argc, char **argv);
This will be called once before anything else. argc/argv work like they always do. If this returns 0, the app runs. If it returns < 0, the app calls SDL_AppQuit and terminates with an exit code that reports an error to the platform. If it returns > 0, the app calls SDL_AppQuit and terminates with an exit code that reports success to the platform. This function should not go into an infinite mainloop; it should do any one-time startup it requires and then return.
Then:
int SDL_AppIterate(void);
This is called over and over, possibly at the refresh rate of the display or some other metric that the platform dictates. This is where the heart of your app runs. It should return as quickly as reasonably possible, but it's not a "run one memcpy and that's all the time you have" sort of thing. The app should do any game updates, and render a frame of video. If it returns < 0, SDL will call SDL_AppQuit and terminate the process with an exit code that reports an error to the platform. If it returns > 0, the app calls SDL_AppQuit and terminates with an exit code that reports success to the platform. If it returns 0, then SDL_AppIterate will be called again at some regular frequency. The platform may choose to run this more or less (perhaps less in the background, etc), or it might just call this function in a loop as fast as possible. You do not check the event queue in this function (SDL_AppEvent exists for that).
Next:
int SDL_AppEvent(const SDL_Event *event);
This will be called once for each event pushed into the SDL queue. This may be called from any thread, and possibly in parallel to SDL_AppIterate. The fields in event do not need to be free'd (as you would normally need to do for SDL_EVENT_DROP_FILE, etc), and your app should not call SDL_PollEvent, SDL_PumpEvent, etc, as SDL will manage this for you. Return values are the same as from SDL_AppIterate(), so you can terminate in response to SDL_EVENT_QUIT, etc.
Finally:
void SDL_AppQuit(void);
This is called once before terminating the app--assuming the app isn't being forcibly killed or crashed--as a last chance to clean up. After this returns, SDL will call SDL_Quit so the app doesn't have to (but it's safe for the app to call it, too). Process termination proceeds as if the app returned normally from main(), so atexit handles will run, if your platform supports that.
The app does not implement SDL_main if using this. To turn this on, define SDL_MAIN_USE_CALLBACKS before including SDL_main.h. Defines like SDL_MAIN_HANDLED and SDL_MAIN_NOIMPL are also respected for callbacks, if the app wants to do some sort of magic main implementation thing.
In theory, on most platforms these can be implemented in the app itself, but this saves some #ifdefs in the app and lets everyone struggle less against some platforms, and might be more efficient in the long run, too.
On some platforms, it's possible this is the only reasonable way to go, but we haven't actually hit one that 100% requires it yet (but we will, if we want to write a RetroArch backend, for example).
Using the callback entry points works on every platform, because on platforms that don't require them, we can fake them with a simple loop in an internal implementation of the usual SDL_main.
The primary way we expect people to write SDL apps is with SDL_main, and this is not intended to replace it. If the app chooses to use this, it just removes some platform-specific details they might have to otherwise manage, and maybe removes a barrier to entry on some future platform.
Fixes #6785.
Reference PR #8247.
|
||
|---|---|---|
| .. | ||
| SDL.h | ||
| SDL_assert.h | ||
| SDL_atomic.h | ||
| SDL_audio.h | ||
| SDL_begin_code.h | ||
| SDL_bits.h | ||
| SDL_blendmode.h | ||
| SDL_clipboard.h | ||
| SDL_close_code.h | ||
| SDL_copying.h | ||
| SDL_cpuinfo.h | ||
| SDL_egl.h | ||
| SDL_endian.h | ||
| SDL_error.h | ||
| SDL_events.h | ||
| SDL_filesystem.h | ||
| SDL_gamepad.h | ||
| SDL_guid.h | ||
| SDL_haptic.h | ||
| SDL_hidapi.h | ||
| SDL_hints.h | ||
| SDL_init.h | ||
| SDL_intrin.h | ||
| SDL_joystick.h | ||
| SDL_keyboard.h | ||
| SDL_keycode.h | ||
| SDL_loadso.h | ||
| SDL_locale.h | ||
| SDL_log.h | ||
| SDL_main.h | ||
| SDL_main_impl.h | ||
| SDL_messagebox.h | ||
| SDL_metal.h | ||
| SDL_misc.h | ||
| SDL_mouse.h | ||
| SDL_mutex.h | ||
| SDL_oldnames.h | ||
| SDL_opengl.h | ||
| SDL_opengl_glext.h | ||
| SDL_opengles.h | ||
| SDL_opengles2.h | ||
| SDL_opengles2_gl2.h | ||
| SDL_opengles2_gl2ext.h | ||
| SDL_opengles2_gl2platform.h | ||
| SDL_opengles2_khrplatform.h | ||
| SDL_pixels.h | ||
| SDL_platform.h | ||
| SDL_platform_defines.h | ||
| SDL_power.h | ||
| SDL_properties.h | ||
| SDL_quit.h | ||
| SDL_rect.h | ||
| SDL_render.h | ||
| SDL_revision.h | ||
| SDL_rwops.h | ||
| SDL_scancode.h | ||
| SDL_sensor.h | ||
| SDL_shape.h | ||
| SDL_stdinc.h | ||
| SDL_surface.h | ||
| SDL_system.h | ||
| SDL_syswm.h | ||
| SDL_test.h | ||
| SDL_test_assert.h | ||
| SDL_test_common.h | ||
| SDL_test_compare.h | ||
| SDL_test_crc32.h | ||
| SDL_test_font.h | ||
| SDL_test_fuzzer.h | ||
| SDL_test_harness.h | ||
| SDL_test_log.h | ||
| SDL_test_md5.h | ||
| SDL_test_memory.h | ||
| SDL_test_random.h | ||
| SDL_thread.h | ||
| SDL_timer.h | ||
| SDL_touch.h | ||
| SDL_version.h | ||
| SDL_video.h | ||
| SDL_vulkan.h | ||