Documentation - v19.16.0-dev
    Preparing search index...

    The settings of the post-processing of the frame: its antialiasing and its ambient occlusion, applied live.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    accumulatedFrames: NumberController = ...

    Frames drawn by the renderer once nothing changes (no frame asked for since), each with its camera moved by a fraction of a pixel (but the first, the frame of the change again), shown averaged with the previous ones: the image refines smoothly, close to supersampling (edges, highlights, thin lines), for that many more frames after each change; 0: none. Not while the animation loop runs (Renderer.start): the renderer could not tell the changes.

    ambientOcclusion: BooleanController = ...

    Whether the frame is darkened by its ambient occlusion, from the depth of what it shows: the engine's own, N8AO's algorithm ported, the same in WebGL and WebGPU.

    ambientOcclusionDenoiseRadius: NumberController = ...

    Radius of the ambient occlusion's denoise, in pixels of the frame.

    ambientOcclusionFalloff: NumberController = ...

    How far depth differences still count, a fraction of the radius (N8AO's distanceFalloff).

    ambientOcclusionIntensity: NumberController = ...

    Strength of the ambient occlusion (1 open, 0 closed), raised to 5 times this power.

    ambientOcclusionOnly: BooleanController = ...

    Whether the ambient occlusion is shown alone, grey, in place of the frame: to tune it.

    ambientOcclusionRadius: NumberController = ...

    Distance the ambient occlusion reaches, in world units.

    ambientOcclusionResolution: NumberController = ...

    Resolution of the ambient occlusion's occlusion and denoise passes, a fraction of the frame's per side: they cost per pixel, whatever their samples; below 1, upsampled to the frame by depth. Full by default: half shows too many artifacts.

    ambientOcclusionSamples: NumberController = ...

    Depth samples per pixel of the ambient occlusion: its quality and cost.

    antialias: SelectController<Antialias> = ...

    Antialiasing of the final image, the layers composed, in post-processing only: no MSAA (an MSAA target costs about 2 ms a frame at 2560 x 1600 in WebGL, 1.6 ms at 3040 x 1720 in WebGPU).

    icon: "postProcessing" = 'postProcessing'

    Drawn by an interface before its title.

    title: "Post-processing" = 'Post-processing'

    Shown by an interface above its settings.

    Methods

    • Sets the settings config gives, each validated (see ValueController.validate): a value refused is skipped with a warning, the others set. The keys that are not settings are ignored (e.g. of a config saved by another version).

      Parameters

      Returns void

    • Disconnects every listener of the settings: they are not used after.

      Returns void

    • Sets the settings saved under key in the local storage (saveToLocalStorage); none saved: unchanged. A value refused (e.g. by a later version) is skipped with a warning, the others set (see applyConfig); saved settings that cannot be read are ignored with a warning.

      Parameters

      • key: string

      Returns void

    • Sets every setting back to its default.

      Returns void

    • Saves the values changed from their default under key in the local storage, the key removed when none is: the others follow the defaults of the next versions.

      Parameters

      • key: string

      Returns void