Class HDRISky

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

Inheritance

object

Object

ScriptableObject

VolumeComponent

SkySettings

HDRISky

Implements

IApplyRevertPropertyContextMenuItemProvider

IVersionable<HDRISky.Version>

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()

VolumeComponent.active

VolumeComponent.displayName

VolumeComponent.parameters

VolumeComponent.OnDisable()

VolumeComponent.Override(VolumeComponent, float)

VolumeComponent.SetAllOverridesTo(bool)

VolumeComponent.AnyPropertiesIsOverridden()

VolumeComponent.OnDestroy()

VolumeComponent.Release()

VolumeComponent.TryGetRevertMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)

VolumeComponent.GetSourceTerm()

VolumeComponent.TryGetApplyMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)

VolumeComponent.GetSourceName(Component)

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

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

Name	Description
backplateType	Backplate Type {Disc, Rectangle, Ellipse, Infinite (Plane)}.
blendAmount	Backplate blend parameter to blend the edge of the backplate with the background.
dirLightShadow	Allow backplate to receive shadow from directional light.
distortionMode	Distortion mode.
enableBackplate	Enable Backplate to have it visible.
enableDistortion	Obsolete field. Use distortionMode
flowmap	Texture used to distort the uv for the HDRI sky.
groundLevel	Define the ground level of the Backplate.
hdriSky	Cubemap used to render the HDRI sky.
k_Migration	Migration steps
plateRotation	Backplate rotation parameter for the geometry.
plateTexOffset	Backplate projection offset on the plane.
plateTexRotation	Backplate rotation parameter for the projected texture.
pointLightShadow	Allow backplate to receive shadow from point light.
procedural	Obsolete field. Use distortionMode
projectionDistance	Backplate's projection distance to varying the cubemap projection on the plate.
rectLightShadow	Allow backplate to receive shadow from Area light.
scale	Extent of the Backplate (if circle only the X value is considered).
scrollDirection	Obsolete field. Use scrollOrientation
scrollOrientation	Direction of the distortion. This value can be relative to the Global Wind Orientation defined in the Visual Environment.
scrollSpeed	Speed of the distortion. This value can be relative to the Global Wind Speed defined in the Visual Environment.
shadowTint	Backplate Shadow Tint projected on the plane.
upperHemisphereOnly	Enable to affect only the upper part of the sky.

Methods

Name	Description
GetHashCode()	Returns the hash code of the HDRI sky parameters.
GetSkyRendererType()	Returns HDRISkyRenderer type.
OnEnable()	Unity calls this method when it loads the class.
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.