Interface GPURendererParams

Parameters used to create a GPURenderer.

interface GPURendererParams {
    deviceManager: GPUDeviceManager;
    label?: string;
    container: string | HTMLElement;
    pixelRatio?: number;
    autoResize?: boolean;
    context?: GPURendererContextParams;
    renderPass?: {
        useDepth: boolean;
        sampleCount: number;
        clearValue: GPUColor;
    };
}

Hierarchy (view full)

Properties

deviceManager label? container pixelRatio? autoResize? context? renderPass?

Properties

deviceManager

deviceManager: GPUDeviceManager

The GPUDeviceManager used to create this GPURenderer

Optional label

label?: string

Optional label of this GPURenderer

container

container: string | HTMLElement

HTMLElement or selector used as a container for our canvas. Could also be directly a HTMLCanvasElement | canvas element.

Optional pixelRatio

pixelRatio?: number

Pixel ratio to use for rendering

Optional autoResize

autoResize?: boolean

Whether to auto resize the renderer each time its GPURenderer#domElement size changes or not. It is advised to set this parameter to false if the provided container is a HTMLCanvasElement | canvas element, and handle resizing by yourself.

Optional context

context?: GPURendererContextParams

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

Optional renderPass

renderPass?: {
    useDepth: boolean;
    sampleCount: number;
    clearValue: GPUColor;
}

The renderer RenderPass parameters

Type declaration

  • useDepth: boolean

    Whether the renderer RenderPass should handle depth. Default to true

  • sampleCount: number

    The renderer RenderPass sample count (i.e. whether it should use multisampled antialiasing). Default to 4

  • clearValue: GPUColor

    The GPUColor | color values to clear to before drawing the renderer RenderPass. Default to [0, 0, 0, 0]

Settings

Member Visibility

Theme

On This Page