(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_SetRenderVSync

Toggle VSync of the given renderer.

Header File

Syntax

bool SDL_SetRenderVSync(SDL_Renderer *renderer, int vsync);


#define SDL_RENDERER_VSYNC_DISABLED 0
#define SDL_RENDERER_VSYNC_ADAPTIVE (-1)

Function Parameters

SDL_Renderer *	renderer	the renderer to toggle.
int	vsync	the vertical refresh sync interval.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

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.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.