SDL_GL_GetSwapInterval(3)

SDL_GL_GetSwapInterval3

Get the swap interval for the current opengl context.

Usage

#include "SDL3/SDL.h"

bool SDL_GL_GetSwapInterval(int *interval);

Header file

Defined in SDL3/SDL_video.h

Overview

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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.