SDL_SetRenderVSync - Man Page
Toggle VSync of the given renderer.
Synopsis
#include <SDL3/SDL_render.h> bool SDL_SetRenderVSync(SDL_Renderer *renderer, int vsync); #define SDL_RENDERER_VSYNC_DISABLED 0 #define SDL_RENDERER_VSYNC_ADAPTIVE (-1)
Description
When a renderer is created, vsync defaults to SDL_RENDERER_VSYNC_DISABLED.
The vsync parameter can be 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 driver, so you should check the return value to see whether the requested setting is supported.
Function Parameters
- renderer
the renderer to toggle.
- vsync
the vertical refresh sync interval.
Return Value
for more information.
Thread Safety
This function should only be called on the main thread.
Availability
This function is available since SDL 3.2.0.
See Also
Referenced By
SDL 3.2.16 Simple Directmedia Layer SDL3 FUNCTIONS