SDL_PushGPUDebugGroup

Function SDL_PushGPUDebugGroup 

Source
pub unsafe extern "C" fn SDL_PushGPUDebugGroup(
    command_buffer: *mut SDL_GPUCommandBuffer,
    name: *const c_char,
)
Expand description

Begins a debug group with an arbitrary name.

Used for denoting groups of calls when viewing the command buffer callstream in a graphics debugging tool.

Each call to SDL_PushGPUDebugGroup must have a corresponding call to SDL_PopGPUDebugGroup.

On Direct3D 12, using SDL_PushGPUDebugGroup 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.

On some backends (e.g. Metal), pushing a debug group during a render/blit/compute pass will create a group that is scoped to the native pass rather than the command buffer. For best results, if you push a debug group during a pass, always pop it in the same pass.

§Parameters

  • command_buffer: a command buffer.
  • name: a UTF-8 string constant that names the group.

§Availability

This function is available since SDL 3.2.0.

§See also