Class VolumetricClouds
A volume component that holds settings for the ambient occlusion.
Implements
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
[Serializable]
[VolumeComponentMenu("Sky/Volumetric Clouds")]
[SupportedOnRenderPipeline(typeof(HDRenderPipelineAsset))]
public sealed class VolumetricClouds : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider, IVersionable<VolumetricClouds.Version>, ISerializationCallbackReceiver
Fields
CloudShadowResolutionCount
Declaration
public const int CloudShadowResolutionCount = 5
Field Value
Type | Description |
---|---|
int |
altitudeDistortion
Controls the intensity of the wind-based altitude distortion of the clouds.
Declaration
[Tooltip("Controls the intensity of the wind-based altitude distortion of the clouds.")]
public ClampedFloatParameter altitudeDistortion
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
altitudeRange
Controls the size of the volumetric clouds volume in meters.
Declaration
[Tooltip("Controls the size of the volumetric clouds volume in meters.")]
public MinFloatParameter altitudeRange
Field Value
Type | Description |
---|---|
MinFloatParameter |
altoStratusMap
Specifies the higher cloud layer distribution in the advanced mode.
Declaration
[Tooltip("Specifies the higher cloud layer distribution in the advanced mode.")]
public TextureParameter altoStratusMap
Field Value
Type | Description |
---|---|
TextureParameter |
altoStratusMapMultiplier
Overrides the coverage of the higher cloud layer specified in the alto stratus map in the advanced mode.
Declaration
[Tooltip("Overrides the coverage of the higher cloud layer specified in the alto stratus map in the advanced mode.")]
public ClampedFloatParameter altoStratusMapMultiplier
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
ambientLightProbeDimmer
Controls the influence of the light probes on the cloud volume. A lower value will suppress the ambient light and produce darker clouds overall.
Declaration
[Tooltip("Controls the influence of the light probes on the cloud volume. A lower value will suppress the ambient light and produce darker clouds overall.")]
public ClampedFloatParameter ambientLightProbeDimmer
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
ambientOcclusionCurve
Controls the ambient occlusion (Y axis) of the volumetric clouds as a function of the height (X Axis) inside the cloud volume.
Declaration
[Tooltip("Controls the ambient occlusion (Y axis) of the volumetric clouds as a function of the height (X Axis) inside the cloud volume.")]
public AnimationCurveParameter ambientOcclusionCurve
Field Value
Type | Description |
---|---|
AnimationCurveParameter |
bottomAltitude
Controls the altitude of the bottom of the volumetric clouds volume in meters.
Declaration
[Tooltip("Controls the altitude of the bottom of the volumetric clouds volume in meters.")]
public MinFloatParameter bottomAltitude
Field Value
Type | Description |
---|---|
MinFloatParameter |
cloudControl
Specifies the cloud control Mode: Simple, Advanced or Manual.
Declaration
[Tooltip("Specifies the cloud control Mode: Simple, Advanced or Manual.")]
public VolumetricClouds.CloudControlParameter cloudControl
Field Value
Type | Description |
---|---|
VolumetricClouds.CloudControlParameter |
cloudLut
Specifies the lookup table for the clouds - Profile Coverage (R), Erosion (G), Ambient Occlusion (B).
Declaration
[Tooltip("Specifies the lookup table for the clouds - Profile Coverage (R), Erosion (G), Ambient Occlusion (B).")]
public TextureParameter cloudLut
Field Value
Type | Description |
---|---|
TextureParameter |
cloudMap
Specifies the cloud map - Coverage (R), Rain (G), Type (B).
Declaration
[Tooltip("Specifies the cloud map - Coverage (R), Rain (G), Type (B).")]
public TextureParameter cloudMap
Field Value
Type | Description |
---|---|
TextureParameter |
cloudMapResolution
Specifies the internal texture resolution used for the cloud map in the advanced mode. A lower value will lead to higher performance, but less precise cloud type transitions.
Declaration
[Tooltip("Specifies the internal texture resolution used for the cloud map in the advanced mode. A lower value will lead to higher performance, but less precise cloud type transitions.")]
public VolumetricClouds.CloudMapResolutionParameter cloudMapResolution
Field Value
Type | Description |
---|---|
VolumetricClouds.CloudMapResolutionParameter |
cloudMapSpeedMultiplier
Controls the multiplier to the speed of the cloud map.
Declaration
[Tooltip("Controls the multiplier to the speed of the cloud map.")]
public ClampedFloatParameter cloudMapSpeedMultiplier
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
cloudOffset
Offset (x,y) of the cloud map.
Declaration
[Tooltip("Offset (x,y) of the cloud map.")]
public Vector2Parameter cloudOffset
Field Value
Type | Description |
---|---|
Vector2Parameter |
cloudSimpleMode
Specifies the quality mode used to render the volumetric clouds.
Declaration
public VolumetricClouds.CloudSimpleModeParameter cloudSimpleMode
Field Value
Type | Description |
---|---|
VolumetricClouds.CloudSimpleModeParameter |
cloudTiling
Tiling (x,y) of the cloud map.
Declaration
[Tooltip("Tiling (x,y) of the cloud map.")]
public Vector2Parameter cloudTiling
Field Value
Type | Description |
---|---|
Vector2Parameter |
cumulonimbusMap
Specifies the anvil shaped clouds distribution in the advanced mode.
Declaration
[Tooltip("Specifies the anvil shaped clouds distribution in the advanced mode.")]
public TextureParameter cumulonimbusMap
Field Value
Type | Description |
---|---|
TextureParameter |
cumulonimbusMapMultiplier
Overrides the coverage of the anvil shaped clouds specified in the cumulonimbus map in the advanced mode.
Declaration
[Tooltip("Overrides the coverage of the anvil shaped clouds specified in the cumulonimbus map in the advanced mode.")]
public ClampedFloatParameter cumulonimbusMapMultiplier
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
cumulusMap
Specifies the lower cloud layer distribution in the advanced mode.
Declaration
[Tooltip("Specifies the lower cloud layer distribution in the advanced mode.")]
public TextureParameter cumulusMap
Field Value
Type | Description |
---|---|
TextureParameter |
cumulusMapMultiplier
Overrides the coverage of the lower cloud layer specified in the cumulus map in the advanced mode.
Declaration
[Tooltip("Overrides the coverage of the lower cloud layer specified in the cumulus map in the advanced mode.")]
public ClampedFloatParameter cumulusMapMultiplier
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
densityCurve
Controls the density (Y axis) of the volumetric clouds as a function of the height (X Axis) inside the cloud volume.
Declaration
[Tooltip("Controls the density (Y axis) of the volumetric clouds as a function of the height (X Axis) inside the cloud volume.")]
public AnimationCurveParameter densityCurve
Field Value
Type | Description |
---|---|
AnimationCurveParameter |
densityMultiplier
Controls the global density of the cloud volume.
Declaration
[Tooltip("Controls the global density of the cloud volume.")]
public ClampedFloatParameter densityMultiplier
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
earthCurvature
Controls the curvature of the cloud volume which defines the distance at which the clouds intersect with the horizon.
Declaration
[Tooltip("Controls the curvature of the cloud volume which defines the distance at which the clouds intersect with the horizon.")]
public ClampedFloatParameter earthCurvature
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
enable
Enable/Disable the volumetric clouds effect.
Declaration
[Tooltip("Enable/Disable the volumetric clouds effect.")]
public BoolParameter enable
Field Value
Type | Description |
---|---|
BoolParameter |
erosionCurve
Controls the erosion (Y axis) of the volumetric clouds as a function of the height (X Axis) inside the cloud volume.
Declaration
[Tooltip("Controls the erosion (Y axis) of the volumetric clouds as a function of the height (X Axis) inside the cloud volume.")]
public AnimationCurveParameter erosionCurve
Field Value
Type | Description |
---|---|
AnimationCurveParameter |
erosionFactor
Controls the smaller noise on the edge of the clouds. A higher value will erode clouds more significantly.
Declaration
[Tooltip("Controls the smaller noise on the edge of the clouds. A higher value will erode clouds more significantly.")]
public ClampedFloatParameter erosionFactor
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
erosionNoiseType
Controls the type of noise used to generate the smaller noise passing through the cloud coverage.
Declaration
[Tooltip("Controls the type of noise used to generate the smaller noise passing through the cloud coverage.")]
public VolumetricClouds.CloudErosionNoiseParameter erosionNoiseType
Field Value
Type | Description |
---|---|
VolumetricClouds.CloudErosionNoiseParameter |
erosionOcclusion
Controls how much Erosion Factor is taken into account when computing ambient occlusion. The Erosion Factor parameter is editable in the custom preset, Advanced and Manual Modes.
Declaration
[Tooltip("Controls how much Erosion Factor is taken into account when computing ambient occlusion. The Erosion Factor parameter is editable in the custom preset, Advanced and Manual Modes.")]
public ClampedFloatParameter erosionOcclusion
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
erosionScale
Controls the size of the smaller noise passing through the cloud coverage.
Declaration
[Tooltip("Controls the size of the smaller noise passing through the cloud coverage.")]
public MinFloatParameter erosionScale
Field Value
Type | Description |
---|---|
MinFloatParameter |
erosionSpeedMultiplier
Controls the multiplier to the speed of the erosion cloud shapes.
Declaration
[Tooltip("Controls the multiplier to the speed of the erosion cloud shapes.")]
public ClampedFloatParameter erosionSpeedMultiplier
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
fadeInDistance
Controls the distance that it takes for the clouds to reach their complete density.
Declaration
[Tooltip("Controls the distance that it takes for the clouds to reach their complete density.")]
public MinFloatParameter fadeInDistance
Field Value
Type | Description |
---|---|
MinFloatParameter |
fadeInMode
Controls the mode in which the clouds fade in when close to the camera's near plane.
Declaration
[Tooltip("Controls the mode in which the clouds fade in when close to the camera's near plane.")]
public VolumetricClouds.CloudFadeInModeParameter fadeInMode
Field Value
Type | Description |
---|---|
VolumetricClouds.CloudFadeInModeParameter |
fadeInStart
Controls the minimal distance at which clouds start appearing.
Declaration
[Tooltip("Controls the minimal distance at which clouds start appearing.")]
public MinFloatParameter fadeInStart
Field Value
Type | Description |
---|---|
MinFloatParameter |
ghostingReduction
Enable/Disable the volumetric clouds ghosting reduction. When enabled, reduces significantly the ghosting of the volumetric clouds, but may introduce some flickering at lower temporal accumulation factors.
Declaration
[Tooltip("Enable/Disable the volumetric clouds ghosting reduction. When enabled, reduces significantly the ghosting of the volumetric clouds, but may introduce some flickering at lower temporal accumulation factors.")]
public BoolParameter ghostingReduction
Field Value
Type | Description |
---|---|
BoolParameter |
globalWindSpeed
Sets the global horizontal wind speed in kilometers per hour. This value can be relative to the Global Wind Speed defined in the Visual Environment.
Declaration
[Tooltip("Sets the global horizontal wind speed in kilometers per hour.\nThis value can be relative to the Global Wind Speed defined in the Visual Environment.")]
public WindSpeedParameter globalWindSpeed
Field Value
Type | Description |
---|---|
WindSpeedParameter |
localClouds
When enabled, clouds are part of the scene and you can interact with them. This means you can move around and inside the clouds, they can appear between the Camera and other GameObjects, and the Camera's clipping planes affect the clouds. When disabled, the clouds are part of the skybox. This means the clouds and their shadows appear relative to the Camera and always appear behind geometry.
Declaration
[Tooltip("When enabled, clouds are part of the scene and you can interact with them. This means you can move around and inside the clouds, they can appear between the Camera and other GameObjects, and the Camera's clipping planes affect the clouds. When disabled, the clouds are part of the skybox. This means the clouds and their shadows appear relative to the Camera and always appear behind geometry.")]
public BoolParameter localClouds
Field Value
Type | Description |
---|---|
BoolParameter |
microErosion
When enabled, an additional noise should be evaluated for the clouds in the advanced and manual modes. This increases signficantly the cost of the volumetric clouds.
Declaration
[Tooltip("When enabled, an additional noise should be evaluated for the clouds in the advanced and manual modes. This increases signficantly the cost of the volumetric clouds.")]
public BoolParameter microErosion
Field Value
Type | Description |
---|---|
BoolParameter |
microErosionFactor
Controls the smallest noise on the edge of the clouds. A higher value will erode clouds more.
Declaration
[Tooltip("Controls the smallest noise on the edge of the clouds. A higher value will erode clouds more.")]
public ClampedFloatParameter microErosionFactor
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
microErosionScale
Controls the size of the smaller noise passing through the cloud coverage.
Declaration
[Tooltip("Controls the size of the smaller noise passing through the cloud coverage.")]
public MinFloatParameter microErosionScale
Field Value
Type | Description |
---|---|
MinFloatParameter |
multiScattering
Controls the amount of multi-scattering inside the cloud.
Declaration
[Tooltip("Controls the amount of multi-scattering inside the cloud.")]
public ClampedFloatParameter multiScattering
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
numLightSteps
Controls the number of steps when evaluating the clouds' lighting. A higher value will lead to smoother lighting and improved self-shadowing, but at a higher cost.
Declaration
[Tooltip("Controls the number of steps when evaluating the clouds' lighting. A higher value will lead to smoother lighting and improved self-shadowing, but at a higher cost.")]
public ClampedIntParameter numLightSteps
Field Value
Type | Description |
---|---|
ClampedIntParameter |
numPrimarySteps
Controls the number of steps when evaluating the clouds' transmittance. A higher value may lead to a lower noise level and longer view distance, but at a higher cost.
Declaration
[Tooltip("Controls the number of steps when evaluating the clouds' transmittance. A higher value may lead to a lower noise level and longer view distance, but at a higher cost.")]
public ClampedIntParameter numPrimarySteps
Field Value
Type | Description |
---|---|
ClampedIntParameter |
orientation
Controls the orientation of the wind relative to the X world vector. This value can be relative to the Global Wind Orientation defined in the Visual Environment.
Declaration
[Tooltip("Controls the orientation of the wind relative to the X world vector.\nThis value can be relative to the Global Wind Orientation defined in the Visual Environment.")]
public WindOrientationParameter orientation
Field Value
Type | Description |
---|---|
WindOrientationParameter |
perceptualBlending
Specifies the strength of the perceptual blending for the volumetric clouds. This value should be treated as flag and only be set to 0.0 or 1.0.
Declaration
[Tooltip("Specifies the strength of the perceptual blending for the volumetric clouds. This value should be treated as flag and only be set to 0.0 or 1.0.")]
public ClampedFloatParameter perceptualBlending
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
powderEffectIntensity
Controls the amount of local scattering in the clouds. A higher value may produce a more powdery or diffused aspect.
Declaration
[Tooltip("Controls the amount of local scattering in the clouds. A higher value may produce a more powdery or diffused aspect.")]
public ClampedFloatParameter powderEffectIntensity
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
rainMap
Specifies the rain distribution in the advanced mode.
Declaration
[Tooltip("Specifies the rain distribution in the advanced mode.")]
public TextureParameter rainMap
Field Value
Type | Description |
---|---|
TextureParameter |
scatteringTint
Specifies the tint of the cloud scattering color.
Declaration
[Tooltip("Specifies the tint of the cloud scattering color.")]
public ColorParameter scatteringTint
Field Value
Type | Description |
---|---|
ColorParameter |
shadowDistance
Sets the size of the area covered by shadow around the camera.
Declaration
[Tooltip("Sets the size of the area covered by shadow around the camera.")]
public MinFloatParameter shadowDistance
Field Value
Type | Description |
---|---|
MinFloatParameter |
shadowOpacity
Controls the opacity of the volumetric clouds shadow.
Declaration
[Tooltip("Controls the opacity of the volumetric clouds shadow.")]
public ClampedFloatParameter shadowOpacity
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
shadowOpacityFallback
Controls the shadow opacity when outside the area covered by the volumetric clouds shadow.
Declaration
[Tooltip("Controls the shadow opacity when outside the area covered by the volumetric clouds shadow.")]
public ClampedFloatParameter shadowOpacityFallback
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
shadowResolution
Specifies the resolution of the volumetric clouds shadow map.
Declaration
[Tooltip("Specifies the resolution of the volumetric clouds shadow map.")]
public VolumetricClouds.CloudShadowResolutionParameter shadowResolution
Field Value
Type | Description |
---|---|
VolumetricClouds.CloudShadowResolutionParameter |
shadows
When enabled, HDRP evaluates the Volumetric Clouds' shadows. The Volumetric Clouds shadow is rendered independently of the shadow map toggle of the directional light.
Declaration
[Tooltip("When enabled, HDRP evaluates the Volumetric Clouds' shadows. The Volumetric Clouds shadow is rendered independently of the shadow map toggle of the directional light.")]
public BoolParameter shadows
Field Value
Type | Description |
---|---|
BoolParameter |
shapeFactor
Controls the larger noise passing through the cloud coverage. A higher value will yield less cloud coverage and smaller clouds.
Declaration
[Tooltip("Controls the larger noise passing through the cloud coverage. A higher value will yield less cloud coverage and smaller clouds.")]
public ClampedFloatParameter shapeFactor
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
shapeOffset
Controls the world space offset applied when evaluating the larger noise passing through the cloud coverage.
Declaration
[Tooltip("Controls the world space offset applied when evaluating the larger noise passing through the cloud coverage.")]
public Vector3Parameter shapeOffset
Field Value
Type | Description |
---|---|
Vector3Parameter |
shapeScale
Controls the size of the larger noise passing through the cloud coverage.
Declaration
[Tooltip("Controls the size of the larger noise passing through the cloud coverage.")]
public MinFloatParameter shapeScale
Field Value
Type | Description |
---|---|
MinFloatParameter |
shapeSpeedMultiplier
Controls the multiplier to the speed of the larger cloud shapes.
Declaration
[Tooltip("Controls the multiplier to the speed of the larger cloud shapes.")]
public ClampedFloatParameter shapeSpeedMultiplier
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
sunLightDimmer
Controls the influence of the sun light on the cloud volume. A lower value will suppress the sun light and produce darker clouds overall.
Declaration
[Tooltip("Controls the influence of the sun light on the cloud volume. A lower value will suppress the sun light and produce darker clouds overall.")]
public ClampedFloatParameter sunLightDimmer
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
temporalAccumulationFactor
Temporal accumulation increases the visual quality of clouds by decreasing the noise. A higher value will give you better quality but can create ghosting.
Declaration
[Tooltip("Temporal accumulation increases the visual quality of clouds by decreasing the noise. A higher value will give you better quality but can create ghosting.")]
public ClampedFloatParameter temporalAccumulationFactor
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
verticalErosionWindSpeed
Controls the vertical wind speed of the erosion cloud shapes.
Declaration
[Tooltip("Controls the vertical wind speed of the erosion cloud shapes.")]
public FloatParameter verticalErosionWindSpeed
Field Value
Type | Description |
---|---|
FloatParameter |
verticalShapeWindSpeed
Controls the vertical wind speed of the larger cloud shapes.
Declaration
[Tooltip("Controls the vertical wind speed of the larger cloud shapes.")]
public FloatParameter verticalShapeWindSpeed
Field Value
Type | Description |
---|---|
FloatParameter |
Properties
cloudPreset
Specifies the weather preset in Simple mode.
Declaration
public VolumetricClouds.CloudPresets cloudPreset { get; set; }
Property Value
Type | Description |
---|---|
VolumetricClouds.CloudPresets |
Methods
OnAfterDeserialize()
Called after deserializing
Declaration
public void OnAfterDeserialize()
OnBeforeSerialize()
Called before serializing
Declaration
public void OnBeforeSerialize()