docs.unity3d.com
    Show / Hide Table of Contents

    Class CloudLayer

    Cloud Layer Volume Component. This component setups the Cloud Layer for rendering.

    Inheritance
    Object
    VolumeComponent
    CloudSettings
    CloudLayer
    Inherited Members
    CloudSettings.GetHashCode(Camera)
    CloudSettings.GetUniqueID<T>()
    CloudSettings.GetUniqueID(Type)
    VolumeComponent.active
    VolumeComponent.OnEnable()
    VolumeComponent.OnDisable()
    VolumeComponent.Override(VolumeComponent, Single)
    VolumeComponent.SetAllOverridesTo(Boolean)
    VolumeComponent.AnyPropertiesIsOverridden()
    VolumeComponent.OnDestroy()
    VolumeComponent.Release()
    VolumeComponent.displayName
    VolumeComponent.parameters
    Namespace: UnityEngine.Rendering.HighDefinition
    Syntax
    [VolumeComponentMenuForRenderPipeline("Sky/Cloud Layer", new Type[]{typeof(HDRenderPipeline)})]
    [CloudUniqueID(1)]
    public class CloudLayer : CloudSettings

    Fields

    layerA

    Layer A.

    Declaration
    public CloudLayer.CloudMap layerA
    Field Value
    Type Description
    CloudLayer.CloudMap

    layerB

    Layer B.

    Declaration
    public CloudLayer.CloudMap layerB
    Field Value
    Type Description
    CloudLayer.CloudMap

    layers

    Choose the number of cloud layers.

    Declaration
    public VolumeParameter<CloudMapMode> layers
    Field Value
    Type Description
    VolumeParameter<CloudMapMode>

    opacity

    Controls the global opacity of the cloud layer.

    Declaration
    [Tooltip("Controls the global opacity of the cloud layer.")]
    public ClampedFloatParameter opacity
    Field Value
    Type Description
    ClampedFloatParameter

    resolution

    Choose the resolution of the baked cloud texture.

    Declaration
    [AdditionalProperty]
    [Tooltip("Specifies the resolution of the texture HDRP uses to represent the clouds.")]
    public CloudLayerEnumParameter<CloudResolution> resolution
    Field Value
    Type Description
    CloudLayerEnumParameter<CloudResolution>

    shadowMultiplier

    Controls the opacity of the cloud shadows.

    Declaration
    [Header("Cloud Shadows")]
    [Tooltip("Controls the opacity of the cloud shadows.")]
    public MinFloatParameter shadowMultiplier
    Field Value
    Type Description
    MinFloatParameter

    shadowResolution

    Choose the resolution of the texture for the cloud shadows.

    Declaration
    [AdditionalProperty]
    [Tooltip("Specifies the resolution of the texture HDRP uses to represent the cloud shadows.")]
    public CloudLayerEnumParameter<CloudShadowsResolution> shadowResolution
    Field Value
    Type Description
    CloudLayerEnumParameter<CloudShadowsResolution>

    shadowSize

    Specifies the size of the projected shadows.

    Declaration
    [Tooltip("Specifies the size of the projected shadows.")]
    public MinFloatParameter shadowSize
    Field Value
    Type Description
    MinFloatParameter

    shadowTint

    Controls the tint of the cloud shadows.

    Declaration
    [Tooltip("Controls the tint of the cloud shadows.")]
    public ColorParameter shadowTint
    Field Value
    Type Description
    ColorParameter

    upperHemisphereOnly

    Enable to cover only the upper part of the sky.

    Declaration
    [AdditionalProperty]
    [Tooltip("Check this box if the cloud layer covers only the upper part of the sky.")]
    public BoolParameter upperHemisphereOnly
    Field Value
    Type Description
    BoolParameter

    Methods

    GetCloudRendererType()

    Returns CloudLayerRenderer type.

    Declaration
    public override Type GetCloudRendererType()
    Returns
    Type Description
    Type

    CloudLayerRenderer type.

    Overrides
    CloudSettings.GetCloudRendererType()

    GetHashCode()

    Returns the hash code of the CloudLayer parameters.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32

    The hash code of the CloudLayer parameters.

    Overrides
    VolumeComponent.GetHashCode()
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023