NAME
SDL_SetRenderVSync - Toggle VSync of the given renderer.
HEADER FILE
Defined in SDL3/SDL_render.h
SYNOPSIS
#include "SDL3/SDL.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
Returns true on success or false on failure; call
SDL_GetError () 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
•(3), SDL_GetRenderVSync(3)