devela::_dep::sdl3::sys::gpu

Function SDL_PushGPUDebugGroup

pub unsafe extern "C" fn SDL_PushGPUDebugGroup(
    command_buffer: *mut SDL_GPUCommandBuffer,
    name: *const i8,
)
Available on crate feature dep_sdl3 only.
Expand description

Begins a debug group with an arbitary 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 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