Illutions Engine API - v0.26.0
    Preparing search index...

    Interface RenderCfg

    Defines the renderer settings used to control frame timing, resolution, shadows, tone mapping and output color space.

    interface RenderCfg {
        api: Renderer;
        autoResize?: boolean;
        deltaTimesMax: number;
        fpsLimiter: boolean;
        fpsMax: number;
        guiOpened: boolean;
        outputColorSpace: ColorSpace;
        params: { alpha: boolean; antialias: boolean };
        pixelRatio: number;
        shadowMapEnabled: boolean;
        shadowMapType: ShadowMapType;
        toneMapping: ToneMapping;
        toneMappingExposure: number;
        webgl: { params: WebGLRendererParameters };
        webgpu: { params: WebGPURendererParameters };
    }
    Index
    api autoResize? deltaTimesMax fpsLimiter fpsMax guiOpened outputColorSpace params pixelRatio shadowMapEnabled shadowMapType toneMapping toneMappingExposure webgl webgpu
    api: Renderer

    Selects the rendering backend.

    • webgl: use THREE.WebGLRenderer
    • webgpu: use THREE.WebGPURenderer
    • auto: use WebGPU if supported, otherwise fall back to WebGL
    'auto'
    autoResize?: boolean

    Automatically updates the canvas, renderer, post-processing, camera and reflector sizes on window resize.

    true
    deltaTimesMax: number

    Maximum number of delta time history samples.

    10
    fpsLimiter: boolean

    Enables or disables the maximum frames limiter.

    true
    fpsMax: number

    Maximum frames per second.

    30
    guiOpened: boolean

    Whether the GUI render dropdown is open.

    false
    outputColorSpace: ColorSpace

    Output color space.

    THREE.SRGBColorSpace
    params: { alpha: boolean; antialias: boolean }

    Parameters passed to both WebGL and WebGPU renderer constructors.

    Type Declaration

    • alpha: boolean

      Whether the renderer canvas uses an alpha buffer.

      false
    • antialias: boolean

      Whether renderer-level anti-aliasing is enabled.

      false
    pixelRatio: number

    Sets the renderer pixel ratio.

    1
    shadowMapEnabled: boolean

    Enables or disables shadow maps.

    true
    shadowMapType: ShadowMapType

    Type of shadow map.

    THREE.PCFShadowMap
    toneMapping: ToneMapping

    Tone mapping algorithm.

    THREE.ACESFilmicToneMapping
    toneMappingExposure: number

    Tone mapping exposure value.

    1.0
    webgl: { params: WebGLRendererParameters }

    WebGL-specific renderer configuration.

    Type Declaration

    • params: WebGLRendererParameters

      Parameters passed to THREE.WebGLRenderer.

    webgpu: { params: WebGPURendererParameters }

    WebGPU-specific renderer configuration.

    Type Declaration

    • params: WebGPURendererParameters

      Parameters passed to THREE.WebGPURenderer.

    Settings
    Member Visibility

    On This Page
    Properties