Updated documentation so it's clear you should use SDL_SetWindowDisplayMode() to change the size of fullscreen windows.

This commit is contained in:
Sam Lantinga 2017-09-09 11:04:35 -07:00
parent b2ba8963b3
commit 569c222ca8
1 changed files with 3 additions and 2 deletions

View File

@ -604,8 +604,8 @@ extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window,
* \param w The width of the window, in screen coordinates. Must be >0. * \param w The width of the window, in screen coordinates. Must be >0.
* \param h The height of the window, in screen coordinates. Must be >0. * \param h The height of the window, in screen coordinates. Must be >0.
* *
* \note You can't change the size of a fullscreen window, it automatically * \note Fullscreen windows automatically match the size of the display mode,
* matches the size of the display mode. * and you should use SDL_SetWindowDisplayMode() to change their size.
* *
* The window size in screen coordinates may differ from the size in pixels, if * The window size in screen coordinates may differ from the size in pixels, if
* the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a platform with * the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a platform with
@ -613,6 +613,7 @@ extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window,
* SDL_GetRendererOutputSize() to get the real client area size in pixels. * SDL_GetRendererOutputSize() to get the real client area size in pixels.
* *
* \sa SDL_GetWindowSize() * \sa SDL_GetWindowSize()
* \sa SDL_SetWindowDisplayMode()
*/ */
extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w, extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w,
int h); int h);