Class LightUtils

Light Utils contains function to convert light intensities between units

Inheritance

Object

LightUtils

Namespace: UnityEngine.Rendering.HighDefinition

Syntax

public class LightUtils

Methods

CalculateAnglesForPyramid(Single, Single, out Single, out Single)

Calculate angles for the pyramid spot light to calculate it's intensity.

Declaration

public static void CalculateAnglesForPyramid(float aspectRatio, float spotAngle, out float angleA, out float angleB)

Parameters

Type	Name	Description
Single	aspectRatio
Single	spotAngle	angle in radian
Single	angleA
Single	angleB

CalculateLineLightLumenToLuminance(Single, Single)

Convert line light intensity in Lumen to Luminance(nits)

Declaration

public static float CalculateLineLightLumenToLuminance(float intensity, float lineWidth)

Parameters

Type	Name	Description
Single	intensity
Single	lineWidth

Returns

Type	Description
Single

CalculateLineLightLuminanceToLumen(Single, Single)

Convert a line light intensity in Luminance(nits) to Lumen

Declaration

public static float CalculateLineLightLuminanceToLumen(float intensity, float lineWidth)

Parameters

Type	Name	Description
Single	intensity
Single	lineWidth

Returns

Type	Description
Single

ConvertAreaLightEvToLumen(AreaLightShape, Single, Single, Single)

Convert area light intensity in EV100 to Lumen

Declaration

public static float ConvertAreaLightEvToLumen(AreaLightShape AreaLightShape, float ev, float width, float height)

Parameters

Type	Name	Description
AreaLightShape	AreaLightShape
Single	ev
Single	width
Single	height

Returns

Type	Description
Single

ConvertAreaLightLumenToEv(AreaLightShape, Single, Single, Single)

Convert area light intensity in Lumen to EV100

Declaration

public static float ConvertAreaLightLumenToEv(AreaLightShape AreaLightShape, float lumen, float width, float height)

Parameters

Type	Name	Description
AreaLightShape	AreaLightShape
Single	lumen
Single	width
Single	height

Returns

Type	Description
Single

ConvertAreaLightLumenToLuminance(AreaLightShape, Single, Single, Single)

Convert area light intensity in Lumen to Luminance(nits)

Declaration

public static float ConvertAreaLightLumenToLuminance(AreaLightShape areaLightShape, float lumen, float width, float height = 0F)

Parameters

Type	Name	Description
AreaLightShape	areaLightShape
Single	lumen
Single	width
Single	height

Returns

Type	Description
Single

ConvertAreaLightLuminanceToLumen(AreaLightShape, Single, Single, Single)

Convert area light intensity in Luminance(nits) to Lumen

Declaration

public static float ConvertAreaLightLuminanceToLumen(AreaLightShape areaLightShape, float luminance, float width, float height = 0F)

Parameters

Type	Name	Description
AreaLightShape	areaLightShape
Single	luminance
Single	width
Single	height

Returns

Type	Description
Single

ConvertCandelaToEv(Single)

Convert Candela to EV100

Declaration

public static float ConvertCandelaToEv(float candela)

Parameters

Type	Name	Description
Single	candela

Returns

Type	Description
Single

ConvertCandelaToLux(Single, Single)

Convert intensity in Candela at a certain distance in Lux.

Declaration

public static float ConvertCandelaToLux(float candela, float distance)

Parameters

Type	Name	Description
Single	candela
Single	distance

Returns

Type	Description
Single

ConvertDiscLightLumenToLuminance(Single, Single)

Convert an intensity in Lumen to Luminance(nits) for a disc light.

Declaration

public static float ConvertDiscLightLumenToLuminance(float intensity, float discRadius)

Parameters

Type	Name	Description
Single	intensity
Single	discRadius

Returns

Type	Description
Single

ConvertDiscLightLuminanceToLumen(Single, Single)

Convert an intensity in Luminance(nits) to Lumen for a disc light.

Declaration

public static float ConvertDiscLightLuminanceToLumen(float intensity, float discRadius)

Parameters

Type	Name	Description
Single	intensity
Single	discRadius

Returns

Type	Description
Single

ConvertEvToCandela(Single)

Convert EV100 to Candela

