Struct LocalVolumetricFogArtistParameters

Artist-friendly Local Volumetric Fog parametrization.

Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
[Serializable]
public struct LocalVolumetricFogArtistParameters

Constructors

LocalVolumetricFogArtistParameters(Color, float, float)

Constructor.

Declaration
public LocalVolumetricFogArtistParameters(Color color, float _meanFreePath, float _anisotropy)
Parameters
Type Name Description
Color color

Single scattering albedo.
float _meanFreePath

Mean free path.
float _anisotropy

Anisotropy.

Fields

albedo

Single scattering albedo: [0, 1]. Alpha is ignored.

Declaration
[ColorUsage(false)]
public Color albedo
Field Value
Type Description
Color

anisotropy

Anisotropy of the phase function: [-1, 1]. Positive values result in forward scattering, and negative values - in backward scattering.

Declaration
[FormerlySerializedAs("asymmetry")]
public float anisotropy
Field Value
Type Description
float

blendingMode

Specifies how the fog in the volume will interact with the fog.

Declaration
public LocalVolumetricFogBlendingMode blendingMode
Field Value
Type Description
LocalVolumetricFogBlendingMode

distanceFadeEnd

Distance at which density fading ends.

Declaration
public float distanceFadeEnd
Field Value
Type Description
float

distanceFadeStart

Distance at which density fading starts.

Declaration
public float distanceFadeStart
Field Value
Type Description
float

falloffMode

When Blend Distance is above 0, controls which kind of falloff is applied to the transition area.

Declaration
public LocalVolumetricFogFalloffMode falloffMode
Field Value
Type Description
LocalVolumetricFogFalloffMode

invertFade

Inverts the fade gradient.

Declaration
public bool invertFade
Field Value
Type Description
bool

maskMode

The mask mode to use when writing this volume in the volumetric fog.

Declaration
public LocalVolumetricFogMaskMode maskMode
Field Value
Type Description
LocalVolumetricFogMaskMode

materialMask

The material used to mask the local volumetric fog when the mask mode is set to Material. The material needs to use the "Fog Volume" material type in Shader Graph.

Declaration
public Material materialMask
Field Value
Type Description
Material

meanFreePath

Mean free path, in meters: [1, inf].

Declaration
public float meanFreePath
Field Value
Type Description
float

negativeFade

Edge fade factor along the negative X, Y and Z axes.

Declaration
[FormerlySerializedAs("m_NegativeFade")]
public Vector3 negativeFade
Field Value
Type Description
Vector3

positiveFade

Edge fade factor along the positive X, Y and Z axes.

Declaration
[FormerlySerializedAs("m_PositiveFade")]
public Vector3 positiveFade
Field Value
Type Description
Vector3

priority

Rendering priority of the volume, higher priority will be rendered first.

Declaration
public int priority
Field Value
Type Description
int

size

Dimensions of the volume.

Declaration
public Vector3 size
Field Value
Type Description
Vector3

textureOffset

Allows translation of the tiling density texture.

Declaration
[SerializeField]
[FormerlySerializedAs("volumeScrollingAmount")]
public Vector3 textureOffset
Field Value
Type Description
Vector3

textureScrollingSpeed

Scrolling speed of the density texture.

Declaration
public Vector3 textureScrollingSpeed
Field Value
Type Description
Vector3

textureTiling

Tiling rate of the density texture.

Declaration
public Vector3 textureTiling
Field Value
Type Description
Vector3

volumeMask

Texture containing density values.

Declaration
public Texture volumeMask
Field Value
Type Description
Texture

Properties

advancedFade

Obsolete, do not use.

Declaration
[Obsolete("Never worked correctly due to having engine working in percent. Will be removed soon.")]
public bool advancedFade { get; }
Property Value
Type Description
bool