gpu-curtains
    Preparing search index...

    Interface GPUCameraRendererOptions

    Options used to create a GPUCameraRenderer.

    interface GPUCameraRendererOptions {
        camera?: PerspectiveCameraBaseOptions;
        lights?: false | GPUCameraRendererLightParams;
        exposure?: number;
        toneMapping?: ToneMappings;
        colorSpace?: ColorSpace;
        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
    camera? lights? exposure? toneMapping? colorSpace? deviceManager label? container pixelRatio? autoResize? hdrRendering? renderPass? context
    camera?: PerspectiveCameraBaseOptions

    An object defining camera perspective parameters

    lights?: false | GPUCameraRendererLightParams

    An object defining the maximum number of light to use when creating the GPUCameraRenderer. Can be set to false to avoid creating lights and shadows buffers.

    exposure?: number

    Exposure to use. Default to 1.

    toneMapping?: ToneMappings

    Tone mapping to use if any. Default to Khronos.

    colorSpace?: ColorSpace

    Output color space to use. Default to srgb.

    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