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

    The settings of the culling of the parts drawn (Culler in WebGL2, compute passes in WebGPU): what it drops, applied live; its tunings, hidden: its workers and depth blocks read when a backend is made, its settling at each frame.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    depthBlock: NumberController = ...

    Occlusion in WebGL2: the depth is read back reduced to the farthest of each block of this many pixels per side (8: 450 x 238 for a 3,600 x 1,898 canvas, 1.7 MB per read).

    enabled: BooleanController = ...

    Whether the parts are culled; off: every part is drawn.

    icon: "culling" = 'culling'

    Drawn by an interface before its title.

    isCategory: boolean = false

    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.

    maxWorkers: NumberController = ...

    Culling workers of WebGL2 at most, the cores of the machine by default and at most; two cores are left to the page.

    minEdgePixels: NumberController = ...

    Parts drawn with their edges: their box covers at least this many pixels on screen, width or height, as minPixels for the faces (0: every part). Far away, edges are sub-pixel noise and cost a draw each.

    minPixels: NumberController = ...

    Parts whose box covers fewer pixels on screen (width and height) are not drawn.

    occlusion: BooleanController = ...

    Whether the culling tests occlusion against the depth of earlier frames.

    settleCulls: NumberController = ...

    Culls on fresh depth after the view or the scene last changed, for the occlusion to settle; then nothing runs until the next change.

    title: "Culling" = 'Culling'

    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