GPUComputePassEncoder: popDebugGroup() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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

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 GPUComputePassEncoder interface ends a compute pass 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

js
popDebugGroup()

Parameters

None.

Return value

None (Undefined).

Validation

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

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

Examples

js
// ...

const passEncoder = commandEncoder.beginComputePass();

passEncoder.pushDebugGroup("my_group_marker"); // 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-popdebuggroup

Browser compatibility

BCD tables only load in the browser

See also