Class SkySettings

Base class for custom Sky Settings.

Inheritance

Object

UnityEngine.Rendering.VolumeComponent

SkySettings

GradientSky

HDRISky

PhysicallyBasedSky

ProceduralSky

Inherited Members

UnityEngine.Rendering.VolumeComponent.active

UnityEngine.Rendering.VolumeComponent.OnEnable()

UnityEngine.Rendering.VolumeComponent.OnDisable()

UnityEngine.Rendering.VolumeComponent.Override(UnityEngine.Rendering.VolumeComponent, System.Single)

UnityEngine.Rendering.VolumeComponent.SetAllOverridesTo(System.Boolean)

UnityEngine.Rendering.VolumeComponent.OnDestroy()

UnityEngine.Rendering.VolumeComponent.Release()

UnityEngine.Rendering.VolumeComponent.displayName

UnityEngine.Rendering.VolumeComponent.parameters

Namespace: UnityEngine.Rendering.HighDefinition

Syntax

public abstract class SkySettings : VolumeComponent

Fields

desiredLuxValue

Absolute intensity (in lux) of the sky.

Declaration

[Tooltip("Sets the absolute intensity (in Lux) of the current HDR texture set in HDRI Sky. Functions as a Lux intensity multiplier for the sky.")]
public FloatParameter desiredLuxValue

Field Value

Type	Description
UnityEngine.Rendering.FloatParameter

exposure

Exposure of the sky.

Declaration

[Tooltip("Sets the exposure of the sky in EV.")]
public FloatParameter exposure

Field Value

Type	Description
UnityEngine.Rendering.FloatParameter

includeSunInBaking

True if the sun disk should be included in the baking information (where available).

Declaration

[Tooltip("When enabled, HDRP uses the Sun Disk in baked lighting.")]
public BoolParameter includeSunInBaking

Field Value

Type	Description
UnityEngine.Rendering.BoolParameter

multiplier

Intensity Multipler of the sky.

Declaration

[Tooltip("Sets the intensity multiplier for the sky.")]
public MinFloatParameter multiplier

Field Value

Type	Description
UnityEngine.Rendering.MinFloatParameter

rotation

Rotation of the sky.

Declaration

[Tooltip("Sets the rotation of the sky.")]
public ClampedFloatParameter rotation

Field Value

Type	Description
UnityEngine.Rendering.ClampedFloatParameter

skyIntensityMode

Intensity mode of the sky.

Declaration

[Tooltip("Specifies the intensity mode HDRP uses for the sky.")]
public SkyIntensityParameter skyIntensityMode

Field Value

Type	Description
SkyIntensityParameter

updateMode

Update mode of the sky.

Declaration

[Tooltip("Specifies when HDRP updates the environment lighting. When set to OnDemand, use HDRenderPipeline.RequestSkyEnvironmentUpdate() to request an update.")]
public EnvUpdateParameter updateMode

Field Value

Type	Description
EnvUpdateParameter

updatePeriod

In case of real-time update mode, time between updates. 0 means every frame.

Declaration

[Tooltip("Sets the period, in seconds, at which HDRP updates the environment ligting (0 means HDRP updates it every frame).")]
public MinFloatParameter updatePeriod

Field Value

Type	Description
UnityEngine.Rendering.MinFloatParameter

upperHemisphereLuxColor

Informative helper that displays Show the color of Shadow.

Declaration

[Tooltip("Informative helper that displays Show the color of Shadow.")]
public Vector3Parameter upperHemisphereLuxColor

Field Value

Type	Description
UnityEngine.Rendering.Vector3Parameter

upperHemisphereLuxValue

Informative helper that displays the relative intensity (in Lux) for the current HDR texture set in HDRI Sky.

Declaration

[Tooltip("Informative helper that displays the relative intensity (in Lux) for the current HDR texture set in HDRI Sky.")]
public MinFloatParameter upperHemisphereLuxValue

Field Value

Type	Description
UnityEngine.Rendering.MinFloatParameter

Methods

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.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	The hash code of the sky parameters.

Overrides

UnityEngine.Rendering.VolumeComponent.GetHashCode()

GetHashCode(Camera)

Returns the hash code of the sky parameters.

Declaration

public virtual int GetHashCode(Camera camera)

Parameters

Type	Name	Description
Camera	camera	The camera we want to use to compute the hash of the sky.

Returns

Type	Description
Int32	The hash code of the sky parameters.

GetIntensityFromSettings()

Returns the sky intensity as determined by this SkySetting.

Declaration

public float GetIntensityFromSettings()

Returns

Type	Description
Single	The sky intensity.

GetSkyRendererType()

Returns the class type of the SkyRenderer associated with this Sky Settings.

Declaration

public abstract Type GetSkyRendererType()

Returns

Type	Description
Type	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.

Declaration

public static int GetUniqueID(Type type)

Parameters

Type	Name	Description
Type	type	Type of the sky.

Returns

Type	Description
Int32	The unique ID for the requested sky type.

GetUniqueID<T>()

Returns the sky type unique ID. Use this to override the skyType in the Visual Environment volume component.

Declaration

public static int GetUniqueID<T>()

Returns

Type	Description
Int32	The unique ID for the requested sky type.

Type Parameters

Name	Description
T	Type of the sky.

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.

Declaration

public virtual bool SignificantlyDivergesFrom(SkySettings otherSettings)

Parameters

Type	Name	Description
SkySettings	otherSettings	The settings to compare with.

Returns

Type	Description
Boolean	Whether the settings are deemed very different.