Struct ComputeTaskPool

pub struct ComputeTaskPool(/* private fields */);

A newtype for a task pool for CPU-intensive work that must be completed to deliver the next frame

See TaskPool documentation for details on Bevy tasks. AsyncComputeTaskPool should be preferred if the work does not have to be completed before the next frame.

Implementations

impl ComputeTaskPool

pub fn get_or_init(f: impl FnOnce() -> TaskPool) -> &'static Self

Gets the global ComputeTaskPool instance, or initializes it with f.

pub fn try_get() -> Option<&'static Self>

Attempts to get the global ComputeTaskPool instance, or returns None if it is not initialized.

pub fn get() -> &'static Self

Gets the global ComputeTaskPool instance.

Panics

Panics if the global instance has not been initialized yet.

Methods from Deref<Target = TaskPool>

pub fn thread_num(&self) -> usize

Available on WebAssembly or non-crate feature multi_threaded only.

Return the number of threads owned by the task pool

pub fn scope<'env, F, T>(&self, f: F) -> Vec<T>

where F: for<'scope> FnOnce(&'env mut Scope<'scope, 'env, T>), T: Send + 'static,

Available on WebAssembly or non-crate feature multi_threaded only.

Allows spawning non-'static futures on the thread pool. The function takes a callback, passing a scope object into it. The scope object provided to the callback can be used to spawn tasks. This function will await the completion of all tasks before returning.

This is similar to rayon::scope and crossbeam::scope

pub fn scope_with_executor<'env, F, T>( &self, _tick_task_pool_executor: bool, _thread_executor: Option<&ThreadExecutor<'_>>, f: F, ) -> Vec<T>

where F: for<'scope> FnOnce(&'env mut Scope<'scope, 'env, T>), T: Send + 'static,

Available on WebAssembly or non-crate feature multi_threaded only.

Allows spawning non-'static futures on the thread pool. The function takes a callback, passing a scope object into it. The scope object provided to the callback can be used to spawn tasks. This function will await the completion of all tasks before returning.

This is similar to rayon::scope and crossbeam::scope

pub fn spawn<T>(&self, future: impl Future<Output = T> + 'static) -> Task<T>

where T: 'static,

Available on WebAssembly or non-crate feature multi_threaded only.

Spawns a static future onto the thread pool. The returned Task is a future, which can be polled to retrieve the output of the original future. Dropping the task will attempt to cancel it. It can also be “detached”, allowing it to continue running without having to be polled by the end-user.

If the provided future is non-Send, TaskPool::spawn_local should be used instead.

pub fn spawn_local<T>( &self, future: impl Future<Output = T> + 'static, ) -> Task<T>

where T: 'static,

Available on WebAssembly or non-crate feature multi_threaded only.

Spawns a static future on the JS event loop. This is exactly the same as TaskPool::spawn.

pub fn with_local_executor<F, R>(&self, f: F) -> R

where F: FnOnce(&LocalExecutor<'_>) -> R,

Available on WebAssembly or non-crate feature multi_threaded only.

Runs a function with the local executor. Typically used to tick the local executor on the main thread as it needs to share time with other things.

use bevy_tasks::TaskPool;

TaskPool::new().with_local_executor(|local_executor| {
    local_executor.try_tick();
});

Trait Implementations

impl Debug for ComputeTaskPool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for ComputeTaskPool

type Target = TaskPool

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.