GPUExternalTexture: label property
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The label
property of the
GPUExternalTexture
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.importExternalTexture()
call, or you can get and set it directly on the GPUExternalTexture
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 GPUExternalTexture.label
:
js
// ...
const externalTexture = device.importExternalTexture({
source: video,
});
externalTexture.label = "myExtTexture";
console.log(externalTexture.label); // "myExtTexture"
Setting a label via the originating GPUDevice.importExternalTexture()
call, and then getting it via GPUExternalTexture.label
:
js
// ...
const externalTexture = device.importExternalTexture({
source: video,
label: "myExtTexture",
});
console.log(externalTexture.label); // "myExtTexture"
Specifications
Specification |
---|
WebGPU # dom-gpuobjectbase-label |
Browser compatibility
BCD tables only load in the browser
See also
- The WebGPU API