Interface SkyAtmosphereRendererConfig

interface SkyAtmosphereRendererConfig {
    atmosphere?: Atmosphere;
    customUniformsSource?: CustomUniformsSourceConfig;
    fromKilometersScale?: number;
    initializeConstantLuts?: boolean;
    label?: string;
    lights?: AtmosphereLightsConfig;
    lookUpTables?: SkyAtmosphereLutConfig;
    mieHgDrainePhase?: MieHgDPhaseConfig;
    shadow?: ShadowConfig;
    skyRenderer?: SkyRendererConfigBase;
}

Hierarchy (view full)

Properties

atmosphere? customUniformsSource? fromKilometersScale? initializeConstantLuts? label? lights? lookUpTables? mieHgDrainePhase? shadow? skyRenderer?

Properties

Optional atmosphere

atmosphere?: Atmosphere

The atmosphere parameters for this SkyAtmosphereLutRenderer. Defaults to: makeEarthAtmosphere with the scale parameter set to SkyAtmosphereRendererConfig.fromKilometersScale.

See

makeEarthAtmosphere

Optional customUniformsSource

customUniformsSource?: CustomUniformsSourceConfig

Config for externally controlled buffers containing the parameters otherwise controlled by an internal buffer storing Uniforms.

If this is set, no internal buffer for storing Uniforms will be created or updated.

Optional fromKilometersScale

fromKilometersScale?: number

The scale factor to scale points in the scale 1 = 1km to a different scale, e.g., for 1 = 1m set this to 1000.

The distance scale used by SkyAtmosphereLutRenderers is 1 = 1km. This is used to correctly render the sky / atmosphere in scenes with a different scale.

Defaults to 1.0.

Optional initializeConstantLuts

initializeConstantLuts?: boolean

If true, all lookup tables that only depend on constant atmosphere parameters are rendered at creation time.

Defaults to true.

Optional label

label?: string

A name used to lable internal resources and pipelines.

Defaults to "atmosphere"

Optional lights

lights?: AtmosphereLightsConfig

Config for atmosphere lights (sun, moon, sun disk).

Optional lookUpTables

lookUpTables?: SkyAtmosphereLutConfig

Config for internally used lookup tables.

Optional mieHgDrainePhase

mieHgDrainePhase?: MieHgDPhaseConfig

Config for the Henyey-Greenstein + Draine (https://research.nvidia.com/labs/rtr/approximate-mie/) approximation of the Mie phase function.

If this is set, the renderer uses the Henyey-Greenstein + Draine approximation instead of the Cornette-Shanks approximation.

Defaults to undefined.

Optional shadow

shadow?: ShadowConfig

Config for external resources required by a SkyAtmosphereLutRenderer to integrate user-controlled shadow maps.

Optional skyRenderer

skyRenderer?: SkyRendererConfigBase

Config for the sky rendering post process.

Settings

Member Visibility

Theme

On This Page

atmospherecustomUniformsSourcefromKilometersScaleinitializeConstantLutslabellightslookUpTablesmieHgDrainePhaseshadowskyRenderer