Class Fog

Fog Volume Component.

Inheritance

Object

VolumeComponent

Fog

Inherited Members

VolumeComponent.active

VolumeComponent.OnEnable()

VolumeComponent.OnDisable()

VolumeComponent.Override(VolumeComponent, Single)

VolumeComponent.SetAllOverridesTo(Boolean)

VolumeComponent.GetHashCode()

VolumeComponent.OnDestroy()

VolumeComponent.Release()

VolumeComponent.displayName

VolumeComponent.parameters

Namespace: UnityEngine.Rendering.HighDefinition

Syntax

[Serializable]
public class Fog : VolumeComponent

Fields

albedo

Fog albedo.

Declaration

public ColorParameter albedo

Field Value

Type	Description
ColorParameter

anisotropy

Volumetric fog anisotropy.

Declaration

public ClampedFloatParameter anisotropy

Field Value

Type	Description
ClampedFloatParameter

baseHeight

Height fog base height.

Declaration

public FloatParameter baseHeight

Field Value

Type	Description
FloatParameter

color

Fog color.

Declaration

[Tooltip("Specifies the constant color of the fog.")]
public ColorParameter color

Field Value

Type	Description
ColorParameter

colorMode

Fog color mode.

Declaration

public FogColorParameter colorMode

Field Value

Type	Description
FogColorParameter

depthExtent

Sets the distance (in meters) from the Camera's Near Clipping Plane to the back of the Camera's volumetric lighting buffer.

Declaration

[Tooltip("Sets the distance (in meters) from the Camera's Near Clipping Plane to the back of the Camera's volumetric lighting buffer.")]
public MinFloatParameter depthExtent

Field Value

Type	Description
MinFloatParameter

enabled

Enable fog.

Declaration

[Tooltip("Enables the fog.")]
public BoolParameter enabled

Field Value

Type	Description
BoolParameter

enableVolumetricFog

Enable volumetric fog.

Declaration

public BoolParameter enableVolumetricFog

Field Value

Type	Description
BoolParameter

filter

Applies a blur to smoothen the volumetric lighting output.

Declaration

[Tooltip("Applies a blur to smoothen the volumetric lighting output.")]
public BoolParameter filter

Field Value

Type	Description
BoolParameter

globalLightProbeDimmer

Multiplier for ambient probe contribution.

Declaration

public ClampedFloatParameter globalLightProbeDimmer

Field Value

Type	Description
ClampedFloatParameter

maxFogDistance

Maximum fog distance.

Declaration

[Tooltip("Sets the maximum fog distance HDRP uses when it shades the skybox or the Far Clipping Plane of the Camera.")]
public MinFloatParameter maxFogDistance

Field Value

Type	Description
MinFloatParameter

maximumHeight

Height fog maximum height.

Declaration

public FloatParameter maximumHeight

Field Value

Type	Description
FloatParameter

meanFreePath

Fog mean free path.

Declaration

public MinFloatParameter meanFreePath

Field Value

Type	Description
MinFloatParameter

mipFogFar

Sets the distance at which HDRP uses the maximum mip image of the blurred sky texture as the fog color.

Declaration

[Tooltip("Sets the distance at which HDRP uses the maximum mip image of the blurred sky texture as the fog color.")]
public MinFloatParameter mipFogFar

Field Value

Type	Description
MinFloatParameter

mipFogMaxMip

Controls the maximum mip map HDRP uses for mip fog (0 is the lowest mip and 1 is the highest mip).

Declaration

[Tooltip("Controls the maximum mip map HDRP uses for mip fog (0 is the lowest mip and 1 is the highest mip).")]
public ClampedFloatParameter mipFogMaxMip

Field Value

Type	Description
ClampedFloatParameter

mipFogNear

Sets the distance at which HDRP uses the minimum mip image of the blurred sky texture as the fog color.

Declaration

[Tooltip("Sets the distance at which HDRP uses the minimum mip image of the blurred sky texture as the fog color.")]
public MinFloatParameter mipFogNear

Field Value

Type	Description
MinFloatParameter

screenResolutionPercentage

Resolution of the volumetric buffer (3D texture) along the X and Y axes relative to the resolution of the frame buffer.

Declaration

[Tooltip("Resolution of the volumetric buffer, along the x-axis and y-axis, relative to the resolution of the frame buffer.")]
public ClampedFloatParameter screenResolutionPercentage

Field Value

Type	Description
ClampedFloatParameter

sliceDistributionUniformity

Controls the distribution of slices along the Camera's focal axis. 0 is exponential distribution and 1 is linear distribution.

Declaration

[Tooltip("Controls the distribution of slices along the Camera's focal axis. 0 is exponential distribution and 1 is linear distribution.")]
public ClampedFloatParameter sliceDistributionUniformity

Field Value

Type	Description
ClampedFloatParameter

tint

Specifies the tint of the fog when using Sky Color.

Declaration

[Tooltip("Specifies the tint of the fog.")]
public ColorParameter tint

Field Value

Type	Description
ColorParameter

volumeSliceCount

Number of slices of the volumetric buffer (3D texture) along the camera's focal axis.

Declaration

[Tooltip("Number of slices of the volumetric buffer (3D texture) along the camera's focal axis.")]
public ClampedIntParameter volumeSliceCount

Field Value

Type	Description
ClampedIntParameter