docs.unity3d.com
    Show / Hide Table of Contents

    Struct ProbeSettings.Lighting

    Lighting parameters for the probe.

    Namespace: UnityEngine.Rendering.HighDefinition
    Syntax
    [Serializable]
    public struct Lighting

    Fields

    default

    Default value.

    Declaration
    [Obsolete("Since 2019.3, use Lighting.NewDefault() instead.")]
    public static readonly ProbeSettings.Lighting default
    Field Value
    Type Description
    ProbeSettings.Lighting

    fadeDistance

    The distance at which reflections smoothly fade out before HDRP cut them completely.

    Declaration
    public float fadeDistance
    Field Value
    Type Description
    Single

    lightLayer

    An enum flag to select which Light Layers this Probe interacts with.

    Declaration
    public LightLayerEnum lightLayer
    Field Value
    Type Description
    LightLayerEnum

    multiplier

    A multiplier applied to the radiance of the Probe.

    Declaration
    public float multiplier
    Field Value
    Type Description
    Single

    rangeCompressionFactor

    The result of the rendering of the probe will be divided by this factor. When the probe is read, this factor is undone as the probe data is read. This is to simply avoid issues with values clamping due to precision of the storing format.

    Declaration
    [Min(1E-06F)]
    public float rangeCompressionFactor
    Field Value
    Type Description
    Single

    weight

    A weight applied to the influence of the Probe.

    Declaration
    [Range(0F, 1F)]
    public float weight
    Field Value
    Type Description
    Single

    Methods

    NewDefault()

    Default value.

    Declaration
    public static ProbeSettings.Lighting NewDefault()
    Returns
    Type Description
    ProbeSettings.Lighting

    The default value.

    Back to top
    Terms of use
    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