GPUComputePassEncoder: pushDebugGroup() method

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The pushDebugGroup() method of the GPUComputePassEncoder interface begins a compute pass 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

js

pushDebugGroup(groupLabel)

Parameters

groupLabel

A string representing the label for the debug group.

Return value

None (Undefined).

Examples

js

// ...

const passEncoder = commandEncoder.beginComputePass();

passEncoder.pushDebugGroup("mygroupmarker"); // Start labeled debug group

passEncoder.setPipeline(computePipeline);
passEncoder.setBindGroup(0, bindGroup);
passEncoder.dispatchWorkgroups(Math.ceil(BUFFER_SIZE / 64));

passEncoder.popDebugGroup();

// ...

Specifications

Specification
WebGPU
# dom-gpudebugcommandsmixin-pushdebuggroup

Browser compatibility

BCD tables only load in the browser

See also