Class PhysicallyBasedSky

Physically Based Sky Volume Component.

Inheritance
object
Object
ScriptableObject
VolumeComponent
SkySettings
PhysicallyBasedSky
Implements
Inherited Members
VolumeComponent.active
VolumeComponent.displayName
VolumeComponent.parameters
VolumeComponent.OnEnable()
VolumeComponent.OnDisable()
VolumeComponent.AnyPropertiesIsOverridden()
VolumeComponent.OnDestroy()
VolumeComponent.Release()
VolumeComponent.GetSourceTerm()
ScriptableObject.SetDirty()
ScriptableObject.CreateInstance<T>()
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
[VolumeComponentMenu("Sky/Physically Based Sky")]
[SupportedOnRenderPipeline(typeof(HDRenderPipelineAsset))]
[SkyUniqueID(4)]
public class PhysicallyBasedSky : SkySettings, IApplyRevertPropertyContextMenuItemProvider, IVersionable<PhysicallyBasedSky.Version>

Fields

aerosolAnisotropy

Positive values for forward scattering, 0 for isotropic scattering. negative values for backward scattering.

Declaration
[Tooltip("Controls the direction of anisotropy. Set this to a positive value for forward scattering, a negative value for backward scattering, or 0 for isotropic scattering.")]
public ClampedFloatParameter aerosolAnisotropy
Field Value
Type Description
ClampedFloatParameter

aerosolDensity

Opacity of aerosols as measured by an observer on the ground looking towards the zenith.

Declaration
[Tooltip("Controls the opacity of aerosols at the point in the sky directly above the observer (zenith).")]
public ClampedFloatParameter aerosolDensity
Field Value
Type Description
ClampedFloatParameter

aerosolMaximumAltitude

Depth of the atmospheric layer (from the sea level) composed of aerosol particles. Controls the rate of height-based density falloff. Units: meters.

Declaration
[Tooltip("Sets the depth, in meters, of the atmospheric layer, from sea level, composed of aerosol particles. Controls the rate of height-based density falloff.")]
public MinFloatParameter aerosolMaximumAltitude
Field Value
Type Description
MinFloatParameter

aerosolTint

Single scattering albedo of aerosol molecules (per color channel). The value of 0 results in absorbing molecules, and the value of 1 results in scattering ones.

Declaration
[Tooltip("Specifies the color that HDRP tints aerosols to. This controls the single scattering albedo of aerosol molecules (per color channel). A value of 0 results in absorbing molecules, and a value of 1 results in scattering ones.")]
public ColorParameter aerosolTint
Field Value
Type Description
ColorParameter

airDensityB

Opacity (per color channel) of air as measured by an observer on the ground looking towards the zenith.

Declaration
[Tooltip("Controls the blue color channel opacity of air at the point in the sky directly above the observer (zenith).")]
public ClampedFloatParameter airDensityB
Field Value
Type Description
ClampedFloatParameter

airDensityG

Opacity (per color channel) of air as measured by an observer on the ground looking towards the zenith.

Declaration
[Tooltip("Controls the green color channel opacity of air at the point in the sky directly above the observer (zenith).")]
public ClampedFloatParameter airDensityG
Field Value
Type Description
ClampedFloatParameter

airDensityR

Opacity (per color channel) of air as measured by an observer on the ground looking towards the zenith.

Declaration
[Tooltip("Controls the red color channel opacity of air at the point in the sky directly above the observer (zenith).")]
public ClampedFloatParameter airDensityR
Field Value
Type Description
ClampedFloatParameter

airMaximumAltitude

Depth of the atmospheric layer (from the sea level) composed of air particles. Controls the rate of height-based density falloff. Units: meters.

Declaration
[Tooltip("Sets the depth, in meters, of the atmospheric layer, from sea level, composed of air particles. Controls the rate of height-based density falloff.")]
public MinFloatParameter airMaximumAltitude
Field Value
Type Description
MinFloatParameter

airTint

Single scattering albedo of air molecules (per color channel). The value of 0 results in absorbing molecules, and the value of 1 results in scattering ones.

Declaration
[Tooltip("Specifies the color that HDRP tints the air to. This controls the single scattering albedo of air molecules (per color channel). A value of 0 results in absorbing molecules, and a value of 1 results in scattering ones.")]
public ColorParameter airTint
Field Value
Type Description
ColorParameter

alphaMultiplier

Opacity multiplier. Does not affect the precomputation.

Declaration
[Tooltip("Sets the multiplier that HDRP applies to the opacity of the sky. Does not affect the precomputation.")]
public ClampedFloatParameter alphaMultiplier
Field Value
Type Description
ClampedFloatParameter

alphaSaturation

Opacity saturation. Does not affect the precomputation.

Declaration
[Tooltip("Controls the saturation of the sky opacity. Does not affect the precomputation.")]
public ClampedFloatParameter alphaSaturation
Field Value
Type Description
ClampedFloatParameter

colorSaturation

Color saturation. Does not affect the precomputation.

Declaration
[Tooltip("Controls the saturation of the sky color. Does not affect the precomputation.")]
public ClampedFloatParameter colorSaturation
Field Value
Type Description
ClampedFloatParameter

groundColorTexture

Ground color texture. Does not affect the precomputation.

Declaration
[Tooltip("Specifies a Texture that represents the planet's surface. Does not affect the precomputation.")]
public CubemapParameter groundColorTexture
Field Value
Type Description
CubemapParameter

groundEmissionMultiplier

Ground emission multiplier. Does not affect the precomputation.

Declaration
[Tooltip("Sets the multiplier that HDRP applies to the Ground Emission Texture.")]
public MinFloatParameter groundEmissionMultiplier
Field Value
Type Description
MinFloatParameter

groundEmissionTexture