Declaration

public static float ConvertEvToCandela(float ev)

Parameters

Type	Name	Description
Single	ev

Returns

Type	Description
Single

ConvertEvToLuminance(Single)

Convert EV100 to Luminance(nits)

Declaration

public static float ConvertEvToLuminance(float ev)

Parameters

Type	Name	Description
Single	ev

Returns

Type	Description
Single

ConvertEvToLux(Single, Single)

Convert EV100 to Lux at a certain distance

Declaration

public static float ConvertEvToLux(float ev, float distance)

Parameters

Type	Name	Description
Single	ev
Single	distance

Returns

Type	Description
Single

ConvertFrustrumLightCandelaToLumen(Single, Single, Single)

Convert an intensity in Candela to Lumen for a pyramid spot light.

Declaration

public static float ConvertFrustrumLightCandelaToLumen(float intensity, float angleA, float angleB)

Parameters

Type	Name	Description
Single	intensity
Single	angleA	Full opening angle in radian
Single	angleB	Full opening angle in radian

Returns

Type	Description
Single

ConvertFrustrumLightLumenToCandela(Single, Single, Single)

Convert an intensity in Lumen to Candela for a pyramid spot light.

Declaration

public static float ConvertFrustrumLightLumenToCandela(float intensity, float angleA, float angleB)

Parameters

Type	Name	Description
Single	intensity
Single	angleA	Full opening angle in radian
Single	angleB	Full opening angle in radian

Returns

Type	Description
Single

ConvertLuminanceToEv(Single)

Convert Luminance(nits) to EV100

Declaration

public static float ConvertLuminanceToEv(float luminance)

Parameters

Type	Name	Description
Single	luminance

Returns

Type	Description
Single

ConvertLuxToCandela(Single, Single)

Convert intensity in Lux at a certain distance in Candela.

Declaration

public static float ConvertLuxToCandela(float lux, float distance)

Parameters

Type	Name	Description
Single	lux
Single	distance

Returns

Type	Description
Single

ConvertLuxToEv(Single, Single)

Convert Lux at a certain distance to EV100

Declaration

public static float ConvertLuxToEv(float lux, float distance)

Parameters

Type	Name	Description
Single	lux
Single	distance

Returns

Type	Description
Single

ConvertPointLightCandelaToLumen(Single)

Convert an intensity in Candela to Lumen for a point light

Declaration

public static float ConvertPointLightCandelaToLumen(float intensity)

Parameters

Type	Name	Description
Single	intensity

Returns

Type	Description
Single

ConvertPointLightLumenToCandela(Single)

Convert an intensity in Lumen to Candela for a point light

Declaration

public static float ConvertPointLightLumenToCandela(float intensity)

Parameters

Type	Name	Description
Single	intensity

Returns

Type	Description
Single

ConvertPunctualLightCandelaToLumen(HDLightType, SpotLightShape, Single, Boolean, Single, Single)

Convert a punctual light intensity in Candela to Lumen

Declaration

public static float ConvertPunctualLightCandelaToLumen(HDLightType lightType, SpotLightShape spotLightShape, float candela, bool enableSpotReflector, float spotAngle, float aspectRatio)

Parameters

Type	Name	Description
HDLightType	lightType
SpotLightShape	spotLightShape
Single	candela
Boolean	enableSpotReflector
Single	spotAngle
Single	aspectRatio

Returns

Type	Description
Single

ConvertPunctualLightEvToLumen(HDLightType, SpotLightShape, Single, Boolean, Single, Single)

Convert a punctual light intensity in EV100 to Lumen. This is not physically correct but it's handy to have EV100 for punctual lights.

Declaration

public static float ConvertPunctualLightEvToLumen(HDLightType lightType, SpotLightShape spotLightShape, float ev, bool enableSpotReflector, float spotAngle, float aspectRatio)

Parameters

Type	Name	Description
HDLightType	lightType
SpotLightShape	spotLightShape
Single	ev
Boolean	enableSpotReflector
Single	spotAngle
Single	aspectRatio

Returns

Type	Description
Single

ConvertPunctualLightLumenToCandela(HDLightType, Single, Single, Boolean)

Convert a punctual light intensity in Lumen to Candela

