mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-09-05 19:08:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

include: Tweaked some vsync-related documentation.

Browse Source 
Reference PR #9903.
This commit is contained in:
Ryan C. Gordon
2024-05-27 16:57:21 -04:00
parent 6524f9c9b8
commit e508d82f74
2 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
include/SDL3/SDL_render.h
View File

@@ -2144,15 +2144,15 @@ extern SDL_DECLSPEC int SDLCALL SDL_AddVulkanRenderSemaphores(SDL_Renderer *rend
*
* When a renderer is created, vsync defaults to SDL_RENDERER_VSYNC_DISABLED.
*
* \param renderer The renderer to toggle
* \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_RENDERER_VSYNC_ADAPTIVE for late swap tearing (adaptive
* vsync), or SDL_RENDERER_VSYNC_DISABLED to disable. Not every
* value is supported by every renderer, so you should check the
* return value to see whether the requested setting is
* supported.
* The `vsync` parameter can be 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 renderer The renderer to toggle.
* \param vsync the vertical refresh sync interval.
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*

18
include/SDL3/SDL_video.h
View File

@@ -1807,15 +1807,15 @@ extern SDL_DECLSPEC SDL_Surface *SDLCALL SDL_GetWindowSurface(SDL_Window *window
* 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.
* The `vsync` parameter can be 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 window the window.
* \param vsync the vertical refresh sync interval.
* \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information.
*