Class SkySettings

Base class for custom Sky Settings.

Inheritance

object

Object

ScriptableObject

VolumeComponent

SkySettings

GradientSky

HDRISky

PhysicallyBasedSky

Implements

IApplyRevertPropertyContextMenuItemProvider

Inherited Members

VolumeComponent.active

VolumeComponent.displayName

VolumeComponent.parameters

VolumeComponent.OnEnable()

VolumeComponent.OnDisable()

VolumeComponent.Override(VolumeComponent, float)

VolumeComponent.SetAllOverridesTo(bool)

VolumeComponent.AnyPropertiesIsOverridden()

VolumeComponent.OnDestroy()

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.Instantiate(Object, Vector3, Quaternion)

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

Object.Instantiate(Object)

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.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.Rendering.HighDefinition

Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll

Syntax

public abstract class SkySettings : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider

Fields

Name	Description
desiredLuxValue	Absolute intensity (in lux) of the sky.
exposure	Exposure of the sky.
includeSunInBaking	True if the sun disk should be included in the baking information (where available).
multiplier	Intensity Multipler of the sky.
rotation	Rotation of the sky.
skyIntensityMode	Intensity mode of the sky.
updateMode	Update mode of the sky.
updatePeriod	In case of real-time update mode, time between updates. 0 means every frame.
upperHemisphereLuxColor	Informative helper that displays Show the color of Shadow.
upperHemisphereLuxValue	Informative helper that displays the relative intensity (in Lux) for the current HDR texture set in HDRI Sky.

Methods

Name	Description
GetHashCode()	Returns the hash code of the sky parameters. When used with PBR Sky please use the GetHashCode variant that takes a camera as parameter.
GetHashCode(Camera)	Returns the hash code of the sky parameters.
GetIntensityFromSettings()	Returns the sky intensity as determined by this SkySetting.
GetSkyRendererType()	Returns the class type of the SkyRenderer associated with this Sky Settings.
GetUniqueID(Type)	Returns the sky type unique ID. Use this to override the skyType in the Visual Environment volume component.
GetUniqueID<T>()	Returns the sky type unique ID. Use this to override the skyType in the Visual Environment volume component.
SignificantlyDivergesFrom(SkySettings)	Determines if the SkySettings is significantly divergent from another. This is going to be used to determine whether to reset completely the ambient probe instead of using previous one when waiting for current data upon changes. Override this to have a per-sky specific heuristic.