(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_ClaimWindowForGPUDevice

Claims a window, creating a swapchain structure for it.

Header File

Defined in <SDL3/SDL_gpu.h>

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, otherwise false.

Remarks

This must be called before SDL_AcquireGPUSwapchainTexture is called using 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.

Version

This function is available since SDL 3.0.0.

See Also

• SDL_AcquireGPUSwapchainTexture
• SDL_ReleaseWindowFromGPUDevice
• SDL_WindowSupportsGPUPresentMode
• SDL_WindowSupportsGPUSwapchainComposition

---

CategoryAPI, CategoryAPIFunction, CategoryGPU

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.