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

Object

ScriptableObject

VolumeComponent

VisualEnvironment

Implements

IApplyRevertPropertyContextMenuItemProvider

IVersionable<VisualEnvironment.Version>

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.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

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("Visual Environment")]
[SupportedOnRenderPipeline(typeof(HDRenderPipelineAsset))]
public sealed class VisualEnvironment : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider, IVersionable<VisualEnvironment.Version>

Fields

centerMode

The center is used when defining where the planets surface is. In automatic mode, the surface is at the world's origin and the center is derived from the planet radius.

Declaration

public EnumParameter<VisualEnvironment.PlanetMode> centerMode

Field Value

Type	Description
EnumParameter<VisualEnvironment.PlanetMode>

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 world space. Units: kilometers.

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: kilometers.

Declaration

[Header("Planet")]
public MinFloatParameter planetRadius

Field Value

Type	Description
MinFloatParameter

renderingSpace

When in Camera Space, sky and clouds will be centered on the camera. When in World Space, the camera can navigate through the atmosphere and the clouds.

Declaration

[Tooltip("When in Camera Space, sky and clouds will be centered on the camera.\nWhen in World Space, the camera can navigate through the atmosphere and the clouds.")]
public EnumParameter<RenderingSpace> renderingSpace

Field Value

Type	Description
EnumParameter<RenderingSpace>

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

Implements

IApplyRevertPropertyContextMenuItemProvider

IVersionable<TVersion>