docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class AdaptiveProbeVolumes.LightingBaker

    Lighting baker

    Inheritance
    object
    AdaptiveProbeVolumes.LightingBaker
    Implements
    IDisposable
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEngine.Rendering
    Assembly: Unity.RenderPipelines.Core.Editor.dll
    Syntax
    public abstract class AdaptiveProbeVolumes.LightingBaker : IDisposable

    Properties

    cancel

    Set to true when the main thread cancels baking.

    Declaration
    public static bool cancel { get; }
    Property Value
    Type Description
    bool

    currentStep

    The current baking step.

    Declaration
    public abstract ulong currentStep { get; }
    Property Value
    Type Description
    ulong

    irradiance

    Array storing the probe lighting as Spherical Harmonics.

    Declaration
    public abstract NativeArray<SphericalHarmonicsL2> irradiance { get; }
    Property Value
    Type Description
    NativeArray<SphericalHarmonicsL2>

    isThreadSafe

    Indicates that the Step method can be safely called from a thread.

    Declaration
    public virtual bool isThreadSafe { get; }
    Property Value
    Type Description
    bool

    stepCount

    The total amount of step.

    Declaration
    public abstract ulong stepCount { get; }
    Property Value
    Type Description
    ulong

    validity

    Array storing the probe validity. A value of 1 means a probe is invalid.

    Declaration
    public abstract NativeArray<float> validity { get; }
    Property Value
    Type Description
    NativeArray<float>

    Methods

    Dispose()

    Performs necessary tasks to free allocated resources.

    Declaration
    public abstract void Dispose()

    Initialize(NativeArray<Vector3>)

    This is called before the start of baking to allow allocating necessary resources.

    Declaration
    public abstract void Initialize(NativeArray<Vector3> probePositions)
    Parameters
    Type Name Description
    NativeArray<Vector3> probePositions

    The probe positions. Also contains reflection probe positions used for normalization.

    Step()

    Run a step of light baking. Baking is considered done when currentStep property equals stepCount. If isThreadSafe is true, this method may be called from a different thread.

    Declaration
    public abstract bool Step()
    Returns
    Type Description
    bool

    Return false if bake failed and should be stopped.

    Implements

    IDisposable

    Extension Methods

    ReflectionUtils.GetField(object, string)
    ReflectionUtils.GetFields(object)
    ReflectionUtils.Invoke(object, string, params object[])
    ReflectionUtils.SetField(object, string, object)
    AnalyticsUtils.ToNestedColumnWithDefault<T>(T, T, bool)
    AnalyticsUtils.ToNestedColumn<T>(T, T)
    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)