(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_CancelGPUCommandBuffer

Cancels a command buffer.

Header File

Defined in <SDL3/SDL_gpu.h>

Syntax

bool SDL_CancelGPUCommandBuffer(
    SDL_GPUCommandBuffer *command_buffer);

Function Parameters

SDL_GPUCommandBuffer *

command_buffer

a command buffer.

Return Value

(bool) Returns true on success, false on error; call SDL_GetError() for more information.

Remarks

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.

Version

This function is available since SDL 3.1.6.

See Also

• SDL_WaitAndAcquireGPUSwapchainTexture
• SDL_AcquireGPUCommandBuffer
• SDL_AcquireGPUSwapchainTexture

---

CategoryAPI, CategoryAPIFunction, CategoryGPU

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.