From 6524f9c9b8459a54bb5eeb7bd456fca131daa4e4 Mon Sep 17 00:00:00 2001 From: SDL Wiki Bot Date: Mon, 27 May 2024 20:12:47 +0000 Subject: [PATCH] Sync SDL3 wiki -> header --- include/SDL3/SDL_video.h | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/include/SDL3/SDL_video.h b/include/SDL3/SDL_video.h index 84d0173327..15701374e6 100644 --- a/include/SDL3/SDL_video.h +++ b/include/SDL3/SDL_video.h @@ -1804,10 +1804,18 @@ extern SDL_DECLSPEC SDL_Surface *SDLCALL SDL_GetWindowSurface(SDL_Window *window /** * Toggle VSync for the window surface. * - * When a window surface is created, vsync defaults to SDL_WINDOW_SURFACE_VSYNC_DISABLED. + * When a window surface is created, vsync defaults to + * SDL_WINDOW_SURFACE_VSYNC_DISABLED. * * \param window the window - * \param vsync the vertical refresh sync interval, 1 to synchronize present with every vertical refresh, 2 to synchronize present with every second vertical refresh, etc., SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE for late swap tearing (adaptive vsync), or SDL_WINDOW_SURFACE_VSYNC_DISABLED to disable. Not every value is supported by every driver, so you should check the return value to see whether the requested setting is supported. + * \param vsync the vertical refresh sync interval, 1 to synchronize present + * with every vertical refresh, 2 to synchronize present with + * every second vertical refresh, etc., + * SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE for late swap tearing + * (adaptive vsync), or SDL_WINDOW_SURFACE_VSYNC_DISABLED to + * disable. Not every value is supported by every driver, so you + * should check the return value to see whether the requested + * setting is supported. * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. *