Ara
Download

Search or run a command

Jump to a section or open an Ara link.

Struct · Ara

HeightFog

Exponential height fog lit by the sun, the sky and local lights (volumetric shafts where shadows cut the beams). Density halves every falloff × ln 2 metres above baseHeight. The first entity in ID order wins.

public struct HeightFog : IComponent<HeightFog>

Properties

TypeIndex

public static uint TypeIndex { get; }

Stable engine component index.

Fields

Density

public float Density;

Extinction at baseHeight, per metre. 0.002 is a light haze (visibility ≈ 1.5 km), 0.02 a thick fog (≈ 150 m).

Range: [0, 0.1]. Default: 0.002.

BaseHeight

public float BaseHeight;

World altitude where the fog has its full density.

Unit: m. Default: 0.

Falloff

public float Falloff;

Scale height: density falls by a factor of e over this many metres of altitude.

Unit: m. Range: [1, 10000]. Default: 60.

Albedo

public Color Albedo;

Scattering colour (single-scattering albedo, linear). Grey-white for water fog, warm for dust.

Default: [0.9,0.9,0.9,1].

Anisotropy

public float Anisotropy;

Forward-scattering bias: 0 is uniform, toward 1 the fog glows around the sun and lamps.

Range: [0, 0.9]. Default: 0.3.

Methods

Access

public static ref HeightFog Access(Entity entity, bool write);

No description yet.

Insert

public static void Insert(in Commands commands, Entity entity, in HeightFog value);

No description yet.

Contains

public static bool Contains(Entity entity);

No description yet.