GPU: getPreferredCanvasFormat() method
WebGPU API
WebGPU API
The getPreferredCanvasFormat() method of the
GPU interface returns the optimal canvas texture format for displaying 8-bit depth, standard dynamic range content on the current system.
This is commonly used to provide a GPUCanvasContext.configure() call with the optimal format value for the current system. This is recommended — if you don't use the preferred format when configuring the canvas context, you may incur additional overhead, such as additional texture copies, depending on the platform.
Syntax
getPreferredCanvasFormat()
Parameters
None.
Return value
A string indicating a canvas texture format. The value can be rgba8unorm or bgra8unorm.
Exceptions
None.
Examples
const canvas = document.querySelector("#gpuCanvas");
const context = canvas.getContext("webgpu");
context.configure({
device,
format: navigator.gpu.getPreferredCanvasFormat(),
alphaMode: "premultiplied",
});
Specifications
Browser compatibility
See also
- The WebGPU API