Declaration

public static float ConvertPunctualLightLumenToCandela(HDLightType lightType, float lumen, float initialIntensity, bool enableSpotReflector)

Parameters

Type	Name	Description
HDLightType	lightType
Single	lumen
Single	initialIntensity
Boolean	enableSpotReflector

Returns

Type	Description
Single

ConvertPunctualLightLumenToEv(HDLightType, Single, Single, Boolean)

Convert a punctual light intensity in Lumen to EV100. This is not physically correct but it's handy to have EV100 for punctual lights.

Declaration

public static float ConvertPunctualLightLumenToEv(HDLightType lightType, float lumen, float initialIntensity, bool enableSpotReflector)

Parameters

Type	Name	Description
HDLightType	lightType
Single	lumen
Single	initialIntensity
Boolean	enableSpotReflector

Returns

Type	Description
Single

ConvertPunctualLightLumenToLux(HDLightType, Single, Single, Boolean, Single)

Convert a punctual light intensity in Lumen to Lux

Declaration

public static float ConvertPunctualLightLumenToLux(HDLightType lightType, float lumen, float initialIntensity, bool enableSpotReflector, float distance)

Parameters

Type	Name	Description
HDLightType	lightType
Single	lumen
Single	initialIntensity
Boolean	enableSpotReflector
Single	distance

Returns

Type	Description
Single

ConvertPunctualLightLuxToLumen(HDLightType, SpotLightShape, Single, Boolean, Single, Single, Single)

Convert a punctual light intensity in Lux to Lumen

Declaration

public static float ConvertPunctualLightLuxToLumen(HDLightType lightType, SpotLightShape spotLightShape, float lux, bool enableSpotReflector, float spotAngle, float aspectRatio, float distance)

Parameters

Type	Name	Description
HDLightType	lightType
SpotLightShape	spotLightShape
Single	lux
Boolean	enableSpotReflector
Single	spotAngle
Single	aspectRatio
Single	distance

Returns

Type	Description
Single

ConvertRectLightLumenToLuminance(Single, Single, Single)

Convert an intensity in Lumen to Luminance(nits) for a rectangular light.

Declaration

public static float ConvertRectLightLumenToLuminance(float intensity, float width, float height)

Parameters

Type	Name	Description
Single	intensity
Single	width
Single	height

Returns

Type	Description
Single

ConvertRectLightLuminanceToLumen(Single, Single, Single)

Convert an intensity in Luminance(nits) to Lumen for a rectangular light.

Declaration

public static float ConvertRectLightLuminanceToLumen(float intensity, float width, float height)

Parameters

Type	Name	Description
Single	intensity
Single	width
Single	height

Returns

Type	Description
Single

ConvertSphereLightLumenToLuminance(Single, Single)

Convert an intensity in Lumen to Luminance(nits) for a sphere light.

Declaration

public static float ConvertSphereLightLumenToLuminance(float intensity, float sphereRadius)

Parameters

Type	Name	Description
Single	intensity
Single	sphereRadius

Returns

Type	Description
Single

ConvertSphereLightLuminanceToLumen(Single, Single)

Convert an intensity in Luminance(nits) to Lumen for a sphere light.

Declaration

public static float ConvertSphereLightLuminanceToLumen(float intensity, float sphereRadius)

Parameters

Type	Name	Description
Single	intensity
Single	sphereRadius

Returns

Type	Description
Single

ConvertSpotLightCandelaToLumen(Single, Single, Boolean)

Convert an intensity in Candela to Lumen for a cone pot light.

Declaration

public static float ConvertSpotLightCandelaToLumen(float intensity, float angle, bool exact)

Parameters

Type	Name	Description
Single	intensity
Single	angle	Full angle in radian
Boolean	exact	Exact computation or an approximation

Returns

Type	Description
Single

ConvertSpotLightLumenToCandela(Single, Single, Boolean)

Convert an intensity in Lumen to Candela for a cone spot light.

Declaration

public static float ConvertSpotLightLumenToCandela(float intensity, float angle, bool exact)

Parameters

Type	Name	Description
Single	intensity
Single	angle	Full angle in radian
Boolean	exact	Exact computation or an approximation

Returns

Type	Description
Single