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

SDL_ClaimWindowForGPUDevice

Claims a window, creating a swapchain structure for it.

Header File

Syntax

bool SDL_ClaimWindowForGPUDevice(
    SDL_GPUDevice *device,
    SDL_Window *window);

Function Parameters

SDL_GPUDevice *	device	a GPU context.
SDL_Window *	window	an SDL_Window.

Return Value

(bool) Returns true on success, or false on failure; call SDL_GetError() for more information.

Remarks

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.

Thread Safety

This function should only be called from the thread that created the window.

Version

This function is available since SDL 3.1.3.