Sync SDL3 wiki -> header
[ci skip]
This commit is contained in:
parent
6b048f59d7
commit
89a8cf2505
5 changed files with 10 additions and 10 deletions
|
@ -103,7 +103,7 @@ getting started.
|
||||||
|
|
||||||
Another option is to use SDL' main callbacks, which handle this for you
|
Another option is to use SDL' main callbacks, which handle this for you
|
||||||
without platform-specific code in your app. Please refer to
|
without platform-specific code in your app. Please refer to
|
||||||
[the wiki](https://wiki.libsdl.org/SDL3/README/main-functions#main-callbacks-in-sdl3)
|
[the wiki](https://wiki.libsdl.org/SDL3/README-main-functions#main-callbacks-in-sdl3)
|
||||||
or `docs/README-main-functions.md` in the SDL source code.
|
or `docs/README-main-functions.md` in the SDL source code.
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -101,7 +101,7 @@ typedef Uint32 SDL_InitFlags;
|
||||||
* to run.
|
* to run.
|
||||||
*
|
*
|
||||||
* See
|
* See
|
||||||
* [Main callbacks in SDL3](https://wiki.libsdl.org/SDL3/README/main-functions#main-callbacks-in-sdl3)
|
* [Main callbacks in SDL3](https://wiki.libsdl.org/SDL3/README-main-functions#main-callbacks-in-sdl3)
|
||||||
* for complete details.
|
* for complete details.
|
||||||
*
|
*
|
||||||
* \since This enum is available since SDL 3.2.0.
|
* \since This enum is available since SDL 3.2.0.
|
||||||
|
|
|
@ -47,7 +47,7 @@
|
||||||
*
|
*
|
||||||
* For more information, see:
|
* For more information, see:
|
||||||
*
|
*
|
||||||
* https://wiki.libsdl.org/SDL3/README/main-functions
|
* https://wiki.libsdl.org/SDL3/README-main-functions
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef SDL_main_h_
|
#ifndef SDL_main_h_
|
||||||
|
@ -68,7 +68,7 @@
|
||||||
* proper entry point for the platform, and all the other magic details
|
* proper entry point for the platform, and all the other magic details
|
||||||
* needed, like manually calling SDL_SetMainReady.
|
* needed, like manually calling SDL_SetMainReady.
|
||||||
*
|
*
|
||||||
* Please see [README/main-functions](README/main-functions), (or
|
* Please see [README-main-functions](README-main-functions), (or
|
||||||
* docs/README-main-functions.md in the source tree) for a more detailed
|
* docs/README-main-functions.md in the source tree) for a more detailed
|
||||||
* explanation.
|
* explanation.
|
||||||
*
|
*
|
||||||
|
@ -85,7 +85,7 @@
|
||||||
* SDL_AppQuit. The app should not provide a `main` function in this case, and
|
* SDL_AppQuit. The app should not provide a `main` function in this case, and
|
||||||
* doing so will likely cause the build to fail.
|
* doing so will likely cause the build to fail.
|
||||||
*
|
*
|
||||||
* Please see [README/main-functions](README/main-functions), (or
|
* Please see [README-main-functions](README-main-functions), (or
|
||||||
* docs/README-main-functions.md in the source tree) for a more detailed
|
* docs/README-main-functions.md in the source tree) for a more detailed
|
||||||
* explanation.
|
* explanation.
|
||||||
*
|
*
|
||||||
|
@ -512,7 +512,7 @@ typedef int (SDLCALL *SDL_main_func)(int argc, char *argv[]);
|
||||||
* SDL_MAIN_USE_CALLBACKS.
|
* SDL_MAIN_USE_CALLBACKS.
|
||||||
*
|
*
|
||||||
* Program startup is a surprisingly complex topic. Please see
|
* Program startup is a surprisingly complex topic. Please see
|
||||||
* [README/main-functions](README/main-functions), (or
|
* [README-main-functions](README-main-functions), (or
|
||||||
* docs/README-main-functions.md in the source tree) for a more detailed
|
* docs/README-main-functions.md in the source tree) for a more detailed
|
||||||
* explanation.
|
* explanation.
|
||||||
*
|
*
|
||||||
|
|
|
@ -247,14 +247,14 @@ typedef void (SDLCALL *SDL_iOSAnimationCallback)(void *userdata);
|
||||||
*
|
*
|
||||||
* For more information see:
|
* For more information see:
|
||||||
*
|
*
|
||||||
* https://wiki.libsdl.org/SDL3/README/ios
|
* https://wiki.libsdl.org/SDL3/README-ios
|
||||||
*
|
*
|
||||||
* Note that if you use the "main callbacks" instead of a standard C `main`
|
* Note that if you use the "main callbacks" instead of a standard C `main`
|
||||||
* function, you don't have to use this API, as SDL will manage this for you.
|
* function, you don't have to use this API, as SDL will manage this for you.
|
||||||
*
|
*
|
||||||
* Details on main callbacks are here:
|
* Details on main callbacks are here:
|
||||||
*
|
*
|
||||||
* https://wiki.libsdl.org/SDL3/README/main-functions
|
* https://wiki.libsdl.org/SDL3/README-main-functions
|
||||||
*
|
*
|
||||||
* \param window the window for which the animation callback should be set.
|
* \param window the window for which the animation callback should be set.
|
||||||
* \param interval the number of frames after which **callback** will be
|
* \param interval the number of frames after which **callback** will be
|
||||||
|
|
|
@ -1303,7 +1303,7 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreatePopupWindow(SDL_Window *paren
|
||||||
* - `SDL_PROP_WINDOW_CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN` - true if
|
* - `SDL_PROP_WINDOW_CREATE_WAYLAND_SURFACE_ROLE_CUSTOM_BOOLEAN` - true if
|
||||||
* the application wants to use the Wayland surface for a custom role and
|
* the application wants to use the Wayland surface for a custom role and
|
||||||
* does not want it attached to an XDG toplevel window. See
|
* does not want it attached to an XDG toplevel window. See
|
||||||
* [README/wayland](README/wayland) for more information on using custom
|
* [README-wayland](README-wayland) for more information on using custom
|
||||||
* surfaces.
|
* surfaces.
|
||||||
* - `SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN` - true if the
|
* - `SDL_PROP_WINDOW_CREATE_WAYLAND_CREATE_EGL_WINDOW_BOOLEAN` - true if the
|
||||||
* application wants an associated `wl_egl_window` object to be created and
|
* application wants an associated `wl_egl_window` object to be created and
|
||||||
|
@ -1311,7 +1311,7 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_CreatePopupWindow(SDL_Window *paren
|
||||||
* property or `SDL_WINDOW_OPENGL` flag set.
|
* property or `SDL_WINDOW_OPENGL` flag set.
|
||||||
* - `SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER` - the wl_surface
|
* - `SDL_PROP_WINDOW_CREATE_WAYLAND_WL_SURFACE_POINTER` - the wl_surface
|
||||||
* associated with the window, if you want to wrap an existing window. See
|
* associated with the window, if you want to wrap an existing window. See
|
||||||
* [README/wayland](README/wayland) for more information.
|
* [README-wayland](README-wayland) for more information.
|
||||||
*
|
*
|
||||||
* These are additional supported properties on Windows:
|
* These are additional supported properties on Windows:
|
||||||
*
|
*
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue