Class Fog

Fog Volume Component.

Inheritance

object

Object

ScriptableObject

VolumeComponent

VolumeComponentWithQuality

Fog

Implements

IApplyRevertPropertyContextMenuItemProvider

Inherited Members

VolumeComponentWithQuality.quality

VolumeComponentWithQuality.UsesQualitySettings()

VolumeComponent.active

VolumeComponent.displayName

VolumeComponent.parameters

VolumeComponent.OnEnable()

VolumeComponent.OnDisable()

VolumeComponent.Override(VolumeComponent, float)

VolumeComponent.SetAllOverridesTo(bool)

VolumeComponent.GetHashCode()

VolumeComponent.AnyPropertiesIsOverridden()

VolumeComponent.OnDestroy()

VolumeComponent.Release()

VolumeComponent.TryGetRevertMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)

VolumeComponent.GetSourceTerm()

VolumeComponent.TryGetApplyMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)

VolumeComponent.GetSourceName(Component)

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.Rendering.HighDefinition

Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll

Syntax

[Serializable]
[VolumeComponentMenu("Fog")]
[SupportedOnRenderPipeline(typeof(HDRenderPipelineAsset))]
public class Fog : VolumeComponentWithQuality, IApplyRevertPropertyContextMenuItemProvider

Fields

Name	Description
albedo	Stores the fog albedo. This defines the color of the fog.
anisotropy	Controls the angular distribution of scattered light. 0 is isotropic, 1 is forward scattering, and -1 is backward scattering.
baseHeight	Height fog base height.
color	Fog color.
colorMode	Fog color mode.
denoisingMode	Controls which denoising technique to use for the volumetric effect.
depthExtent	Sets the distance (in meters) from the Camera's Near Clipping Plane to the back of the Camera's volumetric lighting buffer. The lower the distance is, the higher the fog quality is.
directionalLightsOnly	Indicates whether Unity includes or excludes non-directional light types when it evaluates the volumetric fog. Including non-directional lights increases the resource intensity of the effect.
enableVolumetricFog	Enable volumetric fog.
enabled	Enable fog.
globalLightProbeDimmer	Multiplier for global illumination (APV or ambient probe).
m_ResolutionDepthRatio	Controls how Unity shares resources between Screen (XY) and Depth (Z) resolutions.
maxFogDistance	Maximum fog distance.
maximumHeight	Height fog maximum height.
meanFreePath	Fog mean free path.
mipFogFar	Sets the distance at which HDRP uses the maximum mip image of the blurred sky texture as the fog color.
mipFogMaxMip	Controls the maximum mip map HDRP uses for mip fog (0 is the lowest mip and 1 is the highest mip).
mipFogNear	Sets the distance at which HDRP uses the minimum mip image of the blurred sky texture as the fog color.
screenResolutionPercentage	Stores the resolution of the volumetric buffer (3D texture) along the x-axis and y-axis relative to the resolution of the screen.
sliceDistributionUniformity	Controls the distribution of slices along the Camera's focal axis. 0 is exponential distribution and 1 is linear distribution.
tint	Specifies the tint of the fog when using Sky Color.
volumeSliceCount	Number of slices of the volumetric buffer (3D texture) along the camera's focal axis.

Properties

Name	Description
fogControlMode	Controls which method to use to control the performance and quality of the volumetric fog.
resolutionDepthRatio	Controls how Unity shares resources between Screen (XY) and Depth (Z) resolutions.
volumetricFogBudget	Defines the performance to quality ratio of the volumetric fog. A value of 0 being the least resource-intensive and a value of 1 being the highest quality.