eden-emu/SDL
20
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

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
No known key found for this signature in database
GPG key ID: FA148B892AB48044
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. * When a renderer is created, vsync defaults to SDL_RENDERER_VSYNC_DISABLED.
* *
* \param renderer The renderer to toggle * The `vsync` parameter can be 1 to synchronize present with every vertical
* \param vsync the vertical refresh sync interval, 1 to synchronize present * refresh, 2 to synchronize present with every second vertical refresh, etc.,
* with every vertical refresh, 2 to synchronize present with * SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE for late swap tearing (adaptive vsync),
* every second vertical refresh, etc., * or SDL_WINDOW_SURFACE_VSYNC_DISABLED to disable. Not every value is
* SDL_RENDERER_VSYNC_ADAPTIVE for late swap tearing (adaptive * supported by every driver, so you should check the return value to see
* vsync), or SDL_RENDERER_VSYNC_DISABLED to disable. Not every * whether the requested setting is supported.
* value is supported by every renderer, so you should check the *
* return value to see whether the requested setting is * \param renderer The renderer to toggle.
* supported. * \param vsync the vertical refresh sync interval.
* \returns 0 on success or a negative error code on failure; call * \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information. * 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 * When a window surface is created, vsync defaults to
* SDL_WINDOW_SURFACE_VSYNC_DISABLED. * SDL_WINDOW_SURFACE_VSYNC_DISABLED.
* *
* \param window the window * The `vsync` parameter can be 1 to synchronize present with every vertical
* \param vsync the vertical refresh sync interval, 1 to synchronize present * refresh, 2 to synchronize present with every second vertical refresh, etc.,
* with every vertical refresh, 2 to synchronize present with * SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE for late swap tearing (adaptive vsync),
* every second vertical refresh, etc., * or SDL_WINDOW_SURFACE_VSYNC_DISABLED to disable. Not every value is
* SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE for late swap tearing * supported by every driver, so you should check the return value to see
* (adaptive vsync), or SDL_WINDOW_SURFACE_VSYNC_DISABLED to * whether the requested setting is supported.
* disable. Not every value is supported by every driver, so you *
* should check the return value to see whether the requested * \param window the window.
* setting is supported. * \param vsync the vertical refresh sync interval.
* \returns 0 on success or a negative error code on failure; call * \returns 0 on success or a negative error code on failure; call
* SDL_GetError() for more information. * SDL_GetError() for more information.
* *