SDL_ClaimWindowForGPUDevice(3)

SDL_ClaimWindowForGPUDevice3

Claims a window, creating a swapchain structure for it.

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_gpu.h

Overview

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.

Thread safety

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

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.