SDL_CancelGPUCommandBuffer - Man Page

Cancels a command buffer.

Header File

Defined in SDL3/SDL_gpu.h

Synopsis

#include "SDL3/SDL.h"

bool SDL_CancelGPUCommandBuffer(
    SDL_GPUCommandBuffer *command_buffer);

Description

None of the enqueued commands are executed.

It is an error to call this function after a swapchain texture has been acquired.

This must be called from the thread the command buffer was acquired on.

You must not reference the command buffer after calling this function.

Function Parameters

command_buffer

a command buffer.

Return Value

Returns true on success, false on error; call

SDL_GetError () for more information.

Availability

This function is available since SDL 3.2.0.

See Also

·(3), SDL_WaitAndAcquireGPUSwapchainTexture(3), ·(3), SDL_AcquireGPUCommandBuffer(3), ·(3), SDL_AcquireGPUSwapchainTexture(3)

Referenced By

SDL_AcquireGPUSwapchainTexture(3).

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS