Class HDRISky
HDRI Sky Volume Component. This component setups HDRI sky for rendering.
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Syntax
[SkyUniqueID(1)]
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 | 
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 | 
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 | 
shadowTint
Backplate Shadow Tint projected on the plane.
Declaration
public ColorParameter shadowTint
Field Value
| Type | Description | 
|---|---|
| ColorParameter | 
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.  |