[VolumeComponentMenuForRenderPipeline("Sky/HDRI Sky", new Type[]{typeof(HDRenderPipeline)})]
[SkyUniqueID(1)]
public class HDRISky : SkySettings, IVersionable<HDRISky.Version>

Fields

backplateType

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

Declaration

[AdditionalProperty]
[Tooltip("Backplate type.")]
public BackplateTypeParameter backplateType

Field Value

Type	Description
BackplateTypeParameter

blendAmount

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

Declaration

[AdditionalProperty]
[Tooltip("Backplate blend parameter to blend the edge of the backplate with the background.")]
public ClampedFloatParameter blendAmount

Field Value

Type	Description
UnityEngine.Rendering.ClampedFloatParameter

dirLightShadow

Allow backplate to receive shadow from directional light.

Declaration

[AdditionalProperty]
[Tooltip("Allow backplate to receive shadow from directional light.")]
public BoolParameter dirLightShadow

Field Value

Type	Description
UnityEngine.Rendering.BoolParameter

distortionMode

Distortion mode.

Declaration

[Tooltip("Distortion mode to simulate sky movement.\nIn Scene View, requires Always Refresh to be enabled.")]
public VolumeParameter<HDRISky.DistortionMode> distortionMode

Field Value

Type	Description
UnityEngine.Rendering.VolumeParameter<HDRISky.DistortionMode>

enableBackplate

Enable Backplate to have it visible.

Declaration

[AdditionalProperty]
[Tooltip("Enable or disable the backplate.")]
public BoolParameter enableBackplate

Field Value

Type	Description
UnityEngine.Rendering.BoolParameter

enableDistortion

Obsolete field. Use distortionMode

Declaration

[SerializeField]
[Obsolete("For Data Migration")]
public BoolParameter enableDistortion

Field Value

Type	Description
UnityEngine.Rendering.BoolParameter

flowmap

Texture used to distort the uv for the HDRI sky.

Declaration

[Tooltip("Specify the flowmap HDRP uses for sky distortion (in LatLong layout).")]
public TextureParameter flowmap

Field Value

Type	Description
UnityEngine.Rendering.TextureParameter

groundLevel

Define the ground level of the Backplate.

Declaration

[AdditionalProperty]
[Tooltip("Define the ground level of the Backplate.")]
public FloatParameter groundLevel

Field Value

Type	Description
UnityEngine.Rendering.FloatParameter

hdriSky

Cubemap used to render the HDRI sky.

Declaration

[Tooltip("Specify the cubemap HDRP uses to render the sky.")]
public CubemapParameter hdriSky

Field Value

Type	Description
UnityEngine.Rendering.CubemapParameter

k_Migration

Migration steps

Declaration

protected static readonly MigrationDescription<HDRISky.Version, HDRISky> k_Migration

Field Value

Type	Description
MigrationDescription<HDRISky.Version, HDRISky>

plateRotation

Backplate rotation parameter for the geometry.

Declaration

[AdditionalProperty]
[Tooltip("Backplate rotation parameter for the geometry.")]
public ClampedFloatParameter plateRotation

Field Value

Type	Description
UnityEngine.Rendering.ClampedFloatParameter

plateTexOffset

Backplate projection offset on the plane.

Declaration

[AdditionalProperty]
[Tooltip("Backplate projection offset on the plane.")]
public Vector2Parameter plateTexOffset

Field Value

Type	Description
UnityEngine.Rendering.Vector2Parameter

plateTexRotation

Backplate rotation parameter for the projected texture.

Declaration

[AdditionalProperty]
[Tooltip("Backplate rotation parameter for the projected texture.")]
public ClampedFloatParameter plateTexRotation

Field Value

Type	Description
UnityEngine.Rendering.ClampedFloatParameter

pointLightShadow

Allow backplate to receive shadow from point light.

Declaration

[AdditionalProperty]
[Tooltip("Allow backplate to receive shadow from point light.")]
public BoolParameter pointLightShadow

Field Value

Type	Description
UnityEngine.Rendering.BoolParameter

procedural

Obsolete field. Use distortionMode

Declaration

[SerializeField]
[Obsolete("For Data Migration")]
public BoolParameter procedural

Field Value

Type	Description
UnityEngine.Rendering.BoolParameter

projectionDistance

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

Declaration

[AdditionalProperty]
[Tooltip("Backplate's projection distance to varying the cubemap projection on the plate.")]
public MinFloatParameter projectionDistance

Field Value

Type	Description
UnityEngine.Rendering.MinFloatParameter

rectLightShadow

Allow backplate to receive shadow from Area light.

Declaration

[AdditionalProperty]
[Tooltip("Allow backplate to receive shadow from Area light.")]
public BoolParameter rectLightShadow

Field Value

Type	Description
UnityEngine.Rendering.BoolParameter

scale

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

Declaration

[AdditionalProperty]
[Tooltip("Extent of the Backplate (if circle only the X value is considered).")]
public Vector2Parameter scale

Field Value

Type	Description
UnityEngine.Rendering.Vector2Parameter

scrollDirection

Obsolete field. Use scrollOrientation

Declaration

[SerializeField]
[Obsolete("For Data Migration")]
public ClampedFloatParameter scrollDirection

Field Value

Type	Description
UnityEngine.Rendering.ClampedFloatParameter

scrollOrientation

Direction of the distortion. This value can be relative to the Global Wind Orientation defined in the Visual Environment.

Declaration

public WindOrientationParameter scrollOrientation

Field Value

Type	Description
WindOrientationParameter

scrollSpeed

Speed of the distortion. This value can be relative to the Global Wind Speed defined in the Visual Environment.

Declaration

public WindSpeedParameter scrollSpeed

Field Value

Type	Description
WindSpeedParameter

shadowTint

Backplate Shadow Tint projected on the plane.

Declaration

[AdditionalProperty]
[Tooltip("Backplate Shadow Tint projected on the plane.")]
public ColorParameter shadowTint

Field Value

Type	Description
UnityEngine.Rendering.ColorParameter

upperHemisphereOnly

Enable to affect only the upper part of the sky.

Declaration

[Tooltip("Check this box if the flowmap covers only the upper part of the sky.")]
public BoolParameter upperHemisphereOnly

Field Value

Type	Description
UnityEngine.Rendering.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)

Explicit Interface Implementations

IVersionable<HDRISky.Version>.version

Declaration

HDRISky.Version IVersionable<HDRISky.Version>.version { get; set; }

Returns

Type	Description
HDRISky.Version

Implements

IVersionable<TVersion>.version