Class CloudLayer | High Definition RP | 10.0.0-preview.27
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
    CloudLayer
    Inherited Members
    VolumeComponent.active
    VolumeComponent.OnEnable()
    VolumeComponent.OnDisable()
    VolumeComponent.Override(VolumeComponent, Single)
    VolumeComponent.SetAllOverridesTo(Boolean)
    VolumeComponent.OnDestroy()
    VolumeComponent.Release()
    VolumeComponent.displayName
    VolumeComponent.parameters
    Namespace: UnityEngine.Rendering.HighDefinition
    Syntax
    public class CloudLayer : VolumeComponent

    Fields

    cloudMap

    Texture used to render the clouds.

    Declaration
    [Tooltip("Specify the texture HDRP uses to render the clouds (in LatLong layout).")]
    public TextureParameter cloudMap
    Field Value
    Type Description
    TextureParameter

    enabled

    Enable fog.

    Declaration
    [Tooltip("Check to have a cloud layer in the sky.")]
    public BoolParameter enabled
    Field Value
    Type Description
    BoolParameter

    enableDistortion

    Enable to have cloud distortion.

    Declaration
    [Tooltip("Enable or disable cloud distortion.")]
    public BoolParameter enableDistortion
    Field Value
    Type Description
    BoolParameter

    flowmap

    Texture used to distort the UVs for the cloud layer.

    Declaration
    [Tooltip("Specify the flowmap HDRP uses for cloud distortion (in LatLong layout).")]
    public TextureParameter flowmap
    Field Value
    Type Description
    TextureParameter

    intensityMultiplier

    Intensity multipler of the clouds.

    Declaration
    [Tooltip("Sets the intensity multiplier for the clouds.")]
    public MinFloatParameter intensityMultiplier
    Field Value
    Type Description
    MinFloatParameter

    procedural

    Enable to have a simple, procedural distorsion.

    Declaration
    [Tooltip("If enabled, the clouds will be distorted by a constant wind.")]
    public BoolParameter procedural
    Field Value
    Type Description
    BoolParameter

    rotation

    Rotation of the clouds.

    Declaration
    [Tooltip("Sets the rotation of the clouds.")]
    public ClampedFloatParameter rotation
    Field Value
    Type Description
    ClampedFloatParameter

    scrollDirection

    Direction of the distortion.

    Declaration
    [Tooltip("Sets the rotation of the distortion (in degrees).")]
    public ClampedFloatParameter scrollDirection
    Field Value
    Type Description
    ClampedFloatParameter

    scrollSpeed

    Speed of the distortion.

    Declaration
    [Tooltip("Sets the cloud scrolling speed. The higher the value, the faster the clouds will move.")]
    public MinFloatParameter scrollSpeed
    Field Value
    Type Description
    MinFloatParameter

    tint

    Color multiplier of the clouds.

    Declaration
    [Tooltip("Specifies the color that HDRP uses to tint the clouds.")]
    public ColorParameter tint
    Field Value
    Type Description
    ColorParameter

    upperHemisphereOnly

    Enable to cover only the upper part of the sky.

    Declaration
    [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

    Apply(CloudLayer, Material)

    Sets keywords and parameters on a sky material to render the cloud layer.

    Declaration
    public static void Apply(CloudLayer layer, Material skyMaterial)
    Parameters
    Type Name Description
    CloudLayer layer

    The cloud layer to apply.

    Material skyMaterial

    The sky material to change.

    GetHashCode()

    Returns the hash code of the HDRI sky parameters.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32

    The hash code of the HDRI sky parameters.

    Overrides
    VolumeComponent.GetHashCode()

    GetParameters()

    Returns the shader parameters of the cloud layer.

    Declaration
    public Vector4 GetParameters()
    Returns
    Type Description
    Vector4

    The shader parameters of the cloud layer.

    Back to top
    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