SDL_GL_GetSwapInterval - Man Page

Get the swap interval for the current OpenGL context.

Synopsis

#include <SDL3/SDL_video.h>

bool SDL_GL_GetSwapInterval(int *interval);

Description

If the system can't determine the swap interval, or there isn't a valid current context, this function will set *interval to 0 as a safe default.

Function Parameters

interval

output interval value. 0 if there is no vertical retrace synchronization, 1 if the buffer swap is synchronized with the vertical retrace, and -1 if late swaps happen immediately instead of waiting for the next retrace.

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

SDL_GL_SetSwapInterval(3)

Referenced By

SDL_GL_SetSwapInterval(3).

SDL 3.3.2 Simple Directmedia Layer SDL3 FUNCTIONS