Class PhysicallyBasedSky

Physically Based Sky Volume Component.

Inheritance

Object

UnityEngine.Rendering.VolumeComponent

SkySettings

PhysicallyBasedSky

Inherited Members

SkySettings.rotation

SkySettings.skyIntensityMode

SkySettings.exposure

SkySettings.multiplier

SkySettings.upperHemisphereLuxValue

SkySettings.upperHemisphereLuxColor

SkySettings.desiredLuxValue

SkySettings.updateMode

SkySettings.updatePeriod

SkySettings.includeSunInBaking

SkySettings.GetUniqueID<T>()

SkySettings.GetUniqueID(Type)

UnityEngine.Rendering.VolumeComponent.active

UnityEngine.Rendering.VolumeComponent.OnEnable()

UnityEngine.Rendering.VolumeComponent.OnDisable()

UnityEngine.Rendering.VolumeComponent.Override(UnityEngine.Rendering.VolumeComponent, System.Single)

UnityEngine.Rendering.VolumeComponent.SetAllOverridesTo(System.Boolean)

UnityEngine.Rendering.VolumeComponent.OnDestroy()

UnityEngine.Rendering.VolumeComponent.Release()

UnityEngine.Rendering.VolumeComponent.displayName

UnityEngine.Rendering.VolumeComponent.parameters

Namespace: UnityEngine.Rendering.HighDefinition

Syntax

[SkyUniqueID(4)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@10.3/manual/Override-Physically-Based-Sky.html")]
public class PhysicallyBasedSky : SkySettings, 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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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>

numberOfBounces

Number of scattering events.

Declaration

[Tooltip("Sets the number of scattering events. This increases the quality of the sky visuals but also increases the pre-computation time.")]
public ClampedIntParameter numberOfBounces

Field Value

Type	Description
UnityEngine.Rendering.ClampedIntParameter

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
UnityEngine.Rendering.MinFloatParameter

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
UnityEngine.Rendering.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
UnityEngine.Rendering.Vector3Parameter

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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.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
UnityEngine.Rendering.BoolParameter

type

Simplifies the interface by reducing the number of parameters available.

Declaration

public PhysicallyBasedSkyModelParameter type

Field Value

Type	Description
PhysicallyBasedSkyModelParameter

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
UnityEngine.Rendering.ColorParameter

Methods

GetHashCode()

Returns the hash code of the parameters of the sky.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	The hash code of the parameters of the sky.

Overrides

SkySettings.GetHashCode()

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
Int32	The hash code of the sky parameters.

Overrides

SkySettings.GetHashCode(Camera)

GetSkyRendererType()

Returns the type of the sky renderer.

Declaration

public override Type GetSkyRendererType()

Returns

Type	Description
Type	PhysicallyBasedSkyRenderer type.

Overrides

SkySettings.GetSkyRendererType()

Explicit Interface Implementations

IVersionable<PhysicallyBasedSky.Version>.version

Declaration

PhysicallyBasedSky.Version IVersionable<PhysicallyBasedSky.Version>.version { get; set; }

Returns

Type	Description
PhysicallyBasedSky.Version

Implements

IVersionable<TVersion>.version