Class VisualEnvironment

Visual Environment Volume Component. This component setups the sky used for rendering as well as the way ambient probe should be computed.

Inheritance
Object
VolumeComponent
VisualEnvironment
Inherited Members
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)
Namespace: UnityEngine.Rendering.HighDefinition
Syntax
[Serializable]
[VolumeComponentMenu("Visual Environment")]
[SupportedOnRenderPipeline(typeof(HDRenderPipelineAsset))]
public sealed class VisualEnvironment : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider

Fields

cloudType

Type of clouds that should be used for rendering.

Declaration
public NoInterpIntParameter cloudType
Field Value
Type Description
NoInterpIntParameter

planetCenter

Position of the center of the planet in the world space. Units: meters. Does not affect the precomputation.

Declaration
public Vector3Parameter planetCenter
Field Value
Type Description
Vector3Parameter

planetRadius

Radius of the planet (distance from the center of the planet to the sea level). Units: meters.

Declaration
public MinFloatParameter planetRadius
Field Value
Type Description
MinFloatParameter

planetType

Allows to specify the location of the planet. If disabled, the planet is always below the camera in the world-space X-Z plane.

Declaration
[Header("Planet")]
[Tooltip("Controls the planet settings which will impact environment effects like clouds, fog and sky.\nChoose whether to simulate a flat planet, a spherical planet, or use a preset with Earth values.")]
public EnumParameter<VisualEnvironment.ShapeType> planetType
Field Value
Type Description
EnumParameter<VisualEnvironment.ShapeType>

seaLevel

World-space Y coordinate of the sea level of the planet. Units: meters.

Declaration
[Tooltip("Sets the world-space y coordinate of the planet's sea level in meters.")]
public FloatParameter seaLevel
Field Value
Type Description
FloatParameter

skyAmbientMode

Defines the way the ambient probe should be computed.

Declaration
public SkyAmbientModeParameter skyAmbientMode
Field Value
Type Description
SkyAmbientModeParameter

skyType

Type of sky that should be used for rendering.

Declaration
[Header("Sky")]
public NoInterpIntParameter skyType
Field Value
Type Description
NoInterpIntParameter

windOrientation

Controls the global orientation of the wind relative to the X world vector.

Declaration
[Header("Wind")]
public ClampedFloatParameter windOrientation
Field Value
Type Description
ClampedFloatParameter

windSpeed

Controls the global wind speed in kilometers per hour.

Declaration
public FloatParameter windSpeed
Field Value
Type Description
FloatParameter