Class HDRISky
HDRI Sky Volume Component. This component setups HDRI sky for rendering.
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
[VolumeComponentMenu("Sky/HDRI Sky")]
[SupportedOnRenderPipeline(typeof(HDRenderPipelineAsset))]
[SkyUniqueID(1)]
public class HDRISky : SkySettings, IApplyRevertPropertyContextMenuItemProvider, IVersionable<HDRISky.Version>
Fields
backplateType
Backplate Type {Disc, Rectangle, Ellipse, Infinite (Plane)}.
Declaration
[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
[Tooltip("Backplate blend parameter to blend the edge of the backplate with the background.")]
public ClampedFloatParameter blendAmount
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
dirLightShadow
Allow backplate to receive shadow from directional light.
Declaration
[Tooltip("Allow backplate to receive shadow from directional light.")]
public BoolParameter dirLightShadow
Field Value
Type | Description |
---|---|
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 |
---|---|
VolumeParameter<HDRISky.DistortionMode> |
enableBackplate
Enable Backplate to have it visible.
Declaration
[Tooltip("Enable or disable the backplate.")]
public BoolParameter enableBackplate
Field Value
Type | Description |
---|---|
BoolParameter |
enableDistortion
Obsolete field. Use distortionMode
Declaration
[SerializeField]
[Obsolete("For Data Migration")]
public BoolParameter enableDistortion
Field Value
Type | Description |
---|---|
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 Texture2DParameter flowmap
Field Value
Type | Description |
---|---|
Texture2DParameter |
groundLevel
Define the ground level of the Backplate.
Declaration
[Tooltip("Define the ground level of the Backplate.")]
public FloatParameter groundLevel
Field Value
Type | Description |
---|---|
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 |
---|---|
CubemapParameter |
k_Migration
Migration steps
Declaration
protected static readonly MigrationDescription<HDRISky.Version, HDRISky> k_Migration
Field Value
Type | Description |
---|---|
MigrationDescription<HDRISky.Version, HDRISky> |
lockSun
Locks the sun to the backplate rotation
Declaration
[Tooltip("Enable to have the sun locked to the rotation")]
public BoolParameter lockSun
Field Value
Type | Description |
---|---|
BoolParameter |
plateRotation
Backplate rotation parameter for the geometry.
Declaration
[Tooltip("Backplate rotation parameter for the geometry.")]
public ClampedFloatParameter plateRotation
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
plateTexOffset
Backplate projection offset on the plane.
Declaration
[Tooltip("Backplate projection offset on the plane.")]
public Vector2Parameter plateTexOffset
Field Value
Type | Description |
---|---|
Vector2Parameter |
plateTexRotation
Backplate rotation parameter for the projected texture.
Declaration
[Tooltip("Backplate rotation parameter for the projected texture.")]
public ClampedFloatParameter plateTexRotation
Field Value
Type | Description |
---|---|
ClampedFloatParameter |
pointLightShadow
Allow backplate to receive shadow from point light.
Declaration
[Tooltip("Allow backplate to receive shadow from point light.")]
public BoolParameter pointLightShadow
Field Value
Type | Description |
---|---|
BoolParameter |
procedural
Obsolete field. Use distortionMode
Declaration
[SerializeField]
[Obsolete("For Data Migration")]
public BoolParameter procedural
Field Value
Type | Description |
---|---|
BoolParameter |
projectionDistance
Backplate's projection distance to varying the cubemap projection on the plate.
Declaration
[Tooltip("Backplate's projection distance to varying the cubemap projection on the plate.")]
public MinFloatParameter projectionDistance
Field Value
Type | Description |
---|---|
MinFloatParameter |
rectLightShadow
Allow backplate to receive shadow from Area light.
Declaration
[Tooltip("Allow backplate to receive shadow from Area light.")]
public BoolParameter rectLightShadow
Field Value
Type | Description |
---|---|
BoolParameter |
scale
Extent of the Backplate (if circle only the X value is considered).
Declaration
[Tooltip("Extent of the Backplate (if circle only the X value is considered).")]
public Vector2Parameter scale
Field Value
Type | Description |
---|---|
Vector2Parameter |
scrollDirection
Obsolete field. Use scrollOrientation
Declaration
[SerializeField]
[Obsolete("For Data Migration")]
public ClampedFloatParameter scrollDirection
Field Value
Type | Description |
---|---|
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
[Tooltip("Backplate Shadow Tint projected on the plane.")]
public ColorParameter shadowTint
Field Value
Type | Description |
---|---|
ColorParameter |
sunInitialRotation
Sets the initial rotation of the sun to allow us to rotate the sun with the sky if the sun is locked
Declaration
public FloatParameter sunInitialRotation
Field Value
Type | Description |
---|---|
FloatParameter |
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 |
---|---|
BoolParameter |
Methods
GetHashCode()
Returns the hash code of the HDRI sky parameters.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
int | The hash code of the HDRI sky parameters. |
Overrides
GetSkyRendererType()
Returns HDRISkyRenderer type.
Declaration
public override Type GetSkyRendererType()
Returns
Type | Description |
---|---|
Type | HDRISkyRenderer type. |
Overrides
OnEnable()
Unity calls this method when it loads the class.
Declaration
protected override void OnEnable()
Overrides
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 |
---|---|
bool | Whether the settings are deemed very different. |