SDL_InsertGPUDebugLabel

Inserts an arbitrary string label into the command buffer callstream.

Header File

Defined in <SDL3/SDL_gpu.h>

Syntax

void SDL_InsertGPUDebugLabel(
    SDL_GPUCommandBuffer *command_buffer,
    const char *text);

Function Parameters

SDL_GPUCommandBuffer *	command_buffer	a command buffer.
const char *	text	a UTF-8 string constant to insert as the label.

Remarks

Useful for debugging.

On Direct3D 12, using SDL_InsertGPUDebugLabel requires WinPixEventRuntime.dll to be in your PATH or in the same directory as your executable. See here for instructions on how to obtain it.

Version

This function is available since SDL 3.2.0.

---

CategoryAPI, CategoryAPIFunction, CategoryGPU

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