SDL_WaitAndAcquireGPUSwapchainTexture - Blocks the thread until a swapchain texture is available to be
Contents
Availability
This function is available since SDL 3.2.0.
Description
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. It is an error to call
SDL_CancelGPUCommandBuffer () after a swapchain texture is acquired.
This function can fill the swapchain texture handle with NULL in certain cases, for example if the window
is minimized. This is not an error. You should always make sure to check whether the pointer is NULL
before actually using it.
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.
The swapchain texture is write-only and cannot be used as a sampler or for another reading operation.
Function Parameters
command_buffer
a command buffer.
window a window that has been claimed.
swapchain_texture
a pointer filled in with a swapchain texture handle.
swapchain_texture_width
a pointer filled in with the swapchain texture width, may be NULL.
swapchain_texture_height
a pointer filled in with the swapchain texture height, may be NULL.
Header File
Defined in SDL3/SDL_gpu.h
Name
SDL_WaitAndAcquireGPUSwapchainTexture - Blocks the thread until a swapchain texture is available to be
acquired, and then acquires it.
Return Value
Returns true on success, false on error; call
SDL_GetError () for more information.
See Also
•(3), SDL_SubmitGPUCommandBuffer(3), •(3), SDL_SubmitGPUCommandBufferAndAcquireFence(3), •(3), SDL_AcquireGPUSwapchainTexture(3) Simple Directmedia Layer SDL 3.2.10 SDL_WaitAndAcquireGPUSwapchainTexture(3)
Synopsis
#include"SDL3/SDL.h"boolSDL_WaitAndAcquireGPUSwapchainTexture(SDL_GPUCommandBuffer*command_buffer,SDL_Window*window,SDL_GPUTexture**swapchain_texture,Uint32*swapchain_texture_width,Uint32*swapchain_texture_height);
Thread Safety
This function should only be called from the thread that created the window.
