Update description of SDL_SetWindowAlwaysOnTop

main
Cameron Cawley 2021-09-17 20:24:10 +01:00 committed by Ryan C. Gordon
parent 5dccffd7e4
commit 2d44bf7dcf
1 changed files with 9 additions and 8 deletions

View File

@ -1031,18 +1031,19 @@ extern DECLSPEC void SDLCALL SDL_SetWindowResizable(SDL_Window * window,
SDL_bool resizable); SDL_bool resizable);
/** /**
* \brief Set the window to always be above the others. * Set the window to always be above the others.
* *
* This will add or remove the window's `SDL_WINDOW_ALWAYS_ON_TOP` * This will add or remove the window's `SDL_WINDOW_ALWAYS_ON_TOP`
* flag. This will bring the window to the front and keep the window above * flag. This will bring the window to the front and keep the window above
* the rest. * the rest.
* *
* \param window The window of which to change the always on top state. * \param window The window of which to change the always on top state
* \param on_top SDL_TRUE to set the window always on top, SDL_FALSE to disable. * \param on_top SDL_TRUE to set the window always on top, SDL_FALSE to disable
* *
* \sa SDL_SetWindowAlwaysOnTop * \since This function is available since SDL 2.0.16.
*
* \sa SDL_GetWindowFlags
*/ */
extern DECLSPEC void SDLCALL SDL_SetWindowAlwaysOnTop(SDL_Window * window, extern DECLSPEC void SDLCALL SDL_SetWindowAlwaysOnTop(SDL_Window * window,
SDL_bool on_top); SDL_bool on_top);
/** /**