docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Struct WaterSimulationSearchJob

    C# Job that evaluate the height for a set of WaterSearchParameters and returns a set of WaterSearchResult (and stored them into native buffers).

    Implements
    IJobParallelFor
    Inherited Members
    ValueType.Equals(object)
    ValueType.GetHashCode()
    ValueType.ToString()
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: UnityEngine.Rendering.HighDefinition
    Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
    Syntax
    [BurstCompile]
    public struct WaterSimulationSearchJob : IJobParallelFor

    Fields

    candidateLocationBuffer

    Output native array that holds the set of positions that were used to generate the height value.

    Declaration
    [WriteOnly]
    [NativeDisableParallelForRestriction]
    public NativeArray<float3> candidateLocationBuffer
    Field Value
    Type Description
    NativeArray<float3>

    error

    Target error value at which the algorithm should stop.

    Declaration
    public float error
    Field Value
    Type Description
    float

    errorBuffer

    Output native array that holds the set of horizontal error for each target position.

    Declaration
    [WriteOnly]
    [NativeDisableParallelForRestriction]
    public NativeArray<float> errorBuffer
    Field Value
    Type Description
    NativeArray<float>

    heightBuffer

    Output native array that holds the set of heights that were evaluated for each target position.

    Declaration
    [WriteOnly]
    [NativeDisableParallelForRestriction]
    public NativeArray<float> heightBuffer
    Field Value
    Type Description
    NativeArray<float>

    maxIterations

    Number of iterations of the search algorithm.

    Declaration
    public int maxIterations
    Field Value
    Type Description
    int

    simSearchData

    Input simulation search data produced by the water surface.

    Declaration
    public WaterSimSearchData simSearchData
    Field Value
    Type Description
    WaterSimSearchData

    startPositionBuffer

    Native array that holds the set of "hint" position that the algorithm starts from.

    Declaration
    [ReadOnly]
    [NativeDisableParallelForRestriction]
    public NativeArray<float3> startPositionBuffer
    Field Value
    Type Description
    NativeArray<float3>

    stepCountBuffer

    Output native array that holds the set of steps that were executed to find the height.

    Declaration
    [WriteOnly]
    [NativeDisableParallelForRestriction]
    public NativeArray<int> stepCountBuffer
    Field Value
    Type Description
    NativeArray<int>

    targetPositionBuffer

    Native array that holds the set of position that the job will need to evaluate the height for.

    Declaration
    [ReadOnly]
    [NativeDisableParallelForRestriction]
    public NativeArray<float3> targetPositionBuffer
    Field Value
    Type Description
    NativeArray<float3>

    Methods

    Execute(int)

    Function that evaluates the height for a given element in the input buffer.

    Declaration
    public void Execute(int index)
    Parameters
    Type Name Description
    int index

    The index of the element that the function will process.

    Implements

    IJobParallelFor
    In This Article
    Back to top
    Copyright © 2025 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)