GPUTexture: sampleCount 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 sampleCount read-only property of the GPUTexture interface represents the sample count of the GPUTexture.

This is set via the sampleCount property in the descriptor object passed into the originating GPUDevice.createTexture() call. If omitted, this defaults to 1.

Value

A number. Possible values are:

1
4, which indicates a multi-sampled texture.

Examples

// …

const depthTexture = device.createTexture({
  size: [canvas.width, canvas.height],
  format: "depth24plus",
  usage: GPUTextureUsage.RENDER_ATTACHMENT,
});

console.log(depthTexture.sampleCount); // 1