Interface GPURendererContextOptions

Options used to configure the renderer canvas context. If not specified, format will be set with GPU.getPreferredCanvasFormat() and alphaMode with premultiplied.

interface GPURendererContextOptions {
    format: GPUTextureFormat;
    viewFormats?: Iterable<GPUTextureFormat>;
    colorSpace?: PredefinedColorSpace;
    toneMapping?: GPUCanvasToneMapping;
    alphaMode?: GPUCanvasAlphaMode;
}

Hierarchy

  • Omit<GPUCanvasConfiguration, "device" | "usage">
    • GPURendererContextOptions

Properties

format viewFormats? colorSpace? toneMapping? alphaMode?

Properties

format

format: GPUTextureFormat

The format that textures returned by GPUCanvasContext.getCurrentTexture will have. Must be one of the Supported context formats.

OptionalviewFormats

viewFormats?: Iterable<GPUTextureFormat>

The formats that views created from textures returned by GPUCanvasContext.getCurrentTexture may use.

OptionalcolorSpace

colorSpace?: PredefinedColorSpace

The color space that values written into textures returned by GPUCanvasContext.getCurrentTexture should be displayed with.

OptionaltoneMapping

toneMapping?: GPUCanvasToneMapping

The tone mapping determines how the content of textures returned by GPUCanvasContext.getCurrentTexture are to be displayed. Note: If an implementation doesn't support HDR WebGPU canvases, it should also not expose this member, to allow for feature detection. See GPUCanvasContext.getConfiguration.

OptionalalphaMode

alphaMode?: GPUCanvasAlphaMode

Determines the effect that alpha values will have on the content of textures returned by GPUCanvasContext.getCurrentTexture when read, displayed, or used as an image source.

Settings

Member Visibility

On This Page

Properties