SDL_SetGPUSwapchainParameters(3)

SDL_SetGPUSwapchainParameters3

Changes the swapchain parameters for the given claimed window.

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_gpu.h

Overview

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.

Function parameters

device

a GPU context.

window

an SDL_Window
that has been claimed.

swapchain_composition

the desired composition of the swapchain.

present_mode

the desired present mode for the swapchain.

Return value

Returns true if successful, false on error; call

SDL_GetError () for more information.

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.