GPUCommandEncoder: pushDebugGroup() method

Secure contextAvailable in workers

The pushDebugGroup() method of the GPUCommandEncoder interface begins a debug group, which is marked with a specified label, and will contain all subsequent encoded commands up until a popDebugGroup() method is invoked.

This could be used for telemetry, or may be utilized in GPUError messages, browser dev tools, or other services in the future to help with debugging.

Syntax

pushDebugGroup(groupLabel)

Parameters

• groupLabel
  • : A string representing the label for the debug group.

Return value

None (undefined).

Examples

// …

commandEncoder.pushDebugGroup("my_group_marker"); // Start labeled debug group

const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);

passEncoder.setPipeline(renderPipeline);
passEncoder.setVertexBuffer(0, vertexBuffer);
passEncoder.draw(3);

passEncoder.end();

commandEncoder.popDebugGroup(); // End labeled debug group

// …

Specifications

Browser compatibility

See also

• The WebGPU API