GPUCanvasContext: getConfiguration() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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.

Note: This feature is available in Web Workers.

The getConfiguration() method of the GPUCanvasContext interface returns the current configuration set for the context.

Syntax

js
getConfiguration()

Parameters

None.

Return value

An object containing the configuration options set on the context (i.e., via the GPUCanvasContext.configure() method), or null if no configuration is set (either no configuration was previously set, or a configuration was set and then GPUCanvasContext.unconfigure() was called on the context).

Examples

js
const canvas = document.querySelector("canvas");
const context = canvas.getContext("webgpu");

if (!navigator.gpu) {
  throw Error("WebGPU not supported.");
}

const adapter = await navigator.gpu.requestAdapter();
if (!adapter) {
  throw Error("Couldn't request WebGPU adapter.");
}

const device = await adapter.requestDevice();

context.configure({
  device: device,
  format: navigator.gpu.getPreferredCanvasFormat(),
  alphaMode: "premultiplied",
});

console.log(context.getConfiguration());
/* Logs something like:

{
  "alphaMode": "premultiplied",
  "colorSpace": "srgb",
  "device": { ... },
  "format": "bgra8unorm",
  "toneMapping": {
      "mode": "standard"
  },
  "usage": 16,
  "viewFormats": []
}
*/

Specifications

Specification
WebGPU
# dom-gpucanvascontext-getconfiguration

Browser compatibility

BCD tables only load in the browser

See also