Class PhysicallyBasedSky

Physically Based Sky Volume Component.

Inheritance

Object

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)

SkySettings.GetIntensityFromSettings()

SkySettings.SignificantlyDivergesFrom(SkySettings)

Namespace: UnityEngine.Rendering.HighDefinition

Syntax

public class PhysicallyBasedSky : SkySettings, IVersionable<PhysicallyBasedSky.Version>

Fields

aerosolAnisotropy

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

Declaration

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

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

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

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

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

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

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

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

public ColorParameter airTint

Field Value

Type	Description
ColorParameter

alphaMultiplier

Opacity multiplier. Does not affect the precomputation.

Declaration

public ClampedFloatParameter alphaMultiplier

Field Value

Type	Description
ClampedFloatParameter

alphaSaturation

Opacity saturation. Does not affect the precomputation.

Declaration

public ClampedFloatParameter alphaSaturation

Field Value

Type	Description
ClampedFloatParameter

colorSaturation

Color saturation. Does not affect the precomputation.

Declaration

public ClampedFloatParameter colorSaturation

Field Value

Type	Description
ClampedFloatParameter

groundColorTexture

Ground color texture. Does not affect the precomputation.

Declaration

public CubemapParameter groundColorTexture

Field Value

Type	Description
CubemapParameter

groundEmissionMultiplier

Ground emission multiplier. Does not affect the precomputation.

Declaration

public MinFloatParameter groundEmissionMultiplier

Field Value

Type	Description
MinFloatParameter

groundEmissionTexture

Ground emission texture. Does not affect the precomputation.

Declaration

public CubemapParameter groundEmissionTexture

Field Value

Type	Description
CubemapParameter

groundTint

Ground tint.

Declaration

public ColorParameter groundTint

Field Value

Type	Description
ColorParameter

horizonTint

Horizon tint. Does not affect the precomputation.

Declaration

public ColorParameter horizonTint

Field Value

Type	Description
ColorParameter

horizonZenithShift

Horizon-zenith shift. Does not affect the precomputation.

Declaration

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>

numberOfBounces

Number of scattering events.

Declaration

public ClampedIntParameter numberOfBounces

Field Value

Type	Description
ClampedIntParameter

planetaryRadius

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

Declaration

public MinFloatParameter planetaryRadius

Field Value

Type	Description
MinFloatParameter

planetCenterPosition

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

Declaration

public Vector3Parameter planetCenterPosition

Field Value

Type	Description
Vector3Parameter

planetRotation

Rotation of the planet. Does not affect the precomputation.

Declaration

public Vector3Parameter planetRotation

Field Value

Type	Description
Vector3Parameter

seaLevel

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

Declaration

public FloatParameter seaLevel

Field Value

Type	Description
FloatParameter

spaceEmissionMultiplier

Space emission multiplier. Does not affect the precomputation.

Declaration

public MinFloatParameter spaceEmissionMultiplier

Field Value

Type	Description
MinFloatParameter

spaceEmissionTexture

Space emission texture. Does not affect the precomputation.

Declaration

public CubemapParameter spaceEmissionTexture

Field Value

Type	Description
CubemapParameter

spaceRotation

Rotation of space. Does not affect the precomputation.

Declaration

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

public BoolParameter sphericalMode

Field Value

Type	Description
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

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