GPUBuffer: label property
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 label property of the
GPUBuffer 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.createBuffer() call, or you can get and set it directly on the GPUBuffer 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 GPUBuffer.label:
const output = device.createBuffer({
size: BUFFER_SIZE,
usage: GPUBufferUsage.STORAGE | GPUBufferUsage.COPY_SRC,
});
output.label = "my_buffer";
console.log(output.label); // "my_buffer"
Setting a label via the originating GPUDevice.createBuffer() call, and then getting it via GPUBuffer.label:
const output = device.createBuffer({
size: BUFFER_SIZE,
usage: GPUBufferUsage.STORAGE | GPUBufferUsage.COPY_SRC,
label: "my_buffer",
});
console.log(output.label); // "my_buffer"
Specifications
| Specification |
|---|
| WebGPU # dom-gpuobjectbase-label |
Browser compatibility
| desktop | mobile | server | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
label
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- Partial support
- Partial support
- No support
- No support
- User must explicitly enable this feature.
- Has more compatibility info.
See also
- The WebGPU API