Scroll to navigation

SDL_GL_SetSwapInterval(3) SDL3 FUNCTIONS SDL_GL_SetSwapInterval(3)

NAME

SDL_GL_SetSwapInterval - Set the swap interval for the current OpenGL context.

HEADER FILE

Defined in SDL3/SDL_video.h

SYNOPSIS

#include "SDL3/SDL.h"
bool SDL_GL_SetSwapInterval(int interval);

DESCRIPTION

Some systems allow specifying -1 for the interval, to enable adaptive vsync. Adaptive vsync works the same as vsync, but if you've already missed the vertical retrace for a given frame, it swaps buffers immediately, which might be less jarring for the user during occasional framerate drops. If an application requests adaptive vsync and the system does not support it, this function will fail and return false. In such a case, you should probably retry the call with 1 for the interval.

Adaptive vsync is implemented for some glX drivers with GLX_EXT_swap_control_tear, and for some Windows drivers with WGL_EXT_swap_control_tear.

Read more on the Khronos wiki: https://www.khronos.org/opengl/wiki/Swap_Interval#Adaptive_Vsync

FUNCTION PARAMETERS

0 for immediate updates, 1 for updates synchronized with the vertical retrace, -1 for adaptive vsync.

RETURN VALUE

Returns true on success or false on failure; call

SDL_GetError () for more information.

AVAILABILITY

This function is available since SDL 3.1.3.

SEE ALSO

(3), SDL_GL_GetSwapInterval(3)

SDL 3.1.6 Simple Directmedia Layer