docs.unity3d.com
    Show / Hide Table of Contents

    Method RunByRef

    RunByRef<T>(ref T, EntityQuery)

    Runs the job immediately on the current thread.

    Declaration
    public static void RunByRef<T>(this ref T jobData, EntityQuery query)
        where T : struct, IJobEntityBatchWithIndex
    Parameters
    Type Name Description
    T jobData

    An IJobEntityBatchWithIndex instance. In this variant, the jobData is passed by reference, which may be necessary for unusually large job structs.

    EntityQuery query

    The query selecting chunks with the necessary components.

    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 on the current thread.

    RunByRef<T>(ref T, EntityQuery, NativeArray<Entity>)

    Runs the job immediately on the current thread.

    Declaration
    public static void RunByRef<T>(this ref T jobData, EntityQuery query, NativeArray<Entity> limitToEntityArray)
        where T : struct, IJobEntityBatchWithIndex
    Parameters
    Type Name Description
    T jobData

    An IJobEntityBatchWithIndex instance. In this variant, the jobData is passed by reference, which may be necessary for unusually large job structs.

    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.

    Type Parameters
    Name Description
    T

    The specific IJobEntityBatchWithIndex implementation type.

    Remarks

    This scheduling variant processes each batch found in the input array. All batches are processed sequentially on the current thread.

    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