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

SDL_SetWindowSurfaceVSync

Toggle VSync for the window surface.

Header File

Syntax

bool SDL_SetWindowSurfaceVSync(SDL_Window *window, int vsync);


#define SDL_WINDOW_SURFACE_VSYNC_DISABLED 0
#define SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE (-1)

Function Parameters

SDL_Window *	window	the window.
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 window surface is created, vsync defaults to SDL_WINDOW_SURFACE_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_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.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.