Class HDRISky

HDRI Sky Volume Component. This component setups HDRI sky for rendering.

Inheritance

Object

SkySettings

HDRISky

Inherited Members

SkySettings.rotation

SkySettings.skyIntensityMode

SkySettings.exposure

SkySettings.multiplier

SkySettings.upperHemisphereLuxValue

SkySettings.upperHemisphereLuxColor

SkySettings.desiredLuxValue

SkySettings.updateMode

SkySettings.updatePeriod

SkySettings.includeSunInBaking

SkySettings.GetHashCode(Camera)

SkySettings.GetUniqueID<T>()

SkySettings.GetUniqueID(Type)

SkySettings.GetIntensityFromSettings()

Namespace: UnityEngine.Rendering.HighDefinition

Syntax

public class HDRISky : SkySettings

Fields

backplateType

Backplate Type {Disc, Rectangle, Ellipse, Infinite (Plane)}.

Declaration

public BackplateTypeParameter backplateType

Field Value

Type	Description
BackplateTypeParameter

blendAmount

Backplate blend parameter to blend the edge of the backplate with the background.

Declaration

public ClampedFloatParameter blendAmount

Field Value

Type	Description
ClampedFloatParameter

dirLightShadow

Allow backplate to receive shadow from directional light.

Declaration

public BoolParameter dirLightShadow

Field Value

Type	Description
BoolParameter

enableBackplate

Enable Backplate to have it visible.

Declaration

public BoolParameter enableBackplate

Field Value

Type	Description
BoolParameter

enableDistortion

Enable to have sky distortion.

Declaration

public BoolParameter enableDistortion

Field Value

Type	Description
BoolParameter

flowmap

Texture used to distort the uv for the HDRI sky.

Declaration

public TextureParameter flowmap

Field Value

Type	Description
TextureParameter

groundLevel

Define the ground level of the Backplate.

Declaration

public FloatParameter groundLevel

Field Value

Type	Description
FloatParameter

hdriSky

Cubemap used to render the HDRI sky.

Declaration

public CubemapParameter hdriSky

Field Value

Type	Description
CubemapParameter

plateRotation

Backplate rotation parameter for the geometry.

Declaration

public ClampedFloatParameter plateRotation

Field Value

Type	Description
ClampedFloatParameter

plateTexOffset

Backplate projection offset on the plane.

Declaration

public Vector2Parameter plateTexOffset

Field Value

Type	Description
Vector2Parameter

plateTexRotation

Backplate rotation parameter for the projected texture.

Declaration

public ClampedFloatParameter plateTexRotation

Field Value

Type	Description
ClampedFloatParameter

pointLightShadow

Allow backplate to receive shadow from point light.

Declaration

public BoolParameter pointLightShadow

Field Value

Type	Description
BoolParameter

procedural

Enable to have a simple, procedural distorsion.

Declaration

public BoolParameter procedural

Field Value

Type	Description
BoolParameter

projectionDistance

Backplate's projection distance to varying the cubemap projection on the plate.

Declaration

public MinFloatParameter projectionDistance

Field Value

Type	Description
MinFloatParameter

rectLightShadow

Allow backplate to receive shadow from Area light.

Declaration

public BoolParameter rectLightShadow

Field Value

Type	Description
BoolParameter

scale

Extent of the Backplate (if circle only the X value is considered).

Declaration

public Vector2Parameter scale

Field Value

Type	Description
Vector2Parameter

scrollDirection

Direction of the distortion.

Declaration

public ClampedFloatParameter scrollDirection

Field Value

Type	Description
ClampedFloatParameter

scrollSpeed

Speed of the distortion.

Declaration

public MinFloatParameter scrollSpeed

Field Value

Type	Description
MinFloatParameter

shadowTint

Backplate Shadow Tint projected on the plane.

Declaration

public ColorParameter shadowTint

Field Value

Type	Description
ColorParameter

upperHemisphereOnly

Enable to affect only the upper part of the sky.

Declaration

public BoolParameter upperHemisphereOnly

Field Value

Type	Description
BoolParameter

Methods

GetHashCode()

Returns the hash code of the HDRI sky parameters.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	The hash code of the HDRI sky parameters.

Overrides

SkySettings.GetHashCode()

GetSkyRendererType()

Returns HDRISkyRenderer type.

Declaration

public override Type GetSkyRendererType()

Returns

Type	Description
Type	HDRISkyRenderer type.

Overrides

SkySettings.GetSkyRendererType()

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. In addition to the checks done with the base function, this HDRISky override checks whether the cubemap parameter has changed if both settings are HDRISky.

Declaration

public override 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.

Overrides

SkySettings.SignificantlyDivergesFrom(SkySettings)