docs.unity.cn
    Show / Hide Table of Contents

    Method Schedule

    Schedule<T>(T, EntityQuery, JobHandle)

    Adds an IJobEntityBatchWithIndex instance to the job scheduler queue for sequential (non-parallel) execution.

    Declaration
    public static JobHandle Schedule<T>(this T jobData, EntityQuery query, JobHandle dependsOn = default(JobHandle))
        where T : struct, IJobEntityBatchWithIndex
    Parameters
    Type Name Description
    T jobData

    An IJobEntityBatchWithIndex instance.

    EntityQuery query

    The query selecting chunks with the necessary components.

    JobHandle dependsOn

    The handle identifying already scheduled jobs that could constrain this job. A job that writes to a component cannot run in parallel with other jobs that read or write that component. Jobs that only read the same components can run in parallel.

    Returns
    Type Description
    JobHandle

    A handle that combines the current Job with previous dependencies identified by the dependsOn parameter.

    Type Parameters
    Name Description
    T

    The specific IJobEntityBatchWithIndex implementation type.

    Remarks

    This scheduling variant processes each matching chunk as a single batch. All chunks execute sequentially.

    Schedule<T>(T, EntityQuery, NativeArray<Entity>, JobHandle)

    Adds an IJobEntityBatchWithIndex instance to the job scheduler queue for sequential (non-parallel) execution.

    Declaration
    public static JobHandle Schedule<T>(this T jobData, EntityQuery query, NativeArray<Entity> limitToEntityArray, JobHandle dependsOn = default(JobHandle))
        where T : struct, IJobEntityBatchWithIndex
    Parameters
    Type Name Description
    T jobData

    An IJobEntityBatchWithIndex instance.

    EntityQuery query

    The query selecting chunks with the necessary components.

    NativeArray<Entity> limitToEntityArray

    A list of entities to limit execution to. Only entities in the list will be processed.

    JobHandle dependsOn

    The handle identifying already scheduled jobs that could constrain this job. A job that writes to a component cannot run in parallel with other jobs that read or write that component. Jobs that only read the same components can run in parallel.

    Returns
    Type Description
    JobHandle

    A handle that combines the current Job with previous dependencies identified by the dependsOn parameter.

    Type Parameters
    Name Description
    T

    The specific IJobEntityBatchWithIndex implementation type.

    Remarks

    This scheduling variant processes each batch found in the entity array. All batches are processed sequentially.

    Back to top Copyright © 2022 Unity Technologies
    Generated by DocFX
    on 04 August 2022
    Terms of use