GPUComputePipeline: getBindGroupLayout() 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 getBindGroupLayout() method of the GPUComputePipeline interface returns the pipeline's GPUBindGroupLayout object with the given index (i.e. included in the originating GPUDevice.createComputePipeline() or GPUDevice.createComputePipelineAsync() call's pipeline layout).

If the GPUComputePipeline was created with layout: "auto", this method is the only way to retrieve the GPUBindGroupLayouts generated by the pipeline.

Syntax

js
getBindGroupLayout(index)

Parameters

index

A number representing the index of the GPUBindGroupLayout to return.

Return value

A GPUBindGroupLayout object instance.

Validation

The following criteria must be met when calling getBindGroupLayout(), otherwise a GPUValidationError is generated and an invalid GPUBindGroupLayout object is returned:

  • index is less than the number of GPUBindGroupLayout objects used in the pipeline layout.

Examples

Note: You can see complete working examples with getBindGroupLayout() in action in the WebGPU samples.

js
// ...

// Create a compute pipeline using layout: "auto" to automatically generate
// appropriate bind group layouts
const computePipeline = device.createComputePipeline({
  layout: "auto",
  compute: {
    module: shaderModule,
    entryPoint: "main",
  },
});

// Create a bind group with the auto-generated layout from the compute pipeline
const computeBindGroup = device.createBindGroup({
  layout: computePipeline.getBindGroupLayout(0),
  entries: [
    {
      binding: 0,
      resource: { buffer: storageBuffer },
    },
  ],
});

// ...

Specifications

Specification
WebGPU
# dom-gpupipelinebase-getbindgrouplayout

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobileserver
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Deno
getBindGroupLayout
Experimental

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
Partial support
Partial support
In development. Supported in a pre-release version.
In development. Supported in a pre-release version.
No support
No support
Experimental. Expect behavior to change in the future.
See implementation notes.
User must explicitly enable this feature.
Has more compatibility info.

See also