SDL_SetWindowSurfaceVSync3
Toggle vsync for the window surface.
Usage
#include "SDL3/SDL.h"
bool SDL_SetWindowSurfaceVSync(SDL_Window *window, int vsync); #define SDL_WINDOW_SURFACE_VSYNC_DISABLED 0 #define SDL_WINDOW_SURFACE_VSYNC_ADAPTIVE (-1)
Header file
Defined in SDL3/SDL_video.h
Overview
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.
Function parameters
window
|
the window. |
|---|---|
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.