GPURenderPipeline: 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
GPURenderPipeline
interface returns the pipeline's GPUBindGroupLayout
object with the given index (i.e. included in the originating GPUDevice.createRenderPipeline()
or GPUDevice.createRenderPipelineAsync()
call's pipeline layout).
If the GPURenderPipeline
was created with layout: "auto"
, this method is the only way to retrieve the GPUBindGroupLayout
s generated by the pipeline.
Syntax
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 ofGPUBindGroupLayout
objects used in the pipeline layout.
Examples
Note:
You can see complete working examples with getBindGroupLayout()
in action in the WebGPU samples.
// ...
// Create a render pipeline using layout: "auto" to automatically generate
// appropriate bind group layouts
const fullscreenQuadPipeline = device.createRenderPipeline({
layout: "auto",
vertex: {
module: device.createShaderModule({
code: fullscreenTexturedQuadWGSL,
}),
entryPoint: "vert_main",
},
fragment: {
module: device.createShaderModule({
code: fullscreenTexturedQuadWGSL,
}),
entryPoint: "frag_main",
targets: [
{
format: presentationFormat,
},
],
},
primitive: {
topology: "triangle-list",
},
});
// ...
// Create a bind group with the auto-generated layout from the render pipeline
const showResultBindGroup = device.createBindGroup({
layout: fullscreenQuadPipeline.getBindGroupLayout(0),
entries: [
{
binding: 0,
resource: sampler,
},
{
binding: 1,
resource: textures[1].createView(),
},
],
});
// ...
Specifications
Specification |
---|
WebGPU # dom-gpupipelinebase-getbindgrouplayout |
Browser compatibility
BCD tables only load in the browser
See also
- The WebGPU API