Documentation - v20.0.0-dev
    Preparing search index...

    The settings of the ambient occlusion of the frame (PostProcessingSettings.ambientOcclusion): the engine's own, N8AO's algorithm ported, the same in WebGL and WebGPU, applied live.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    denoiseRadius: NumberController = ...

    Radius of the denoise, in pixels of the frame.

    enabled: BooleanController = ...

    Whether the frame is darkened by its ambient occlusion, from the depth of what it shows.

    falloff: NumberController = ...

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

    icon: "ambientOcclusion" = 'ambientOcclusion'

    Drawn by an interface before its title.

    intensity: NumberController = ...

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

    isCategory: true

    A category of the group holding it: drawn by an interface inside that group (e.g. the post-processing's antialiasing and ambient occlusion), which stays a group of its own even without settings of its own (a group of groups only is drawn in place, e.g. the engine's).

    isSettings: true

    Tells a group of settings from a setting, without instanceof.

    only: BooleanController = ...

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

    radius: NumberController = ...

    Distance the ambient occlusion reaches, in world units.

    resolution: NumberController = ...

    Resolution of the 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.

    samples: NumberController = ...

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

    title: "Ambient occlusion" = 'Ambient occlusion'

    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

    • The values changed from their default, group by group, but those never saved (ValueControllerOptions.skipSave): a config for applyConfig, what is saved.

      Returns SettingsConfig<this>

    • 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