Manual-Burst.md

Burst

Filters in ME.ECS can be used with burst compiler. There are two variants to use burst to iterate filter.

Use Filter Bag (Recommended)

This method can be used with job system:

public Filter filter; // for example we use filter define somewhere

void AdvanceTick(in float deltaTime) {
  
    // Here we define new filter bag with 2 components (up to 9 components)
    var bag = new FilterBag<Component1, Component2>(this.filter, Allocator.TempJob);
    
    // Schedule the job with your bag
    var job = new Job();
    job.Schedule(bag).Complete();
    
    // Push changes to world
    // Or you can discard changes by calling Revert method
    bag.Push();
  
}

[BurstCompile(FloatPrecision.High, FloatMode.Deterministic, CompileSynchronously = true, Debug = false)]
public struct Job : IJobParallelForFilterBag<FilterBag<Component1, Component2>> {

    public void Execute(in FilterBag<Component1, Component2> bag, int index) {
      
        // Read first component in bag and change its value
        ref var component1 = ref bag.GetT0(index);
        component1.data = ...;
        
        // Here you can read, change or remove components defined in bag
        
    }
  
}

Use ForEach

This method has several restrictions:

• Components can't be removed
• ForEach couldn't been run in parallel mode

this.filter.ForEach((in Entity entity, in Component1 component1, ref Component2 component2) => {
    
    
    
}).WithBurst();