(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_SetGPUSwapchainParameters

Changes the swapchain parameters for the given claimed window.

Header File

Syntax

bool SDL_SetGPUSwapchainParameters(
    SDL_GPUDevice *device,
    SDL_Window *window,
    SDL_GPUSwapchainComposition swapchain_composition,
    SDL_GPUPresentMode present_mode);

Function Parameters

SDL_GPUDevice *	device	a GPU context.
SDL_Window *	window	an SDL_Window that has been claimed.
SDL_GPUSwapchainComposition	swapchain_composition	the desired composition of the swapchain.
SDL_GPUPresentMode	present_mode	the desired present mode for the swapchain.

Return Value

(bool) Returns true if successful, false on error; call SDL_GetError() for more information.

Remarks

This function will fail if the requested present mode or swapchain composition are unsupported by the device. Check if the parameters are supported via SDL_WindowSupportsGPUPresentMode / SDL_WindowSupportsGPUSwapchainComposition prior to calling this function.

SDL_GPU_PRESENTMODE_VSYNC and SDL_GPU_SWAPCHAINCOMPOSITION_SDR are always supported.

Version

This function is available since SDL 3.1.3.