Vixen
c7401864
csharp
public record class VolumetricFogAsset

The three compute dispatches that fill a froxel fog volume.

Read the guide page for this →

Remarks

Paired with FogAsset exactly as GlobalDistanceField is paired with DistanceFieldAoAsset: this fills a volume and names it, and the fog node reads the name. A document with one and not the other is not broken — the composite falls back to the analytic falloff, and the dispatches nothing reads are culled by the graph.

Fields and properties (23)

  • public string Name

    The node's name, for debug groups and for a human reading the file.

  • public bool Enabled

    Whether the node runs.

  • public string View

    The view whose camera the froxels are laid out in front of.

  • public string Media

    The names the three volumes are published under.

  • public string Scattered
  • public string Output
  • public string ShadowAtlas

    The cascade atlas the froxels are shadowed against.

  • public bool Shadows

    Whether the froxels are shadowed against those cascades at all.

  • public string ScenePass

    Whose published cascades and biases the shadow taps use.

  • public int Width

    How many froxels across, down and deep.

  • public int Height
  • public int Slices
  • public float Near

    Where the grid begins and ends, in metres of view depth.

  • public float Far
  • public float Density

    How much light a metre of the medium takes out of a ray.

  • public Vector3 ScatteringAlbedo

    What fraction of that is scattered rather than absorbed, per channel.

  • public bool HeightFalloff

    Whether density thins with altitude.

  • public float FogHeight

    The altitude the authored density holds at, and how fast it thins above.

  • public float HeightFalloffRate
  • public Vector3 SunDirection

    Which way the light travels, and what it carries.

  • public Vector3 SunColour
  • public float PhaseG

    Henyey–Greenstein anisotropy.

  • public Vector3 AmbientColour

    What arrives from the whole sky. ⚠ Without it a back-lit valley is black.

Used by (5)

  • PostEffectFactoryVixen.Rendering.PostFx
  • StandardFrameVixen.Rendering.PostFx
  • StandardFrameTestsVixen.Rendering.PostFx.Tests
  • TypeRegistrationVixen.Rendering.PostFx
  • Vixen_Rendering_PostFx_VolumetricFogAssetSerializerVixen.Rendering.PostFx