SDL_CancelGPUCommandBuffer(3)

SDL_CancelGPUCommandBuffer3

Cancels a command buffer.

Usage

#include "SDL3/SDL.h"

bool SDL_CancelGPUCommandBuffer( SDL_GPUCommandBuffer *command_buffer);

Header file

Defined in SDL3/SDL_gpu.h

Overview

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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.