docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class VolumetricClouds

    A volume component that holds settings for the ambient occlusion.

    Inheritance
    object
    Object
    ScriptableObject
    VolumeComponent
    VolumetricClouds
    Implements
    IApplyRevertPropertyContextMenuItemProvider
    IVersionable<VolumetricClouds.Version>
    ISerializationCallbackReceiver
    Inherited Members
    VolumeComponent.active
    VolumeComponent.displayName
    VolumeComponent.parameters
    VolumeComponent.Override(VolumeComponent, float)
    VolumeComponent.SetAllOverridesTo(bool)
    VolumeComponent.GetHashCode()
    VolumeComponent.AnyPropertiesIsOverridden()
    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.ReferenceEquals(object, object)
    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

    Name Description
    CloudShadowResolutionCount
    altitudeDistortion

    Controls the intensity of the wind-based altitude distortion of the clouds.

    altitudeRange

    Controls the size of the volumetric clouds volume in meters.

    altoStratusMap

    Specifies the higher cloud layer distribution in the advanced mode.

    altoStratusMapMultiplier

    Overrides the coverage of the higher cloud layer specified in the alto stratus map in the advanced mode.

    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.

    ambientOcclusionCurve

    Controls the ambient occlusion (Y axis) of the volumetric clouds as a function of the height (X Axis) inside the cloud volume.

    bottomAltitude

    Controls the altitude of the bottom of the volumetric clouds volume in meters.

    cloudControl

    Specifies the cloud control Mode: Simple, Advanced or Manual.

    cloudLut

    Specifies the lookup table for the clouds - Profile Coverage (R), Erosion (G), Ambient Occlusion (B).

    cloudMap

    Specifies the cloud map - Coverage (R), Rain (G), Type (B).

    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.

    cloudMapSpeedMultiplier

    Controls the multiplier to the speed of the cloud map.

    cloudOffset

    Offset (x,y) of the cloud map.

    cloudSimpleMode

    Specifies the quality mode used to render the volumetric clouds.

    cloudTiling

    Tiling (x,y) of the cloud map.

    cumulonimbusMap

    Specifies the anvil shaped clouds distribution in the advanced mode.

    cumulonimbusMapMultiplier

    Overrides the coverage of the anvil shaped clouds specified in the cumulonimbus map in the advanced mode.

    cumulusMap

    Specifies the lower cloud layer distribution in the advanced mode.

    cumulusMapMultiplier

    Overrides the coverage of the lower cloud layer specified in the cumulus map in the advanced mode.

    densityCurve

    Controls the density (Y axis) of the volumetric clouds as a function of the height (X Axis) inside the cloud volume.

    densityMultiplier

    Controls the global density of the cloud volume.

    earthCurvature

    Controls the curvature of the cloud volume which defines the distance at which the clouds intersect with the horizon.

    enable

    Enable/Disable the volumetric clouds effect.

    erosionCurve

    Controls the erosion (Y axis) of the volumetric clouds as a function of the height (X Axis) inside the cloud volume.

    erosionFactor

    Controls the smaller noise on the edge of the clouds. A higher value will erode clouds more significantly.

    erosionNoiseType

    Controls the type of noise used to generate the smaller noise passing through the cloud coverage.

    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.

    erosionScale

    Controls the size of the smaller noise passing through the cloud coverage.

    erosionSpeedMultiplier

    Controls the multiplier to the speed of the erosion cloud shapes.

    fadeInDistance

    Controls the distance that it takes for the clouds to reach their complete density.

    fadeInMode

    Controls the mode in which the clouds fade in when close to the camera's near plane.

    fadeInStart

    Controls the minimal distance at which clouds start appearing.

    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.

    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.

    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.

    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.

    microErosionFactor

    Controls the smallest noise on the edge of the clouds. A higher value will erode clouds more.

    microErosionScale

    Controls the size of the smaller noise passing through the cloud coverage.

    multiScattering

    Controls the amount of multi-scattering inside the cloud.

    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.

    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.

    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.

    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.

    powderEffectIntensity

    Controls the amount of local scattering in the clouds. A higher value may produce a more powdery or diffused aspect.

    rainMap

    Specifies the rain distribution in the advanced mode.

    scatteringTint

    Specifies the tint of the cloud scattering color.

    shadowDistance

    Sets the size of the area covered by shadow around the camera.

    shadowOpacity

    Controls the opacity of the volumetric clouds shadow.

    shadowOpacityFallback

    Controls the shadow opacity when outside the area covered by the volumetric clouds shadow.

    shadowPlaneHeightOffset

    Controls the vertical offset applied to compute the volumetric clouds shadow in meters. To have accurate results, enter the average height at which the volumetric clouds shadow is received.

    shadowResolution

    Specifies the resolution of the volumetric clouds shadow map.

    shadows

    Enable/Disable the volumetric clouds shadow. This will override the cookie of your directional light and the cloud layer shadow (if active).

    shapeFactor

    Controls the larger noise passing through the cloud coverage. A higher value will yield less cloud coverage and smaller clouds.

    shapeOffset

    Controls the world space offset applied when evaluating the larger noise passing through the cloud coverage.

    shapeScale

    Controls the size of the larger noise passing through the cloud coverage.

    shapeSpeedMultiplier

    Controls the multiplier to the speed of the larger cloud shapes.

    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.

    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.

    verticalErosionWindSpeed

    Controls the vertical wind speed of the erosion cloud shapes.

    verticalShapeWindSpeed

    Controls the vertical wind speed of the larger cloud shapes.

    Properties

    Name Description
    cloudPreset

    Specifies the weather preset in Simple mode.

    Methods

    Name Description
    OnAfterDeserialize()

    Called after deserializing

    OnBeforeSerialize()

    Called before serializing

    In This Article
    Back to top
    Copyright © 2023 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)