Struct bevy_ecs::query::QueryParIter

pub struct QueryParIter<'w, 's, Q: WorldQuery, F: ReadOnlyWorldQuery> { /* private fields */ }

A parallel iterator over query results of a Query.

This struct is created by the Query::par_iter and Query::par_iter_mut methods.

Implementations

impl<'w, 's, Q: ReadOnlyWorldQuery, F: ReadOnlyWorldQuery> QueryParIter<'w, 's, Q, F>

pub fn for_each<FN: Fn(ROQueryItem<'w, Q>) + Send + Sync + Clone>( &self, func: FN )

Runs func on each query result in parallel.

This can only be called for read-only queries, see Self::for_each_mut for write-queries.

Panics

The ComputeTaskPool is not initialized. If using this from a query that is being initialized and run from the ECS scheduler, this should never panic.

impl<'w, 's, Q: WorldQuery, F: ReadOnlyWorldQuery> QueryParIter<'w, 's, Q, F>

pub fn batching_strategy(self, strategy: BatchingStrategy) -> Self

Changes the batching strategy used when iterating.

For more information on how this affects the resultant iteration, see BatchingStrategy.

pub fn for_each_mut<FN: Fn(QueryItem<'w, Q>) + Send + Sync + Clone>( &mut self, func: FN )

Runs func on each query result in parallel.

Panics

The ComputeTaskPool is not initialized. If using this from a query that is being initialized and run from the ECS scheduler, this should never panic.

pub unsafe fn for_each_unchecked<FN: Fn(QueryItem<'w, Q>) + Send + Sync + Clone>( &self, func: FN )

Runs func on each query result in parallel.

Panics

The ComputeTaskPool is not initialized. If using this from a query that is being initialized and run from the ECS scheduler, this should never panic.

Safety

This does not check for mutable query correctness. To be safe, make sure mutable queries have unique access to the components they query.