Class HDRISky

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

Inheritance
Object
VolumeComponent
SkySettings
HDRISky
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Syntax
[SkyUniqueID(1)]
public class HDRISky : SkySettings

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

enableBackplate

Enable Backplate to have it visible.

Declaration
[Tooltip("Enable or disable the backplate.")]
public BoolParameter enableBackplate
Field Value
Type Description
BoolParameter

enableDistortion

Enable to have sky distortion.

Declaration
[Tooltip("Enable or disable sky distortion.")]
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 TextureParameter flowmap
Field Value
Type Description
TextureParameter

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

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

Enable to have a simple, procedural distorsion.

Declaration
[Tooltip("If enabled, the sky will be distorted by a constant wind.")]
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

Direction of the distortion.

Declaration
[Tooltip("Sets the rotation of the distortion (in degrees).")]
public ClampedFloatParameter scrollDirection
Field Value
Type Description
ClampedFloatParameter

scrollSpeed

Speed of the distortion.

Declaration
[Tooltip("Sets the scrolling speed of the distortion.")]
public MinFloatParameter scrollSpeed
Field Value
Type Description
MinFloatParameter

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

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
Int32

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