Struct bevy::tasks::ComputeTaskPool

pub struct ComputeTaskPool(pub TaskPool);

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

Tuple Fields

0: TaskPool

Methods from Deref<Target = TaskPool>

pub fn thread_num(&self) -> usize

Return the number of threads owned by the task pool

pub fn scope<'scope, F, T>(&self, f: F) -> Vec<T, Global> where
    F: 'scope + FnOnce(&mut Scope<'scope, T>) + Send,
    T: 'static + Send, 

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> + Send + 'static
) -> Task<T> where
    T: 'static + Send, 

Spawns a static future onto the thread pool. The returned Task is a future. It can also be cancelled and “detached” allowing it to continue running without having to be polled by the end-user.

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

Trait Implementations

impl Clone for ComputeTaskPool

pub fn clone(&self) -> ComputeTaskPool

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ComputeTaskPool

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

Formats the value using the given formatter.

impl Deref for ComputeTaskPool

type Target = TaskPool

The resulting type after dereferencing.

pub fn deref(&self) -> &<ComputeTaskPool as Deref>::Target

Dereferences the value.