GPUCommandEncoder: popDebugGroup() method

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Note: This feature is available in Web Workers.

The popDebugGroup() method of the GPUCommandEncoder interface ends a debug group, which is begun with a pushDebugGroup() call.

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

popDebugGroup()

Parameters

None.

Return value

None (undefined).

Validation

The following criteria must be met when calling popDebugGroup(), otherwise a GPUValidationError is generated and the GPUCommandEncoder becomes invalid:

The command encoder's debug stack is not empty (i.e., at least one debug group was previously started with pushDebugGroup()).

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

WebGPU