Ground emission texture. Does not affect the precomputation.

Declaration
[Tooltip("Specifies a Texture that represents the emissive areas of the planet's surface. Does not affect the precomputation.")]
public CubemapParameter groundEmissionTexture
Field Value
Type Description
CubemapParameter

groundTint

Ground tint.

Declaration
[Tooltip("Specifies a color that HDRP uses to tint the Ground Color Texture.")]
public ColorParameter groundTint
Field Value
Type Description
ColorParameter

horizonTint

Horizon tint. Does not affect the precomputation.

Declaration
[Tooltip("Specifies a color that HDRP uses to tint the sky at the horizon. Does not affect the precomputation.")]
public ColorParameter horizonTint
Field Value
Type Description
ColorParameter

horizonZenithShift

Horizon-zenith shift. Does not affect the precomputation.

Declaration
[Tooltip("Controls how HDRP blends between the Horizon Tint and Zenith Tint. Does not affect the precomputation.")]
public ClampedFloatParameter horizonZenithShift
Field Value
Type Description
ClampedFloatParameter

k_Migration

The migration steps for PhysicallyBasedSky

Declaration
protected static readonly MigrationDescription<PhysicallyBasedSky.Version, PhysicallyBasedSky> k_Migration
Field Value
Type Description
MigrationDescription<PhysicallyBasedSky.Version, PhysicallyBasedSky>

material

The material used for sky rendering.

Declaration
[Tooltip("The material used to render the sky. It is recommended to use the **Physically Based Sky** Material type of ShaderGraph.")]
public MaterialParameter material
Field Value
Type Description
MaterialParameter

numberOfBounces

Doesn't have any effect.

Declaration
[SerializeField]
[Obsolete("Obsolete parameter, will be removed in 2023.3")]
public ClampedIntParameter numberOfBounces
Field Value
Type Description
ClampedIntParameter

planetCenterPosition

Position of the center of the planet in the world space. Units: meters. Does not affect the precomputation.

Declaration
[Tooltip("Sets the world-space position of the planet's center in meters.")]
public Vector3Parameter planetCenterPosition
Field Value
Type Description
Vector3Parameter

planetRotation

Rotation of the planet. Does not affect the precomputation.

Declaration
[Tooltip("Sets the orientation of the planet. Does not affect the precomputation.")]
public Vector3Parameter planetRotation
Field Value
Type Description
Vector3Parameter

planetaryRadius

Radius of the planet (distance from the center of the planet to the sea level). Units: meters.

Declaration
[Tooltip("Sets the radius of the planet in meters. This is distance from the center of the planet to the sea level.")]
public MinFloatParameter planetaryRadius
Field Value
Type Description
MinFloatParameter

renderingMode

Use the default shader or a custom material to render the atmosphere.

Declaration
[Tooltip("Indicates wether HDRP should use the default shader with the textures set on the profile or a custom material to render the planet and space.")]
public EnumParameter<PhysicallyBasedSky.RenderingMode> renderingMode
Field Value
Type Description
EnumParameter<PhysicallyBasedSky.RenderingMode>

seaLevel

World-space Y coordinate of the sea level of the planet. Units: meters.

Declaration
[Tooltip("Sets the world-space y coordinate of the planet's sea level in meters.")]
public FloatParameter seaLevel
Field Value
Type Description
FloatParameter

spaceEmissionMultiplier

Space emission multiplier. Does not affect the precomputation.

Declaration
[Tooltip("Sets the multiplier that HDRP applies to the Space Emission Texture. Does not affect the precomputation.")]
public MinFloatParameter spaceEmissionMultiplier
Field Value
Type Description
MinFloatParameter

spaceEmissionTexture

Space emission texture. Does not affect the precomputation.

Declaration
[Tooltip("Specifies a Texture that represents the emissive areas of space. Does not affect the precomputation.")]
public CubemapParameter spaceEmissionTexture
Field Value
Type Description
CubemapParameter

spaceRotation

Rotation of space. Does not affect the precomputation.

Declaration
[Tooltip("Sets the orientation of space. Does not affect the precomputation.")]
public Vector3Parameter spaceRotation
Field Value
Type Description
Vector3Parameter

sphericalMode

Allows to specify the location of the planet. If disabled, the planet is always below the camera in the world-space X-Z plane.

Declaration
[Tooltip("When enabled, you can define the planet in terms of a world-space position and radius. Otherwise, the planet is always below the Camera in the world-space x-z plane.")]
public BoolParameter sphericalMode
Field Value
Type Description
BoolParameter

type

Simplifies the interface by reducing the number of parameters available.

Declaration
[Tooltip("Indicates a preset HDRP uses to simplify the Inspector.")]
public EnumParameter<PhysicallyBasedSkyModel> type
Field Value
Type Description
EnumParameter<PhysicallyBasedSkyModel>

zenithTint

Zenith tint. Does not affect the precomputation.

Declaration
[Tooltip("Specifies a color that HDRP uses to tint the point in the sky directly above the observer (the zenith). Does not affect the precomputation.")]
public ColorParameter zenithTint
Field Value
Type Description
ColorParameter

Methods

GetHashCode()

Returns the hash code of the parameters of the sky.

Declaration
public override int GetHashCode()
Returns
Type Description
int

The hash code of the parameters of the sky.
Overrides

GetHashCode(Camera)

Returns the hash code of the sky parameters.

Declaration
public override int GetHashCode(Camera camera)
Parameters
Type Name Description
Camera camera

The camera we want to use to compute the hash of the sky.
Returns
Type Description
int

The hash code of the sky parameters.
Overrides

GetSkyRendererType()

Returns the type of the sky renderer.

Declaration
public override Type GetSkyRendererType()
Returns
Type Description
Type

PhysicallyBasedSkyRenderer type.
Overrides

Implements