GPUPipelineLayout: label property

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 label property of the GPUPipelineLayout interface provides a label that can be used to identify the object, for example in GPUError messages or console warnings.

This can be set by providing a label property in the descriptor object passed into the originating GPUDevice.createPipelineLayout() call, or you can get and set it directly on the GPUPipelineLayout object.

Value

A string. If this has not been previously set as described above, it will be an empty string.

Examples

Setting and getting a label via GPUPipelineLayout.label:

js
// …

const pipelineLayout = device.createPipelineLayout({
  bindGroupLayouts: [bindGroupLayout],
});

pipelineLayout.label = "my_pipeline_layout";

console.log(pipelineLayout.label); // "my_pipeline_layout"

Setting a label via the originating GPUDevice.createPipelineLayout() call, and then getting it via GPUPipelineLayout.label:

js
// …

const pipelineLayout = device.createPipelineLayout({
  bindGroupLayouts: [bindGroupLayout],
  label: "my_pipeline_layout",
});

console.log(pipelineLayout.label); // "my_pipeline_layout"

Specifications

See also