Density Settings

Controls how density-based culling is applied to instances.

This volume component controls how Flora reduces instance density for performance or style.

What This Affects

• Total visible instance counts

• Distant/small-on-screen instance reduction

• Per-layer and per-size density targeting

Attach this component to a Volume to enable density culling effects within specific regions.

---

Properties

GlobalDensityMode

• Controls how global density applies:

  • Disabled

  • RenderersOnly

  • RenderersAndLODGroups

Migration note: GlobalDensityEnabled is obsolete and maps to this mode.

---

GlobalDensityMask

• Selects which instance layers are affected by global density.

---

GlobalDensity

• Fraction of instances to keep.

  • 1.0 = keep all

  • 0.5 = keep half

  • 0.0 = keep none of matching instances

---

GlobalDensitySizeThreshold

• Objects larger than this diagonal size are exempt from global density culling.

---

RangeDensityMode

• Controls how range density applies:

  • Disabled

  • RenderersOnly

  • RenderersAndLODGroups

Migration note: RangeDensityEnabled and RangeDensityAffectsLODGroups are obsolete and map to this mode.

---

RangeDensityMask

• Selects which layers are affected by range-based density.

---

RangeDensity

• Minimum density for small-on-screen instances.

---

RangeDensityFalloff

• Controls how quickly density falls from full to RangeDensity.

Migration note: RangeDensityFalloffPower is obsolete and maps to this field.

---

RangeDensityScreenPercentage

• Screen-size thresholds used for range-based density.

• Lower bound is constrained by MinScreenSize.

Runtime Override Note

Set both mode and value with Override(...) when applying user settings at runtime:

var sceneSettings = FloraSceneSettings.GetOrCreate();
var density = sceneSettings.GetGlobalDensitySettings();

density.GlobalDensityMode.Override(FloraDensityMode.RenderersOnly);
density.GlobalDensity.Override(0.75f);

density.RangeDensityMode.Override(FloraDensityMode.RenderersOnly);
density.RangeDensity.Override(0.6f);

How To Verify

• Lower GlobalDensity and confirm broad thinning.

• Enable range density and confirm stronger thinning for distant/small-on-screen instances.