sdlAcquireGpuSwapchainTexture function

bool sdlAcquireGpuSwapchainTexture(Pointer<SdlGpuCommandBuffer> commandBuffer, Pointer<SdlWindow> window, Pointer<Pointer<SdlGpuTexture>> swapchainTexture, Pointer<Uint32> swapchainTextureWidth, Pointer<Uint32> swapchainTextureHeight,)

Acquire a texture to use in presentation.

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.

This function will fill the swapchain texture handle with NULL if too many frames are in flight. This is not an error.

If you use this function, it is possible to create a situation where many command buffers are allocated while the rendering context waits for the GPU to catch up, which will cause memory usage to grow. You should use SDL_WaitAndAcquireGPUSwapchainTexture() unless you know what you are doing with timing.

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.

\param command_buffer a command buffer. \param window a window that has been claimed. \param swapchain_texture a pointer filled in with a swapchain texture handle. \param swapchain_texture_width a pointer filled in with the swapchain texture width, may be NULL. \param swapchain_texture_height a pointer filled in with the swapchain texture height, may be NULL. \returns true on success, false on error; call SDL_GetError() for more information.

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

\since This function is available since SDL 3.1.3.

\sa SDL_ClaimWindowForGPUDevice \sa SDL_SubmitGPUCommandBuffer \sa SDL_SubmitGPUCommandBufferAndAcquireFence \sa SDL_CancelGPUCommandBuffer \sa SDL_GetWindowSizeInPixels \sa SDL_WaitForGPUSwapchain \sa SDL_WaitAndAcquireGPUSwapchainTexture \sa SDL_SetGPUAllowedFramesInFlight

extern SDL_DECLSPEC bool SDLCALL SDL_AcquireGPUSwapchainTexture( SDL_GPUCommandBuffer *command_buffer, SDL_Window *window, SDL_GPUTexture **swapchain_texture, Uint32 *swapchain_texture_width, Uint32 *swapchain_texture_height)

Implementation

bool sdlAcquireGpuSwapchainTexture(
    Pointer<SdlGpuCommandBuffer> commandBuffer,
    Pointer<SdlWindow> window,
    Pointer<Pointer<SdlGpuTexture>> swapchainTexture,
    Pointer<Uint32> swapchainTextureWidth,
    Pointer<Uint32> swapchainTextureHeight) {
  final sdlAcquireGpuSwapchainTextureLookupFunction = libSdl3.lookupFunction<
          Uint8 Function(
              Pointer<SdlGpuCommandBuffer> commandBuffer,
              Pointer<SdlWindow> window,
              Pointer<Pointer<SdlGpuTexture>> swapchainTexture,
              Pointer<Uint32> swapchainTextureWidth,
              Pointer<Uint32> swapchainTextureHeight),
          int Function(
              Pointer<SdlGpuCommandBuffer> commandBuffer,
              Pointer<SdlWindow> window,
              Pointer<Pointer<SdlGpuTexture>> swapchainTexture,
              Pointer<Uint32> swapchainTextureWidth,
              Pointer<Uint32> swapchainTextureHeight)>(
      'SDL_AcquireGPUSwapchainTexture');
  return sdlAcquireGpuSwapchainTextureLookupFunction(commandBuffer, window,
          swapchainTexture, swapchainTextureWidth, swapchainTextureHeight) ==
      1;
}