Struct flax::schedule::Schedule

pub struct Schedule { /* private fields */ }

A schedule of systems to execute with automatic parallelization.

Implementations

impl Schedule

pub fn new() -> Self

Creates a new empty schedule, prefer Self::builder

pub fn builder() -> ScheduleBuilder

Creates a new schedule builder

pub fn execute_seq(&mut self, world: &mut World) -> Result<()>

Execute all systems in the schedule sequentially on the world. Returns the first error and aborts if the execution fails.

pub fn execute_par(&mut self, world: &mut World) -> Result<()>

Available on crate feature rayon only.

Executes the systems in the schedule in parallel.

Systems will run in an order such that changes and mutable accesses made by systems provided before are observable when the system runs.

Systems with no dependencies between each other may run in any order, but will not run before any previously provided system which it depends on.

A dependency between two systems is given by a side effect, e.g; a component write, which is accessed by the seconds system through a read or other side effect.

pub fn from_systems(systems: impl Into<Vec<BoxedSystem>>) -> Self

Creates a schedule from a group of existing systems

pub fn append(&mut self, other: Self)

Append one schedule onto another

pub fn with_system(self, system: impl Into<BoxedSystem>) -> Self

Add a new system to the schedule. Respects order.

pub fn flush(self) -> Self

Applies the commands inside of the commandbuffer

pub fn batch_info(&mut self, world: &World) -> BatchInfos

Returns information about the current multithreaded batch partioning and system accesses.

pub fn execute_seq_with<'a>( &'a mut self, world: &'a mut World, input: impl IntoInput<'a> ) -> Result<()>

Same as Self::execute_seq but allows supplying short lived input available to the systems

The data can be a mutable reference type, or a tuple of mutable references

pub fn execute_par_with<'a>( &'a mut self, world: &'a mut World, input: impl IntoInput<'a> ) -> Result<()>

Available on crate feature rayon only.

Same as Self::execute_par but allows supplying short lived data available to the systems

Trait Implementations

impl Debug for Schedule

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

Formats the value using the given formatter.

impl Default for Schedule

fn default() -> Schedule

Returns the “default value” for a type.

impl<U> From<U> for Schedule

where U: IntoIterator<Item = BoxedSystem>,

fn from(v: U) -> Self

Converts to this type from the input type.

impl FromIterator<BoxedSystem> for Schedule

fn from_iter<I: IntoIterator<Item = BoxedSystem>>(iter: I) -> Self

Creates a value from an iterator.