W3cubDocs

/Web APIs

GPURenderPassEncoder: pushDebugGroup() method

Limited availability

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

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 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

Specification
WebGPU> # dom-gpudebugcommandsmixin-pushdebuggroup>

Browser compatibility

	Desktop					Mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on IOS	Samsung Internet	WebView Android	WebView on iOS
`pushDebugGroup`	113 Currently supported on ChromeOS, macOS, and Windows only.	113 Currently supported on ChromeOS, macOS, and Windows only.	141 Currently supported on Windows only, in all contexts except for service workers.	99 Currently supported on ChromeOS, macOS, and Windows only.	26	121	No	81	26	25.0	121	26