GPURenderPassEncoder: pushDebugGroup() method

Secure contextAvailable in workers

The pushDebugGroup() method of the GPURenderPassEncoder interface begins a render 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

pushDebugGroup(groupLabel)

Parameters

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

Return value

None (undefined).

Examples

// …

const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);

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

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

passEncoder.popDebugGroup();

// …

Specifications

Browser compatibility

See also

• The WebGPU API