GPUSampler: label property

Secure contextAvailable in workers

The label property of the GPUSampler 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 createSampler() call, or you can get and set it directly on the GPUSampler 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 GPUSampler.label:

// …

const sampler = device.createSampler({
  compare: "less",
});

sampler.label = "my_sampler";

console.log(sampler.label); // "my_sampler"

Setting a label via the originating createSampler() call, and then getting it via GPUSampler.label:

// …

const sampler = device.createSampler({
  compare: "less",
  label: "my_sampler",
});

console.log(sampler.label); // "my_sampler"

Specifications

Browser compatibility

See also

• The WebGPU API