docs.unity.cn
    Show / Hide Table of Contents

    Class WaterRendering

    A volume component that holds settings for the water surface.

    Inheritance
    Object
    VolumeComponent
    WaterRendering
    Inherited Members
    VolumeComponent.active
    VolumeComponent.OnEnable()
    VolumeComponent.OnDisable()
    VolumeComponent.Override(VolumeComponent, Single)
    VolumeComponent.SetAllOverridesTo(Boolean)
    VolumeComponent.GetHashCode()
    VolumeComponent.AnyPropertiesIsOverridden()
    VolumeComponent.OnDestroy()
    VolumeComponent.Release()
    UnityEngine.Rendering.VolumeComponent.TryGetRevertMethodForFieldName(UnityEditor.SerializedProperty, System.Action<UnityEditor.SerializedProperty>)
    UnityEngine.Rendering.VolumeComponent.GetSourceTerm()
    UnityEngine.Rendering.VolumeComponent.TryGetApplyMethodForFieldName(UnityEditor.SerializedProperty, System.Action<UnityEditor.SerializedProperty>)
    UnityEngine.Rendering.VolumeComponent.GetSourceName(UnityEngine.Component)
    VolumeComponent.displayName
    VolumeComponent.parameters
    Namespace: UnityEngine.Rendering.HighDefinition
    Syntax
    [Serializable]
    [VolumeComponentMenuForRenderPipeline("Lighting/WaterRendering", new Type[]{typeof(HDRenderPipeline)})]
    public sealed class WaterRendering : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider

    Fields

    ambientProbeDimmer

    Controls the influence of the ambient light probe on the water surfaces.

    Declaration
    [Tooltip("Controls the influence of the ambient light probe on the water surfaces.")]
    public ClampedFloatParameter ambientProbeDimmer
    Field Value
    Type Description
    ClampedFloatParameter

    elevationTransition

    Sets the elevation at which the max grid size is reached.

    Declaration
    [Tooltip("Sets the elevation at which the max grid size is reached.")]
    public MinFloatParameter elevationTransition
    Field Value
    Type Description
    MinFloatParameter

    enable

    When enabled, the water surfaces are rendered.

    Declaration
    [Tooltip("When enabled, the water surfaces are rendered.")]
    public BoolParameter enable
    Field Value
    Type Description
    BoolParameter

    maxGridSize

    Sets the size of the water grids in meters.

    Declaration
    [Tooltip("Sets the size of the maximum water grids in meters.")]
    public MinFloatParameter maxGridSize
    Field Value
    Type Description
    MinFloatParameter

    maxTessellationFactor

    Sets the maximum tessellation factor for the water surface.

    Declaration
    [Tooltip("Sets the maximum tessellation factor for the water surface.")]
    [AdditionalProperty]
    public ClampedFloatParameter maxTessellationFactor
    Field Value
    Type Description
    ClampedFloatParameter

    minGridSize

    Sets the size of the water grids in meters.

    Declaration
    [Tooltip("Sets the size of the minimum water grids in meters.")]
    public MinFloatParameter minGridSize
    Field Value
    Type Description
    MinFloatParameter

    numLevelOfDetails

    Controls the number of LOD patches that are rendered.

    Declaration
    [Tooltip("Controls the number of LOD patches that are rendered.")]
    public ClampedIntParameter numLevelOfDetails
    Field Value
    Type Description
    ClampedIntParameter

    tessellationFactorFadeRange

    Sets the range at which the tessellation factor reaches zero.

    Declaration
    [Tooltip("Sets the range at which the tessellation factor reaches zero.")]
    [AdditionalProperty]
    public MinFloatParameter tessellationFactorFadeRange
    Field Value
    Type Description
    MinFloatParameter

    tessellationFactorFadeStart

    Sets the distance at which the tessellation factor start to lower.

    Declaration
    [Tooltip(" Sets the distance at which the tessellation factor start to lower.")]
    [AdditionalProperty]
    public MinFloatParameter tessellationFactorFadeStart
    Field Value
    Type Description
    MinFloatParameter
    Back to top Copyright © 2023 Unity Technologies — Terms of use
    Generated by DocFX
    on 07 August 2023