ryujinx/SDL
1
0
Fork 0
mirror of https://github.com/Ryujinx/SDL.git synced 2025-01-09 22:25:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sync wiki -> header

Browse source
This commit is contained in:
SDL Wiki Bot 2021-11-18 20:58:04 +00:00
parent 3f978c0f93
commit e526830996
1 changed files with 20 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
include/SDL_main.h
View file

@ -141,22 +141,22 @@ extern DECLSPEC void SDLCALL SDL_SetMainReady(void);
/** /**
* Register a win32 window class for SDL's use. * Register a win32 window class for SDL's use.
* *
* This can be called to set the application window class at startup. * This can be called to set the application window class at startup. It is
* It is safe to call this multiple times, as long as every call is * safe to call this multiple times, as long as every call is eventually
* eventually paired with a call to SDL_UnregisterApp, but a second * paired with a call to SDL_UnregisterApp, but a second registration attempt
* registration attempt while a previous registration is still active * while a previous registration is still active will be ignored, other than
* will be ignored, other than to increment a counter. * to increment a counter.
* *
* Most applications do not need to, and should not, call this directly; * Most applications do not need to, and should not, call this directly; SDL
* SDL will call it when initializing the video subsystem. * will call it when initializing the video subsystem.
* *
* \param name the window class name, in UTF-8 encoding. If NULL, * \param name the window class name, in UTF-8 encoding. If NULL, SDL
* SDL currently uses "SDL_app" but this isn't guaranteed. * currently uses "SDL_app" but this isn't guaranteed.
* \param style the value to use in WNDCLASSEX::style. If `name` is * \param style the value to use in WNDCLASSEX::style. If `name` is NULL, SDL
* NULL, SDL currently uses `(CS_BYTEALIGNCLIENT | CS_OWNDC)` * currently uses `(CS_BYTEALIGNCLIENT | CS_OWNDC)` regardless of
* regardless of what is specified here. * what is specified here.
* \param hInst the HINSTANCE to use in WNDCLASSEX::hInstance. If zero, * \param hInst the HINSTANCE to use in WNDCLASSEX::hInstance. If zero, SDL
* SDL will use `GetModuleHandle(NULL)` instead. * will use `GetModuleHandle(NULL)` instead.
* \returns 0 on success, -1 on error. SDL_GetError() may have details. * \returns 0 on success, -1 on error. SDL_GetError() may have details.
* *
* \since This function is available since SDL 2.0.2. * \since This function is available since SDL 2.0.2.
@ -168,13 +168,13 @@ extern DECLSPEC int SDLCALL SDL_RegisterApp(const char *name, Uint32 style, void
* *
* This can be called to undo the effects of SDL_RegisterApp. * This can be called to undo the effects of SDL_RegisterApp.
* *
* Most applications do not need to, and should not, call this directly; * Most applications do not need to, and should not, call this directly; SDL
* SDL will call it when deinitializing the video subsystem. * will call it when deinitializing the video subsystem.
* *
* It is safe to call this multiple times, as long as every call is * It is safe to call this multiple times, as long as every call is eventually
* eventually paired with a prior call to SDL_RegisterApp. The window * paired with a prior call to SDL_RegisterApp. The window class will only be
* class will only be deregistered when the registration counter in * deregistered when the registration counter in SDL_RegisterApp decrements to
* SDL_RegisterApp decrements to zero through calls to this function. * zero through calls to this function.
* *
* \since This function is available since SDL 2.0.2. * \since This function is available since SDL 2.0.2.
*/ */