docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Method Schedule

    Schedule<T>(T, JobHandle)

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

    Declaration
    [MustUseReturnValue]
    public static JobHandle Schedule<T>(this T jobData, JobHandle dependsOn) where T : unmanaged, IJobEntity
    Parameters
    Type Name Description
    T jobData

    An IJobEntity instance.

    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 IJobEntity implementation type.

    Remarks

    Can't schedule managed components or managed shared components, use Run instead.

    Schedule<T>(T, EntityQuery, JobHandle)

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

    Declaration
    [MustUseReturnValue]
    public static JobHandle Schedule<T>(this T jobData, EntityQuery query, JobHandle dependsOn) where T : unmanaged, IJobEntity
    Parameters
    Type Name Description
    T jobData

    An IJobEntity 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 IJobEntity implementation type.

    Remarks

    Can't schedule managed components or managed shared components, use Run instead.

    Schedule<T>(T)

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

    Declaration
    public static void Schedule<T>(this T jobData) where T : unmanaged, IJobEntity
    Parameters
    Type Name Description
    T jobData

    An IJobEntity instance.

    Type Parameters
    Name Description
    T

    The specific IJobEntity implementation type.

    Remarks

    This job automatically uses the system's Dependency property as the input and output dependency.

    Schedule<T>(T, EntityQuery)

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

    Declaration
    public static void Schedule<T>(this T jobData, EntityQuery query) where T : unmanaged, IJobEntity
    Parameters
    Type Name Description
    T jobData

    An IJobEntity instance.

    EntityQuery query

    The query selecting chunks with the necessary components.

    Type Parameters
    Name Description
    T

    The specific IJobEntity implementation type.

    Remarks

    This job automatically uses the system's Dependency property as the input and output dependency.

    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)