GPUBuffer: label property
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.
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 = "mybuffer";
console.log(output.label); // "mybuffer"
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: "mybuffer",
});
console.log(output.label); // "mybuffer"
Specifications
Specification |
---|
WebGPU # dom-gpuobjectbase-label |
Browser compatibility
BCD tables only load in the browser
See also
- The WebGPU API