Class LightUtils | High Definition RP | 6.7.1-preview
docs.unity3d.com
    Show / Hide Table of Contents

    Class LightUtils

    Inheritance
    Object
    LightUtils
    Namespace: UnityEngine.Experimental.Rendering.HDPipeline
    Syntax
    public class LightUtils

    Methods

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

    Declaration
    public static void CalculateAnglesForPyramid(float aspectRatio, float spotAngle, out float angleA, out float angleB)
    Parameters
    Type Name Description
    Single aspectRatio
    Single spotAngle
    Single angleA
    Single angleB

    CalculateLineLightLumenToLuminance(Single, Single)

    Declaration
    public static float CalculateLineLightLumenToLuminance(float intensity, float lineWidth)
    Parameters
    Type Name Description
    Single intensity
    Single lineWidth
    Returns
    Type Description
    Single

    CalculateLineLightLuminanceToLumen(Single, Single)

    Declaration
    public static float CalculateLineLightLuminanceToLumen(float intensity, float lineWidth)
    Parameters
    Type Name Description
    Single intensity
    Single lineWidth
    Returns
    Type Description
    Single

    ConvertAreaLightEvToLumen(LightTypeExtent, Single, Single, Single)

    Declaration
    public static float ConvertAreaLightEvToLumen(LightTypeExtent areaLightType, float ev, float width, float height)
    Parameters
    Type Name Description
    LightTypeExtent areaLightType
    Single ev
    Single width
    Single height
    Returns
    Type Description
    Single

    ConvertAreaLightLumenToEv(LightTypeExtent, Single, Single, Single)

    Declaration
    public static float ConvertAreaLightLumenToEv(LightTypeExtent areaLightType, float lumen, float width, float height)
    Parameters
    Type Name Description
    LightTypeExtent areaLightType
    Single lumen
    Single width
    Single height
    Returns
    Type Description
    Single

    ConvertAreaLightLumenToLuminance(LightTypeExtent, Single, Single, Single)

    Declaration
    public static float ConvertAreaLightLumenToLuminance(LightTypeExtent areaLightType, float lumen, float width, float height = 0F)
    Parameters
    Type Name Description
    LightTypeExtent areaLightType
    Single lumen
    Single width
    Single height
    Returns
    Type Description
    Single

    ConvertAreaLightLuminanceToLumen(LightTypeExtent, Single, Single, Single)

    Declaration
    public static float ConvertAreaLightLuminanceToLumen(LightTypeExtent areaLightType, float luminance, float width, float height = 0F)
    Parameters
    Type Name Description
    LightTypeExtent areaLightType
    Single luminance
    Single width
    Single height
    Returns
    Type Description
    Single

    ConvertCandelaToEv(Single)

    Declaration
    public static float ConvertCandelaToEv(float candela)
    Parameters
    Type Name Description
    Single candela
    Returns
    Type Description
    Single

    ConvertCandelaToLux(Single, Single)

    Declaration
    public static float ConvertCandelaToLux(float candela, float distance)
    Parameters
    Type Name Description
    Single candela
    Single distance
    Returns
    Type Description
    Single

    ConvertDiscLightLumenToLuminance(Single, Single)

    Declaration
    public static float ConvertDiscLightLumenToLuminance(float intensity, float discRadius)
    Parameters
    Type Name Description
    Single intensity
    Single discRadius
    Returns
    Type Description
    Single

    ConvertDiscLightLuminanceToLumen(Single, Single)

    Declaration
    public static float ConvertDiscLightLuminanceToLumen(float intensity, float discRadius)
    Parameters
    Type Name Description
    Single intensity
    Single discRadius
    Returns
    Type Description
    Single

    ConvertEvToCandela(Single)

    Declaration
    public static float ConvertEvToCandela(float ev)
    Parameters
    Type Name Description
    Single ev
    Returns
    Type Description
    Single

    ConvertEvToLuminance(Single)

    Declaration
    public static float ConvertEvToLuminance(float ev)
    Parameters
    Type Name Description
    Single ev
    Returns
    Type Description
    Single

    ConvertEvToLux(Single, Single)

    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)

    Declaration
    public static float ConvertFrustrumLightCandelaToLumen(float intensity, float angleA, float angleB)
    Parameters
    Type Name Description
    Single intensity
    Single angleA
    Single angleB
    Returns
    Type Description
    Single

    ConvertFrustrumLightLumenToCandela(Single, Single, Single)

    Declaration
    public static float ConvertFrustrumLightLumenToCandela(float intensity, float angleA, float angleB)
    Parameters
    Type Name Description
    Single intensity
    Single angleA
    Single angleB
    Returns
    Type Description
    Single

    ConvertLuminanceToEv(Single)

    Declaration
    public static float ConvertLuminanceToEv(float luminance)
    Parameters
    Type Name Description
    Single luminance
    Returns
    Type Description
    Single

    ConvertLuxToCandela(Single, Single)

    Declaration
    public static float ConvertLuxToCandela(float lux, float distance)
    Parameters
    Type Name Description
    Single lux
    Single distance
    Returns
    Type Description
    Single

    ConvertLuxToEv(Single, Single)

    Declaration
    public static float ConvertLuxToEv(float lux, float distance)
    Parameters
    Type Name Description
    Single lux
    Single distance
    Returns
    Type Description
    Single

    ConvertPointLightCandelaToLumen(Single)

    Declaration
    public static float ConvertPointLightCandelaToLumen(float intensity)
    Parameters
    Type Name Description
    Single intensity
    Returns
    Type Description
    Single

    ConvertPointLightLumenToCandela(Single)

    Declaration
    public static float ConvertPointLightLumenToCandela(float intensity)
    Parameters
    Type Name Description
    Single intensity
    Returns
    Type Description
    Single

    ConvertPunctualLightCandelaToLumen(LightType, SpotLightShape, Single, Boolean, Single, Single)

    Declaration
    public static float ConvertPunctualLightCandelaToLumen(LightType lightType, SpotLightShape spotLigthShape, float candela, bool enableSpotReflector, float spotAngle, float aspectRatio)
    Parameters
    Type Name Description
    LightType lightType
    SpotLightShape spotLigthShape
    Single candela
    Boolean enableSpotReflector
    Single spotAngle
    Single aspectRatio
    Returns
    Type Description
    Single

    ConvertPunctualLightEvToLumen(LightType, SpotLightShape, Single, Boolean, Single, Single)

    Declaration
    public static float ConvertPunctualLightEvToLumen(LightType lightType, SpotLightShape spotLigthShape, float ev, bool enableSpotReflector, float spotAngle, float aspectRatio)
    Parameters
    Type Name Description
    LightType lightType
    SpotLightShape spotLigthShape
    Single ev
    Boolean enableSpotReflector
    Single spotAngle
    Single aspectRatio
    Returns
    Type Description
    Single

    ConvertPunctualLightLumenToCandela(LightType, Single, Single, Boolean)

    Declaration
    public static float ConvertPunctualLightLumenToCandela(LightType lightType, float lumen, float initialIntensity, bool enableSpotReflector)
    Parameters
    Type Name Description
    LightType lightType
    Single lumen
    Single initialIntensity
    Boolean enableSpotReflector
    Returns
    Type Description
    Single

    ConvertPunctualLightLumenToEv(LightType, Single, Single, Boolean)

    Declaration
    public static float ConvertPunctualLightLumenToEv(LightType lightType, float lumen, float initialIntensity, bool enableSpotReflector)
    Parameters
    Type Name Description
    LightType lightType
    Single lumen
    Single initialIntensity
    Boolean enableSpotReflector
    Returns
    Type Description
    Single

    ConvertPunctualLightLumenToLux(LightType, Single, Single, Boolean, Single)

    Declaration
    public static float ConvertPunctualLightLumenToLux(LightType lightType, float lumen, float initialIntensity, bool enableSpotReflector, float distance)
    Parameters
    Type Name Description
    LightType lightType
    Single lumen
    Single initialIntensity
    Boolean enableSpotReflector
    Single distance
    Returns
    Type Description
    Single

    ConvertPunctualLightLuxToLumen(LightType, SpotLightShape, Single, Boolean, Single, Single, Single)

    Declaration
    public static float ConvertPunctualLightLuxToLumen(LightType lightType, SpotLightShape spotLigthShape, float lux, bool enableSpotReflector, float spotAngle, float aspectRatio, float distance)
    Parameters
    Type Name Description
    LightType lightType
    SpotLightShape spotLigthShape
    Single lux
    Boolean enableSpotReflector
    Single spotAngle
    Single aspectRatio
    Single distance
    Returns
    Type Description
    Single

    ConvertRectLightLumenToLuminance(Single, Single, Single)

    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)

    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)

    Declaration
    public static float ConvertSphereLightLumenToLuminance(float intensity, float sphereRadius)
    Parameters
    Type Name Description
    Single intensity
    Single sphereRadius
    Returns
    Type Description
    Single

    ConvertSphereLightLuminanceToLumen(Single, Single)

    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)

    Declaration
    public static float ConvertSpotLightCandelaToLumen(float intensity, float angle, bool exact)
    Parameters
    Type Name Description
    Single intensity
    Single angle
    Boolean exact
    Returns
    Type Description
    Single

    ConvertSpotLightLumenToCandela(Single, Single, Boolean)

    Declaration
    public static float ConvertSpotLightLumenToCandela(float intensity, float angle, bool exact)
    Parameters
    Type Name Description
    Single intensity
    Single angle
    Boolean exact
    Returns
    Type Description
    Single
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023