gpu-curtains
    Preparing search index...

    Interface GPURendererOptions

    Options used to create this GPURenderer.

    interface GPURendererOptions {
        deviceManager: GPUDeviceManager;
        label?: string;
        container: string | HTMLElement;
        pixelRatio?: number;
        autoResize?: boolean;
        hdrRendering?: boolean;
        renderPass?: {
            useDepth?: boolean;
            sampleCount?: number;
            colorAttachments?: [
                Partial<ColorAttachmentParams>,
                ...ColorAttachmentParams[],
            ];
        };
        context: GPURendererContextOptions;
    }

    Hierarchy (View Summary)

    Index
    deviceManager label? container pixelRatio? autoResize? hdrRendering? renderPass? context
    deviceManager: GPUDeviceManager

    The GPUDeviceManager used to create this GPURenderer.

    label?: string

    Optional label of this GPURenderer.

    container: string | HTMLElement

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

    pixelRatio?: number

    Pixel ratio to use for rendering.

    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 canvas element, and handle resizing by yourself.

    hdrRendering?: boolean

    Whether to render the full pipeline to HDR, i.e. using rgba16float texture format. When set to true, a mandatory ShaderPass will be used to render the last pass to the context current format.

    renderPass?: {
        useDepth?: boolean;
        sampleCount?: number;
        colorAttachments?: [
            Partial<ColorAttachmentParams>,
            ...ColorAttachmentParams[],
        ];
    }

    The renderer RenderPass parameters.

    Type Declaration

    context: GPURendererContextOptions

    Patched context configuration options.

    Settings
    Member Visibility

    On This Page
    Properties