docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Interface IJobFilter

    Filters a list of indices.

    Namespace: Unity.Jobs
    Assembly: Unity.Collections.dll
    Syntax
    [JobProducerType(typeof(IJobFilterExtensions.JobFilterProducer<>))]
    public interface IJobFilter
    Remarks

    IJobFilter allows for custom jobs to implement a bool Execute(int index) job function used to filter a list of indices. For a provided list and index range, the list will be modified to append all indices for which Execute returns true or to exclude all indices for which Execute returns false depending on if ScheduleAppend or Schedule is used, respectfully, for enqueuing the job with the job system.

    Methods

    Execute(int)

    Filter function. A list of indices is provided when scheduling this job type. The Execute function will be called once for each index returning true or false if the job data at the passed in index should be filtered or not.

    Declaration
    bool Execute(int index)
    Parameters
    Type Name Description
    int index

    Index to use when reading job data for the purpose of filtering

    Returns
    Type Description
    bool

    Returns true for data at index

    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)