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

SDL_AcquireGPUSwapchainTexture

Acquire a texture to use in presentation.

Header File

Syntax

bool SDL_AcquireGPUSwapchainTexture(
    SDL_GPUCommandBuffer *command_buffer,
    SDL_Window *window,
    SDL_GPUTexture **swapchain_texture,
    Uint32 *swapchain_texture_width,
    Uint32 *swapchain_texture_height);

Function Parameters

SDL_GPUCommandBuffer *	command_buffer	a command buffer.
SDL_Window *	window	a window that has been claimed.
SDL_GPUTexture **	swapchain_texture	a pointer filled in with a swapchain texture handle.
Uint32 *	swapchain_texture_width	a pointer filled in with the swapchain texture width, may be NULL.
Uint32 *	swapchain_texture_height	a pointer filled in with the swapchain texture height, may be NULL.

Return Value

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

Remarks

When a swapchain texture is acquired on a command buffer, it will automatically be submitted for presentation when the command buffer is submitted. The swapchain texture should only be referenced by the command buffer used to acquire it. The swapchain texture handle can be filled in with NULL under certain conditions. This is not necessarily an error. If this function returns false then there is an error.

The swapchain texture is managed by the implementation and must not be freed by the user. You MUST NOT call this function from any thread other than the one that created the window.

When using SDL_GPU_PRESENTMODE_VSYNC, this function will block if too many frames are in flight. Otherwise, this function will fill the swapchain texture handle with NULL if too many frames are in flight. The best practice is to call SDL_CancelGPUCommandBuffer if the swapchain texture handle is NULL to avoid enqueuing needless work on the GPU.

Version

This function is available since SDL 3.1.3.