Man page - sdl_cancelgpucommandbuffer(3)

Packages contains this manual

Manual

SDL_CancelGPUCommandBuffer

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
RETURN VALUE
AVAILABILITY
SEE ALSO

NAME

SDL_CancelGPUCommandBuffer - 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)