SDL_ClaimWindowForGPUDevice - Claims a window, creating a swapchain structure for it.
Contents
Availability
This function is available since SDL 3.2.0.
Description
This must be called before
SDL_AcquireGPUSwapchainTexture
is called using the window. You should only call this function from the thread that created the window.
The swapchain will be created with
SDL_GPU_SWAPCHAINCOMPOSITION_SDR
and
SDL_GPU_PRESENTMODE_VSYNC . If you want to have different swapchain parameters, you must call
SDL_SetGPUSwapchainParameters
after claiming the window.
Function Parameters
device a GPU context.
window an SDL_Window .
Header File
Defined in SDL3/SDL_gpu.h
Name
SDL_ClaimWindowForGPUDevice - Claims a window, creating a swapchain structure for it.
Return Value
Returns true on success, or false on failure; call
SDL_GetError () for more information.
See Also
•(3), SDL_WaitAndAcquireGPUSwapchainTexture(3), •(3), SDL_ReleaseWindowFromGPUDevice(3), •(3), SDL_WindowSupportsGPUPresentMode(3), •(3), SDL_WindowSupportsGPUSwapchainComposition(3) Simple Directmedia Layer SDL 3.2.10 SDL_ClaimWindowForGPUDevice(3)
Synopsis
#include"SDL3/SDL.h"boolSDL_ClaimWindowForGPUDevice(SDL_GPUDevice*device,SDL_Window*window);
Thread Safety
This function should only be called from the thread that created the window.
