NAME¶

SDL_ClaimWindowForGPUDevice - Claims a window, creating a swapchain structure for it.

HEADER FILE¶

Defined in SDL3/SDL_gpu.h

SYNOPSIS¶

#include "SDL3/SDL.h"

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

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 .

RETURN VALUE¶

Returns true on success, or false on failure; call

SDL_GetError () for more information.

AVAILABILITY¶

This function is available since SDL 3.1.3.

SEE ALSO¶

•(3), SDL_AcquireGPUSwapchainTexture(3), •(3), SDL_ReleaseWindowFromGPUDevice(3), •(3), SDL_WindowSupportsGPUPresentMode(3), •(3), SDL_WindowSupportsGPUSwapchainComposition(3)