SDL_SetGPUSwapchainParameters - Changes the swapchain parameters for the given claimed window.
Contents
Availability
This function is available since SDL 3.2.0.
Description
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.
Header File
Defined in SDL3/SDL_gpu.h
Name
SDL_SetGPUSwapchainParameters - Changes the swapchain parameters for the given claimed window.
Return Value
Returns true if successful, false on error; call
SDL_GetError () for more information.
See Also
•(3), SDL_WindowSupportsGPUPresentMode(3), •(3), SDL_WindowSupportsGPUSwapchainComposition(3) Simple Directmedia Layer SDL 3.2.10 SDL_SetGPUSwapchainParameters(3)
Synopsis
#include"SDL3/SDL.h"boolSDL_SetGPUSwapchainParameters(SDL_GPUDevice*device,SDL_Window*window,SDL_GPUSwapchainCompositionswapchain_composition,SDL_GPUPresentModepresent_mode);
